Package org.eclipse.nebula.widgets.nattable.filterrow

Class FilterRowHeaderComposite<T>

java.lang.Object

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

org.eclipse.nebula.widgets.nattable.layer.CompositeLayer

org.eclipse.nebula.widgets.nattable.filterrow.FilterRowHeaderComposite<T>

All Implemented Interfaces:

ILayer, ILayerListener, IPersistable

public class FilterRowHeaderComposite<T>
extends CompositeLayer

1 column x 2 rows Composite layer

• First row is the ColumnHeaderLayer
• Second row is the composite is the filter row layer. The filter row layer is a DimensionallyDependentLayer dependent on the ColumnHeaderLayer

See Also:

• FilterRowDataLayer

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.nebula.widgets.nattable.layer.CompositeLayer

CompositeLayer.CompositeLayerPainter

Field Summary

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
FilterRowHeaderComposite(IFilterStrategy<T> filterStrategy, ILayer columnHeaderLayer, IDataProvider columnHeaderDataProvider, IConfigRegistry configRegistry)	Creates a FilterRowHeaderComposite with a created FilterRowDataLayer.
FilterRowHeaderComposite(ILayer columnHeaderLayer, FilterRowDataLayer<T> filterRowDataLayer)	Creates a FilterRowHeaderComposite with the provided FilterRowDataLayer.

Method Summary

Modifier and Type	Method	Description
boolean	doCommand(ILayerCommand command)	Opportunity to respond to a command as it flows down the stack.
FilterRowDataLayer<T>	getFilterRowDataLayer()
int	getHeight()	Returns the total height in pixels of this layer.
int	getRowCount()
boolean	isFilterRowVisible()
void	setFilterRowVisible(boolean filterRowVisible)

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

addConfigLabelAccumulatorForRegion, configure, dispose, doCommandOnChildLayers, getBoundsByPosition, getCellByPosition, getCellPainter, getChildLayerByLayoutCoordinate, getChildLayerByRegionName, getChildLayerLayout, getColumnCount, getColumnIndexByPosition, getColumnPositionByX, getColumnPositionOffset, getColumnWidthByPosition, getConfigLabelAccumulatorByRegionName, getConfigLabelsByPosition, getDataValueByPosition, getDisplayModeByPosition, getHeightOffset, getLayoutXByColumnPosition, getLayoutXByPixelX, getLayoutXCount, getLayoutXYByChildLayer, getLayoutXYByPixelXY, getLayoutXYByPosition, getLayoutYByPixelY, getLayoutYByRowPosition, getLayoutYCount, getPreferredColumnCount, getPreferredHeight, getPreferredRowCount, getPreferredWidth, getProvidedLabels, getRegionLabelsByXY, getRowHeightByPosition, getRowIndexByPosition, getRowPositionByY, getRowPositionOffset, getStartXOfColumnPosition, getStartYOfRowPosition, getUnderlyingLayerByPosition, getUnderlyingLayersByColumnPosition, getUnderlyingLayersByRowPosition, getWidth, getWidthOffset, isColumnPositionResizable, isDynamicSizeLayer, isRowPositionResizable, loadState, localToUnderlyingColumnPosition, localToUnderlyingRowPosition, saveState, setChildLayer, setConfigLabelAccumulatorForRegion, underlyingToLocalColumnPosition, underlyingToLocalColumnPositions, underlyingToLocalRowPosition, underlyingToLocalRowPositions

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

addConfiguration, addLayerListener, clearConfiguration, fireLayerEvent, getClientAreaProvider, getConfigLabelAccumulator, getLayerPainter, getRegionName, handleLayerEvent, hasLayerListener, registerCommandHandler, registerCommandHandlers, registerEventHandler, registerPersistable, removeLayerListener, setClientAreaProvider, setConfigLabelAccumulator, setLayerPainter, setRegionName, toString, unregisterCommandHandler, unregisterEventHandler, unregisterPersistable

Methods inherited from class java.lang.Object

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

Constructor Details

FilterRowHeaderComposite

public FilterRowHeaderComposite(IFilterStrategy<T> filterStrategy,
 ILayer columnHeaderLayer,
 IDataProvider columnHeaderDataProvider,
 IConfigRegistry configRegistry)

Creates a FilterRowHeaderComposite with a created FilterRowDataLayer.

Parameters:

filterStrategy - The IFilterStrategy to which the set filter value should be applied. Used to create a FilterRowDataLayer.

columnHeaderLayer - The ILayer to which the FilterRowDataLayer is dependent. Will be placed in the first row of this CompositeLayer. Typically the ColumnHeaderLayer.

columnHeaderDataProvider - The IDataProvider of the column header needed to retrieve the real column count of the column header and not a transformed one. Used to create a FilterRowDataLayer.

configRegistry - The IConfigRegistry needed to retrieve the IDisplayConverter for converting the values on state save/load operations. Used to create a FilterRowDataLayer.

FilterRowHeaderComposite

public FilterRowHeaderComposite(ILayer columnHeaderLayer,
 FilterRowDataLayer<T> filterRowDataLayer)

Creates a FilterRowHeaderComposite with the provided FilterRowDataLayer. Allows to use a FilterRowDataLayer with a custom configuration.

Parameters:

columnHeaderLayer - The ILayer to which the FilterRowDataLayer is dependent. Will be placed in the first row of this CompositeLayer. Typically the ColumnHeaderLayer.

filterRowDataLayer - The FilterRowDataLayer which is used for backing the filter data and is rendered in the second row of this CompositeLayer.

Since:

2.3

Method Details

getFilterRowDataLayer

public FilterRowDataLayer<T> getFilterRowDataLayer()

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 CompositeLayer

Returns:

The total height in pixels of this layer.

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface ILayer

Overrides:

getRowCount in class CompositeLayer

Returns:

The number of rows in this layer.

isFilterRowVisible

public boolean isFilterRowVisible()

setFilterRowVisible

public void setFilterRowVisible(boolean filterRowVisible)

doCommand

public boolean doCommand(ILayerCommand command)

Description copied from class: CompositeLayer

Opportunity to respond to a command as it flows down the stack. If the layer is not interested in the command it should allow the command to keep traveling down the stack.

Note: Before the layer can process a command it must convert the command to its local coordinates using ILayerCommand.convertToTargetLayer(ILayer) Handle commands

Specified by:

doCommand in interface ILayer

Overrides:

doCommand in class CompositeLayer

Parameters:

command - The command to execute.

Returns:

true if the command has been handled and was therefore consumed, false otherwise.