Package org.eclipse.nebula.widgets.nattable.extension.glazedlists.groupBy

Class GroupByHeaderLayer

java.lang.Object

org.eclipse.nebula.widgets.nattable.layer.AbstractLayer

org.eclipse.nebula.widgets.nattable.grid.layer.DimensionallyDependentLayer

org.eclipse.nebula.widgets.nattable.extension.glazedlists.groupBy.GroupByHeaderLayer

All Implemented Interfaces:

ILayer, ILayerListener, IPersistable

public class GroupByHeaderLayer
extends DimensionallyDependentLayer

The layer that is used to render the groupBy region where columns can be dragged from to perform grouping and ungrouping actions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GROUP_BY_REGION

Fields inherited from class org.eclipse.nebula.widgets.nattable.layer.AbstractLayer

commandHandlers, eventHandlers, eventHelperLock, layerPainter

Fields inherited from interface org.eclipse.nebula.widgets.nattable.persistence.IPersistable

DOT, VALUE_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
GroupByHeaderLayer(GroupByModel groupByModel, ILayer horizontalLayerDependency, IDataProvider columnHeaderDataProvider)	Create a GroupByHeaderLayer that uses the default GroupByHeaderConfiguration.
GroupByHeaderLayer(GroupByModel groupByModel, ILayer horizontalLayerDependency, IDataProvider columnHeaderDataProvider, GroupByHeaderConfiguration groupByHeaderConfiguration)	Create a GroupByHeaderLayer by either using the given GroupByHeaderConfiguration or creating a new GroupByHeaderConfiguration using the given column header IDataProvider.
GroupByHeaderLayer(GroupByModel groupByModel, ILayer horizontalLayerDependency, IDataProvider columnHeaderDataProvider, ColumnHeaderLayer columnHeaderLayer)	Create a GroupByHeaderLayer that uses the default GroupByHeaderConfiguration.
GroupByHeaderLayer(GroupByModel groupByModel, ILayer horizontalLayerDependency, IDataProvider columnHeaderDataProvider, ColumnHeaderLayer columnHeaderLayer, GroupByHeaderConfiguration groupByHeaderConfiguration)	Create a GroupByHeaderLayer by either using the given GroupByHeaderConfiguration or creating a new GroupByHeaderConfiguration using the given column header IDataProvider.
GroupByHeaderLayer(GroupByModel groupByModel, ILayer horizontalLayerDependency, GroupByHeaderConfiguration groupByHeaderConfiguration)	Create a GroupByHeaderLayer that uses the given GroupByHeaderConfiguration.

Method Summary

Modifier and Type	Method	Description
ILayerCell	getCellByPosition(int columnPosition, int rowPosition)	Returns the cell for the given coordinates on this layer.
int	getGroupByColumnIndexAtXY(int x, int y)
GroupByModel	getGroupByModel()
int	getHeight()	Returns the total height in pixels of this layer.
int	getRowHeightByPosition(int rowPosition)	Returns the height in pixels of the given row.
boolean	isVisible()
void	setVisible(boolean visible)

Methods inherited from class org.eclipse.nebula.widgets.nattable.grid.layer.DimensionallyDependentLayer

configure, doCommand, getBaseLayer, getClientAreaProvider, getColumnCount, getColumnIndexByPosition, getColumnPositionByX, getColumnWidthByPosition, getConfigLabelsByPosition, getDataValueByPosition, getDisplayModeByPosition, getHorizontalLayerDependency, getLayerPainter, getPreferredColumnCount, getPreferredHeight, getPreferredRowCount, getPreferredWidth, getRegionLabelsByXY, getRowCount, getRowIndexByPosition, getRowPositionByY, getStartXOfColumnPosition, getStartYOfRowPosition, getUnderlyingLayerByPosition, getUnderlyingLayersByColumnPosition, getUnderlyingLayersByRowPosition, getVerticalLayerDependency, getWidth, isColumnPositionResizable, isRowPositionResizable, loadState, localToUnderlyingColumnPosition, localToUnderlyingRowPosition, saveState, setClientAreaProvider, setHorizontalLayerDependency, setVerticalLayerDependency, underlyingToLocalColumnPosition, underlyingToLocalColumnPositions, underlyingToLocalRowPosition, underlyingToLocalRowPositions

Methods inherited from class org.eclipse.nebula.widgets.nattable.layer.AbstractLayer

addConfiguration, addLayerListener, clearConfiguration, dispose, fireLayerEvent, getBoundsByPosition, getCellPainter, getConfigLabelAccumulator, getProvidedLabels, getRegionName, handleLayerEvent, hasLayerListener, isDynamicSizeLayer, registerCommandHandler, registerCommandHandlers, registerEventHandler, registerPersistable, removeLayerListener, setConfigLabelAccumulator, setLayerPainter, setRegionName, toString, unregisterCommandHandler, unregisterEventHandler, unregisterPersistable

Methods inherited from class java.lang.Object

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

Field Details

GROUP_BY_REGION

public static final String GROUP_BY_REGION

See Also:

• Constant Field Values

Constructor Details

GroupByHeaderLayer

public GroupByHeaderLayer(GroupByModel groupByModel,
 ILayer horizontalLayerDependency,
 IDataProvider columnHeaderDataProvider)

Create a GroupByHeaderLayer that uses the default GroupByHeaderConfiguration.

Parameters:

groupByModel - The GroupByModel needed for grouping operations.

horizontalLayerDependency - The ILayer to which this header layer is horizontally dependent.

columnHeaderDataProvider - The IDataProvider of the column header which is needed to create the GroupByHeaderConfiguration

GroupByHeaderLayer

