Package org.eclipse.nebula.widgets.nattable.columnChooser

Class ColumnChooser

java.lang.Object

org.eclipse.nebula.widgets.nattable.columnChooser.ColumnChooser

public class ColumnChooser
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ColumnChooserDialog	columnChooserDialog
protected ColumnGroupModel	columnGroupModel
protected DataLayer	columnHeaderDataLayer
protected ColumnHeaderLayer	columnHeaderLayer
protected ColumnHideShowLayer	columnHideShowLayer
protected List<ColumnEntry>	hiddenColumnEntries
protected boolean	preventHidingAllColumns
protected SelectionLayer	selectionLayer
protected boolean	sortAvailableColumns
protected List<ColumnEntry>	visibleColumnsEntries

Constructor Summary

Constructors

Constructor	Description
ColumnChooser(org.eclipse.swt.widgets.Shell shell, ColumnHideShowLayer columnHideShowLayer, ColumnHeaderLayer columnHeaderLayer, DataLayer columnHeaderDataLayer, ColumnGroupHeaderLayer columnGroupHeaderLayer, boolean sortAvailableColumns)	Constructor to be used with the new performance column grouping feature.
ColumnChooser(org.eclipse.swt.widgets.Shell shell, SelectionLayer selectionLayer, ColumnHideShowLayer columnHideShowLayer, ColumnHeaderLayer columnHeaderLayer, DataLayer columnHeaderDataLayer, ColumnGroupHeaderLayer columnGroupHeaderLayer, ColumnGroupModel columnGroupModel, boolean sortAvailableColumns)	Constructor to be used with the old column grouping feature.
ColumnChooser(org.eclipse.swt.widgets.Shell shell, SelectionLayer selectionLayer, ColumnHideShowLayer columnHideShowLayer, ColumnHeaderLayer columnHeaderLayer, DataLayer columnHeaderDataLayer, ColumnGroupHeaderLayer columnGroupHeaderLayer, ColumnGroupModel columnGroupModel, boolean sortAvailableColumns, boolean preventHidingAllColumns)	Constructor to be used with the old column grouping feature.

Method Summary

Modifier and Type	Method	Description
void	addNonModifiableColumn(Integer... columnIndexes)
protected List<ColumnEntry>	getHiddenColumnEntries()
void	openDialog()
void	removeNonModifiableColumn(Integer... columnIndexes)
void	setDialogSettings(org.eclipse.jface.dialogs.IDialogSettings dialogSettings)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

columnChooserDialog

protected final ColumnChooserDialog columnChooserDialog

columnHideShowLayer

protected final ColumnHideShowLayer columnHideShowLayer

columnHeaderDataLayer

protected final DataLayer columnHeaderDataLayer

columnHeaderLayer

protected final ColumnHeaderLayer columnHeaderLayer

hiddenColumnEntries

protected List<ColumnEntry> hiddenColumnEntries

visibleColumnsEntries

protected List<ColumnEntry> visibleColumnsEntries

columnGroupModel

protected final ColumnGroupModel columnGroupModel

selectionLayer

protected final SelectionLayer selectionLayer

sortAvailableColumns

protected final boolean sortAvailableColumns

preventHidingAllColumns

protected final boolean preventHidingAllColumns

Constructor Detail

ColumnChooser

public ColumnChooser(org.eclipse.swt.widgets.Shell shell,
                     SelectionLayer selectionLayer,
                     ColumnHideShowLayer columnHideShowLayer,
                     ColumnHeaderLayer columnHeaderLayer,
                     DataLayer columnHeaderDataLayer,
                     ColumnGroupHeaderLayer columnGroupHeaderLayer,
                     ColumnGroupModel columnGroupModel,
                     boolean sortAvailableColumns)

Constructor to be used with the old column grouping feature.

Parameters:

shell - The parent shell to be used for creating the ColumnChooserDialog.

selectionLayer - The SelectionLayer needed for position-index-transformation and to execute commands.

columnHideShowLayer - The ColumnHideShowLayer for hide/show support.

columnHeaderLayer - The ColumnHeaderLayer for retrieving column header information.

columnHeaderDataLayer - The DataLayer of the column header region for retrieving column header information.

columnGroupHeaderLayer - The old ColumnGroupHeaderLayer, currently unused.

columnGroupModel - The old ColumnGroupModel used to support column grouping with the old column grouping feature, can be null if column grouping is not supported.

sortAvailableColumns - Flag to configure if entries in the available tree should be displayed in sorted order.

ColumnChooser

public ColumnChooser(org.eclipse.swt.widgets.Shell shell,
                     SelectionLayer selectionLayer,
                     ColumnHideShowLayer columnHideShowLayer,
                     ColumnHeaderLayer columnHeaderLayer,
                     DataLayer columnHeaderDataLayer,
                     ColumnGroupHeaderLayer columnGroupHeaderLayer,
                     ColumnGroupModel columnGroupModel,
                     boolean sortAvailableColumns,
                     boolean preventHidingAllColumns)

Constructor to be used with the old column grouping feature.

Parameters:

shell - The parent shell to be used for creating the ColumnChooserDialog.

selectionLayer - The SelectionLayer needed for position-index-transformation and to execute commands.

columnHideShowLayer - The ColumnHideShowLayer for hide/show support.

columnHeaderLayer - The ColumnHeaderLayer for retrieving column header information.

columnHeaderDataLayer - The DataLayer of the column header region for retrieving column header information.

columnGroupHeaderLayer - The old ColumnGroupHeaderLayer, currently unused.

columnGroupModel - The old ColumnGroupModel used to support column grouping with the old column grouping feature, can be null if column grouping is not supported.

sortAvailableColumns - Flag to configure if entries in the available tree should be displayed in sorted order.

preventHidingAllColumns - Flag to prevent hiding all columns, currently without function.

ColumnChooser

public ColumnChooser(org.eclipse.swt.widgets.Shell shell,
                     ColumnHideShowLayer columnHideShowLayer,
                     ColumnHeaderLayer columnHeaderLayer,
                     DataLayer columnHeaderDataLayer,
                     ColumnGroupHeaderLayer columnGroupHeaderLayer,
                     boolean sortAvailableColumns)

Constructor to be used with the new performance column grouping feature.

Parameters:

shell - The parent shell to be used for creating the ColumnChooserDialog.

columnHideShowLayer - The ColumnHideShowLayer for hide/show support.

columnHeaderLayer - The ColumnHeaderLayer for retrieving column header information.

columnHeaderDataLayer - The DataLayer of the column header region for retrieving column header information.

columnGroupHeaderLayer - The new performance ColumnGroupHeaderLayer to support column grouping. null is not allowed.

sortAvailableColumns - Flag to configure if entries in the available tree should be displayed in sorted order.

Throws:

IllegalArgumentException - if columnGroupHeaderLayer is null

Since:

1.6

Method Detail

setDialogSettings

public void setDialogSettings(org.eclipse.jface.dialogs.IDialogSettings dialogSettings)

openDialog

public void openDialog()

getHiddenColumnEntries

protected List<ColumnEntry> getHiddenColumnEntries()

addNonModifiableColumn

public void addNonModifiableColumn(Integer... columnIndexes)

removeNonModifiableColumn

public void removeNonModifiableColumn(Integer... columnIndexes)