org.eclipse.nebula.widgets.nattable.filterrow

Class FilterRowDataLayer<T>

java.lang.Object

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

org.eclipse.nebula.widgets.nattable.layer.DataLayer

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

Type Parameters:

T - type of the underlying row object

All Implemented Interfaces:

ILayer, ILayerListener, IUniqueIndexLayer, IPersistable

public class FilterRowDataLayer<T>
extends DataLayer

DataLayer with a custom IDataProvider which stores/tracks the filter text on columns. Applies region name of GridRegion.FILTER_ROW to the filter row. Persists the filter text to the properties file.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILTER_ROW_COLUMN_LABEL_PREFIX Prefix of the column label applied to each column in the filter row
static String	PERSISTENCE_KEY_FILTER_ROW_TOKENS Prefix for the persistence key in the properties file

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

dataProvider, DEFAULT_COLUMN_WIDTH, DEFAULT_ROW_HEIGHT, PERSISTENCE_KEY_COLUMN_WIDTH, PERSISTENCE_KEY_ROW_HEIGHT

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

layerPainter

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

DOT, VALUE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
FilterRowDataLayer(IFilterStrategy<T> filterStrategy, ILayer columnHeaderLayer, IDataProvider columnHeaderDataProvider, IConfigRegistry configRegistry)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	doCommand(ILayerCommand command) Opportunity to respond to a command as it flows down the stack.
LabelStack	getConfigLabelsByPosition(int columnPosition, int rowPosition)
FilterRowDataProvider<T>	getFilterRowDataProvider()

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

getColumnCount, getColumnIndexByPosition, getColumnPositionByIndex, getColumnPositionByX, getColumnWidthByPosition, getDataProvider, getDataValueByPosition, getHeight, getPreferredColumnCount, getPreferredHeight, getPreferredRowCount, getPreferredWidth, getRowCount, getRowHeightByPosition, getRowIndexByPosition, getRowPositionByIndex, getRowPositionByY, getStartXOfColumnPosition, getStartYOfRowPosition, getUnderlyingLayerByPosition, getUnderlyingLayersByColumnPosition, getUnderlyingLayersByRowPosition, getWidth, isColumnPercentageSizing, isColumnPositionResizable, isRowPercentageSizing, isRowPositionResizable, loadState, localToUnderlyingColumnPosition, localToUnderlyingRowPosition, registerCommandHandlers, saveState, setColumnPercentageSizing, setColumnPositionResizable, setColumnsResizableByDefault, setColumnWidthByPosition, setColumnWidthPercentageByPosition, setDataProvider, setDefaultColumnWidth, setDefaultColumnWidthByPosition, setDefaultRowHeight, setDefaultRowHeightByPosition, setRowHeightByPosition, setRowHeightPercentageByPosition, setRowPercentageSizing, setRowPositionResizable, setRowsResizableByDefault, underlyingToLocalColumnPosition, underlyingToLocalColumnPositions, underlyingToLocalRowPosition, underlyingToLocalRowPositions

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

addConfiguration, addLayerListener, clearConfiguration, configure, dispose, fireLayerEvent, getBoundsByPosition, getCellByPosition, getCellPainter, getClientAreaProvider, getConfigLabelAccumulator, getDisplayModeByPosition, getLayerPainter, getRegionLabelsByXY, getRegionName, handleLayerEvent, hasLayerListener, registerCommandHandler, registerEventHandler, registerPersistable, removeLayerListener, setClientAreaProvider, setConfigLabelAccumulator, setLayerPainter, setRegionName, toString, unregisterCommandHandler, unregisterPersistable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.nebula.widgets.nattable.layer.ILayer

addLayerListener, configure, dispose, fireLayerEvent, getBoundsByPosition, getCellByPosition, getCellPainter, getClientAreaProvider, getDisplayModeByPosition, getLayerPainter, getRegionLabelsByXY, hasLayerListener, registerCommandHandler, registerPersistable, removeLayerListener, setClientAreaProvider, unregisterCommandHandler, unregisterPersistable

Methods inherited from interface org.eclipse.nebula.widgets.nattable.layer.ILayerListener

handleLayerEvent

Field Detail

FILTER_ROW_COLUMN_LABEL_PREFIX

public static final String FILTER_ROW_COLUMN_LABEL_PREFIX

Prefix of the column label applied to each column in the filter row

See Also:

Constant Field Values

PERSISTENCE_KEY_FILTER_ROW_TOKENS

public static final String PERSISTENCE_KEY_FILTER_ROW_TOKENS

Prefix for the persistence key in the properties file

See Also:

Constant Field Values

Constructor Detail

FilterRowDataLayer

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

Method Detail

getFilterRowDataProvider

public FilterRowDataProvider<T> getFilterRowDataProvider()

doCommand

public boolean doCommand(ILayerCommand command)

Description copied from interface: ILayer

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 co-ordinates using ILayerCommand.convertToTargetLayer(ILayer)

Specified by:

doCommand in interface ILayer

Overrides:

doCommand in class DataLayer

Parameters:

command - the command to perform

Returns:

true if the command has been handled, false otherwise

getConfigLabelsByPosition

public LabelStack getConfigLabelsByPosition(int columnPosition,
                                   int rowPosition)

Specified by:

getConfigLabelsByPosition in interface ILayer

Overrides:

getConfigLabelsByPosition in class AbstractLayer