public GroupByHeaderLayer(GroupByModel groupByModel,
 ILayer horizontalLayerDependency,
 IDataProvider columnHeaderDataProvider,
 ColumnHeaderLayer columnHeaderLayer)

Create a GroupByHeaderLayer that uses the default GroupByHeaderConfiguration.

Parameters:

groupByModel - The GroupByModel needed for grouping operations.

horizontalLayerDependency - The ILayer to which this header layer is horizontally dependent.

columnHeaderDataProvider - The IDataProvider of the column header which is needed to create the GroupByHeaderConfiguration

columnHeaderLayer - The ColumnHeaderLayer which should be used to create the GroupByHeaderConfiguration if it should support showing the renamed column headers. Can be null which results in using either the given columnHeaderDataProvider or the given GroupByHeaderConfiguration.

Since:

1.5

GroupByHeaderLayer

public GroupByHeaderLayer(GroupByModel groupByModel,
 ILayer horizontalLayerDependency,
 GroupByHeaderConfiguration groupByHeaderConfiguration)

Create a GroupByHeaderLayer that uses the given GroupByHeaderConfiguration.

Parameters:

groupByModel - The GroupByModel needed for grouping operations.

horizontalLayerDependency - The ILayer to which this header layer is horizontally dependent.

groupByHeaderConfiguration - The GroupByHeaderConfiguration that should be added to this GroupByHeaderLayer. Needs to be a GroupByHeaderConfiguration because we retrieve the necessary GroupByHeaderPainter out of the configuration to setup this layer accordingly.

GroupByHeaderLayer

public GroupByHeaderLayer(GroupByModel groupByModel,
 ILayer horizontalLayerDependency,
 IDataProvider columnHeaderDataProvider,
 GroupByHeaderConfiguration groupByHeaderConfiguration)

Create a GroupByHeaderLayer by either using the given GroupByHeaderConfiguration or creating a new GroupByHeaderConfiguration using the given column header IDataProvider. Note that either the IDataProvider or the GroupByHeaderConfiguration parameter must be set. If both are null an IllegalArgumentException will be thrown.

Parameters:

groupByModel - The GroupByModel needed for grouping operations.

horizontalLayerDependency - The ILayer to which this header layer is horizontally dependent.

columnHeaderDataProvider - The IDataProvider of the column header which is needed to create the GroupByHeaderConfiguration. Can be null if groupByHeaderConfiguration is not null.

groupByHeaderConfiguration - The GroupByHeaderConfiguration that should be added to this GroupByHeaderLayer. Needs to be a GroupByHeaderConfiguration because we retrieve the necessary GroupByHeaderPainter out of the configuration to setup this layer accordingly. Can be null if columnHeaderDataProvider is not null.

GroupByHeaderLayer

public GroupByHeaderLayer(GroupByModel groupByModel,
 ILayer horizontalLayerDependency,
 IDataProvider columnHeaderDataProvider,
 ColumnHeaderLayer columnHeaderLayer,
 GroupByHeaderConfiguration groupByHeaderConfiguration)

Create a GroupByHeaderLayer by either using the given GroupByHeaderConfiguration or creating a new GroupByHeaderConfiguration using the given column header IDataProvider. Note that either the IDataProvider or the GroupByHeaderConfiguration parameter must be set. If both are null an IllegalArgumentException will be thrown.

Parameters:

groupByModel - The GroupByModel needed for grouping operations.

horizontalLayerDependency - The ILayer to which this header layer is horizontally dependent.

columnHeaderDataProvider - The IDataProvider of the column header which is needed to create the GroupByHeaderConfiguration. Can be null if groupByHeaderConfiguration is not null.

columnHeaderLayer - The ColumnHeaderLayer which should be used to create the GroupByHeaderConfiguration if it should support showing the renamed column headers. Can be null which results in using either the given columnHeaderDataProvider or the given GroupByHeaderConfiguration.

groupByHeaderConfiguration - The GroupByHeaderConfiguration that should be added to this GroupByHeaderLayer. Needs to be a GroupByHeaderConfiguration because we retrieve the necessary GroupByHeaderPainter out of the configuration to setup this layer accordingly. Can be null if columnHeaderDataProvider is not null.

Since:

1.5

Method Details

getGroupByModel

public GroupByModel getGroupByModel()

setVisible

public void setVisible(boolean visible)

isVisible

public boolean isVisible()

getHeight

public int getHeight()

Description copied from interface: ILayer

Returns the total height in pixels of this layer.

Specified by:

getHeight in interface ILayer

Overrides:

getHeight in class DimensionallyDependentLayer

Returns:

The total height in pixels of this layer.

getRowHeightByPosition

public int getRowHeightByPosition(int rowPosition)

Description copied from interface: ILayer

Returns the height in pixels of the given row. The height of invisible and non-existing rows is 0.

Specified by:

getRowHeightByPosition in interface ILayer

Overrides:

getRowHeightByPosition in class DimensionallyDependentLayer

Parameters:

rowPosition - The row position in this layer.

Returns:

The height of the row.

getCellByPosition

public ILayerCell getCellByPosition(int columnPosition,
 int rowPosition)

Description copied from interface: ILayer

Returns the cell for the given coordinates on this layer.

Specified by:

getCellByPosition in interface ILayer

Overrides:

getCellByPosition in class AbstractLayer

Parameters:

columnPosition - The column position of the requested cell.

rowPosition - The row position of the requested cell.

Returns:

The ILayerCell for the given coordinates in this layer or null if the coordinates are invalid on this layer.

getGroupByColumnIndexAtXY

public int getGroupByColumnIndexAtXY(int x,
 int y)