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

Class RowHeaderLayer

java.lang.Object

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

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

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

All Implemented Interfaces:

ILayer, ILayerListener, IPersistable

public class RowHeaderLayer
extends DimensionallyDependentLayer

Layer for the row headers of the grid layer

Field Summary

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
RowHeaderLayer(IUniqueIndexLayer baseLayer, ILayer verticalLayerDependency, SelectionLayer selectionLayer) Creates a row header layer using the default configuration and painter
RowHeaderLayer(IUniqueIndexLayer baseLayer, ILayer verticalLayerDependency, SelectionLayer selectionLayer, boolean useDefaultConfiguration)
RowHeaderLayer(IUniqueIndexLayer baseLayer, ILayer verticalLayerDependency, SelectionLayer selectionLayer, boolean useDefaultConfiguration, ILayerPainter layerPainter)

Method Summary

Methods

Modifier and Type	Method and Description
LabelStack	getConfigLabelsByPosition(int columnPosition, int rowPosition)
String	getDisplayModeByPosition(int columnPosition, int rowPosition)

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

configure, doCommand, getBaseLayer, getClientAreaProvider, getColumnCount, getColumnIndexByPosition, getColumnPositionByX, getColumnWidthByPosition, getDataValueByPosition, getHeight, getHorizontalLayerDependency, getLayerPainter, getPreferredColumnCount, getPreferredHeight, getPreferredRowCount, getPreferredWidth, getRegionLabelsByXY, getRowCount, getRowHeightByPosition, 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, getCellByPosition, getCellPainter, getConfigLabelAccumulator, getRegionName, handleLayerEvent, hasLayerListener, registerCommandHandler, registerCommandHandlers, registerEventHandler, registerPersistable, removeLayerListener, setConfigLabelAccumulator, setLayerPainter, setRegionName, toString, unregisterCommandHandler, unregisterPersistable

Methods inherited from class java.lang.Object

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

Constructor Detail

RowHeaderLayer

public RowHeaderLayer(IUniqueIndexLayer baseLayer,
              ILayer verticalLayerDependency,
              SelectionLayer selectionLayer)

Creates a row header layer using the default configuration and painter

Parameters:

baseLayer - The data provider for this layer

verticalLayerDependency - The layer to link the vertical dimension to, typically the body layer

selectionLayer - The selection layer required to respond to selection events

RowHeaderLayer

public RowHeaderLayer(IUniqueIndexLayer baseLayer,
              ILayer verticalLayerDependency,
              SelectionLayer selectionLayer,
              boolean useDefaultConfiguration)

RowHeaderLayer

public RowHeaderLayer(IUniqueIndexLayer baseLayer,
              ILayer verticalLayerDependency,
              SelectionLayer selectionLayer,
              boolean useDefaultConfiguration,
              ILayerPainter layerPainter)

Parameters:

baseLayer - The data provider for this layer

verticalLayerDependency - The layer to link the vertical dimension to, typically the body layer

selectionLayer - The selection layer required to respond to selection events

useDefaultConfiguration - If default configuration should be applied to this layer

layerPainter - The painter for this layer or null to use the painter of the base layer

Method Detail

getDisplayModeByPosition

public String getDisplayModeByPosition(int columnPosition,
                              int rowPosition)

Specified by:

getDisplayModeByPosition in interface ILayer

Overrides:

getDisplayModeByPosition in class DimensionallyDependentLayer

Parameters:

columnPosition - the column position of the cell

rowPosition - the row position of the cell

Returns:

DisplayMode for the cell at the given position. The DisplayMode affects the settings out of the ConfigRegistry. Display mode is NORMAL by default.

Example: SelectionLayer overrides this to return the SELECT label for cells which are selected.

getConfigLabelsByPosition

public LabelStack getConfigLabelsByPosition(int columnPosition,
                                   int rowPosition)

Specified by:

getConfigLabelsByPosition in interface ILayer

Overrides:

getConfigLabelsByPosition in class DimensionallyDependentLayer