Package org.eclipse.nebula.widgets.nattable.layer

Class AbstractIndexLayerTransform

java.lang.Object

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

org.eclipse.nebula.widgets.nattable.layer.AbstractIndexLayerTransform

All Implemented Interfaces:

ILayer, ILayerListener, IUniqueIndexLayer, IPersistable

Direct Known Subclasses:

ColumnGroupBodyLayerStack, DataChangeLayer, DefaultBodyLayerStack, DimensionallyDependentIndexLayer, FreezeLayer, HoverLayer, ResizeColumnHideShowLayer, SelectionExampleBodyLayerStack, SelectionLayer

public class AbstractIndexLayerTransform
extends AbstractLayer
implements IUniqueIndexLayer

Abstract base class for layers that expose transformed views of an underlying unique index layer. By default the AbstractLayerTransform behaves as an identity transform of its underlying layer; that is, it exposes its underlying layer as is without any changes. Subclasses are expected to override methods in this class to implement specific kinds of layer transformations.

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
AbstractIndexLayerTransform()
AbstractIndexLayerTransform(IUniqueIndexLayer underlyingLayer)

Method Summary

Modifier and Type	Method	Description
void	configure(IConfigRegistry configRegistry, UiBindingRegistry uiBindingRegistry)	Configure this layer, e.g.
void	dispose()	Dispose any resource allocated by this layer.
boolean	doCommand(ILayerCommand command)	Opportunity to respond to a command as it flows down the stack.
ILayerCell	getCellByPosition(int columnPosition, int rowPosition)	Returns the cell for the given coordinates on this layer.
ICellPainter	getCellPainter(int columnPosition, int rowPosition, ILayerCell cell, IConfigRegistry configRegistry)	Return the ICellPainter for the given ILayerCell at the given coordinates out of the given IConfigRegistry.
int	getColumnCount()
int	getColumnIndexByPosition(int columnPosition)	Gets the underlying non-transformed column index for the given column position on this layer.
int	getColumnPositionByIndex(int columnIndex)
int	getColumnPositionByX(int x)	Returns the column position that contains the given x coordinate.
int	getColumnWidthByPosition(int columnPosition)	Returns the width in pixels of the given column.
LabelStack	getConfigLabelsByPosition(int columnPosition, int rowPosition)	Returns the config labels for the cell at the given coordinates.
Object	getDataValueByPosition(int columnPosition, int rowPosition)	Returns the data value for the cell at the given coordinates.
DisplayMode	getDisplayModeByPosition(int columnPosition, int rowPosition)	Returns the active DisplayMode for the cell at the given coordinates.
int	getHeight()	Returns the total height in pixels of this layer.
ILayerPainter	getLayerPainter()
int	getPreferredColumnCount()
int	getPreferredHeight()
int	getPreferredRowCount()
int	getPreferredWidth()
LabelStack	getRegionLabelsByXY(int x, int y)	Return the LabelStack containing the region labels for the cell at the given pixel position.
int	getRowCount()
int	getRowHeightByPosition(int rowPosition)	Returns the height in pixels of the given row.
int	getRowIndexByPosition(int rowPosition)	Gets the underlying non-transformed row index for the given row position on this layer.
int	getRowPositionByIndex(int rowIndex)
int	getRowPositionByY(int y)	Returns the row position that contains the given y coordinate.
int	getStartXOfColumnPosition(int columnPosition)	Returns the x offset in pixels of the given column.
int	getStartYOfRowPosition(int rowPosition)	Returns the y offset in pixels of the given row.
protected IUniqueIndexLayer	getUnderlyingLayer()
ILayer	getUnderlyingLayerByPosition(int columnPosition, int rowPosition)	Returns the layer that is directly below this layer for the given cell coordinate.
Collection<ILayer>	getUnderlyingLayersByColumnPosition(int columnPosition)	Returns the layers that are directly below this layer for the given column position.
Collection<ILayer>	getUnderlyingLayersByRowPosition(int rowPosition)	Returns the layers that are directly below this layer for the given row position.
int	getWidth()	Returns the total width in pixels of this layer.
boolean	isColumnPositionResizable(int columnPosition)	Check if the column at the given position is resizable.
boolean	isDynamicSizeLayer()
boolean	isRowPositionResizable(int rowPosition)	Check if the row at the given position is resizable.
void	loadState(String prefix, Properties properties)	Underlying layers must load state first.
int	localToUnderlyingColumnPosition(int localColumnPosition)	Convert a column position to the coordinates of the underlying layer.
int	localToUnderlyingRowPosition(int localRowPosition)	Convert a row position to the coordinates of the underlying layer.
void	saveState(String prefix, Properties properties)	Saves the state to the given Properties using the specified prefix.
void	setClientAreaProvider(IClientAreaProvider clientAreaProvider)
protected void	setUnderlyingLayer(IUniqueIndexLayer underlyingLayer)
int	underlyingToLocalColumnPosition(ILayer sourceUnderlyingLayer, int underlyingColumnPosition)	Transforms the column position relative to the given underlying layer to this layer coordinates.
Collection<Range>	underlyingToLocalColumnPositions(ILayer sourceUnderlyingLayer, Collection<Range> underlyingColumnPositionRanges)	Transforms the column position ranges relative to the given underlying layer to this layer coordinates.
int	underlyingToLocalRowPosition(ILayer sourceUnderlyingLayer, int underlyingRowPosition)	Transforms the row position relative to the given underlying layer to this layer coordinates.
Collection<Range>	underlyingToLocalRowPositions(ILayer sourceUnderlyingLayer, Collection<Range> underlyingRowPositionRanges)	Transforms the row position ranges relative to the given underlying layer to this layer coordinates.

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

addConfiguration, addLayerListener, clearConfiguration, fireLayerEvent, getBoundsByPosition, getClientAreaProvider, getConfigLabelAccumulator, getProvidedLabels, getRegionName, handleLayerEvent, hasLayerListener, 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

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

addLayerListener, fireLayerEvent, getBoundsByPosition, getClientAreaProvider, getProvidedLabels, hasLayerListener, registerCommandHandler, registerPersistable, removeLayerListener, unregisterCommandHandler, unregisterPersistable

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

handleLayerEvent

Constructor Detail

AbstractIndexLayerTransform

public AbstractIndexLayerTransform()

AbstractIndexLayerTransform

public AbstractIndexLayerTransform(IUniqueIndexLayer underlyingLayer)

Method Detail

setUnderlyingLayer

protected void setUnderlyingLayer(IUniqueIndexLayer underlyingLayer)

getUnderlyingLayer

protected final IUniqueIndexLayer getUnderlyingLayer()

dispose

public void dispose()

Description copied from interface: ILayer

Dispose any resource allocated by this layer.

Specified by:

dispose in interface ILayer

Overrides:

dispose in class AbstractLayer

saveState

public void saveState(String prefix,
                      Properties properties)

Description copied from interface: IPersistable

Saves the state to the given Properties using the specified prefix. Note: The prefix must be prepended to the property key to support multiple states within one Properties instance.

Specified by:

saveState in interface IPersistable

Overrides:

saveState in class AbstractLayer

Parameters:

prefix - The prefix to use for the state keys. Is also used as the state configuration name.

properties - The Properties instance to save the state to.

loadState

public void loadState(String prefix,
                      Properties properties)

Underlying layers must load state first. If this is not done, IStructuralChangeEvent from underlying layers will reset caches after state has been loaded

Specified by:

loadState in interface IPersistable

Overrides:

loadState in class AbstractLayer

Parameters:

prefix - The prefix to use for the state keys. Is also used as the state configuration name.

properties - The Properties instance to load the state from.

configure

public void configure(IConfigRegistry configRegistry,
                      UiBindingRegistry uiBindingRegistry)

Description copied from interface: ILayer

Configure this layer, e.g. add any key/mouse bindings and other general configuration.

This method is triggered by NatTable.configure() and executed down the layer stack.

Specified by:

configure in interface ILayer

Overrides:

configure in class AbstractLayer

Parameters:

configRegistry - The IConfigRegistry instance owned by the NatTable this layer is attached to.

uiBindingRegistry - The UiBindingRegistry instance owned by NatTable this layer is attached to.

getLayerPainter

public ILayerPainter getLayerPainter()

Specified by:

getLayerPainter in interface ILayer

Overrides:

getLayerPainter in class AbstractLayer

Returns:

ILayerPainter. Defaults to GridLineCellLayerPainter

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

Specified by:

doCommand in interface ILayer

Overrides:

doCommand in class AbstractLayer

Parameters:

command - The command to execute.

Returns:

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

setClientAreaProvider

public void setClientAreaProvider(IClientAreaProvider clientAreaProvider)

Specified by:

setClientAreaProvider in interface ILayer

Overrides:

setClientAreaProvider in class AbstractLayer

Parameters:

clientAreaProvider - The IClientAreaProvider that specifies the rectangular area available on this layer.

getColumnCount

public int getColumnCount()

Specified by:

getColumnCount in interface ILayer

Returns:

The number of columns in this layer.

getPreferredColumnCount

public int getPreferredColumnCount()

Specified by:

getPreferredColumnCount in interface ILayer

getColumnIndexByPosition

public int getColumnIndexByPosition(int columnPosition)

Description copied from interface: ILayer

Gets the underlying non-transformed column index for the given column position on this layer.

Specified by:

getColumnIndexByPosition in interface ILayer

Parameters:

columnPosition - The column position relative to this layer.

Returns:

An underlying non-transformed column index, or -1 if the given column position does not exist within this coordinate system.

localToUnderlyingColumnPosition

public int localToUnderlyingColumnPosition(int localColumnPosition)

Description copied from interface: ILayer

Convert a column position to the coordinates of the underlying layer. This is possible since each layer is aware of its underlying layer.

Specified by:

localToUnderlyingColumnPosition in interface ILayer

Parameters:

localColumnPosition - column position in local (the layer's own) coordinates

Returns:

column position in the underlying layer's coordinates

underlyingToLocalColumnPosition

public int underlyingToLocalColumnPosition(ILayer sourceUnderlyingLayer,
                                           int underlyingColumnPosition)

Description copied from interface: ILayer

Transforms the column position relative to the given underlying layer to this layer coordinates.

Specified by:

underlyingToLocalColumnPosition in interface ILayer

Parameters:

sourceUnderlyingLayer - The underlying layer to which the given column position matches.

underlyingColumnPosition - The column position in the given underlying layer that should be converted to a local column position.

Returns:

The given column position transformed to be local to this layer.

underlyingToLocalColumnPositions

public Collection<Range> underlyingToLocalColumnPositions(ILayer sourceUnderlyingLayer,
                                                          Collection<Range> underlyingColumnPositionRanges)

Description copied from interface: ILayer

Transforms the column position ranges relative to the given underlying layer to this layer coordinates.

Specified by:

underlyingToLocalColumnPositions in interface ILayer

Parameters:

sourceUnderlyingLayer - The underlying layer to which the given column positions match.

underlyingColumnPositionRanges - The column position ranges relative to the given underlying layer that should be converted to local column positions.

Returns:

The given column position ranges transformed to this layer.

getColumnPositionByIndex

public int getColumnPositionByIndex(int columnIndex)

Specified by:

getColumnPositionByIndex in interface IUniqueIndexLayer

getWidth

public int getWidth()

Description copied from interface: ILayer

Returns the total width in pixels of this layer.

Specified by:

getWidth in interface ILayer

Returns:

The total width in pixels of this layer.

getPreferredWidth

public int getPreferredWidth()

Specified by:

getPreferredWidth in interface ILayer

getColumnWidthByPosition

public int getColumnWidthByPosition(int columnPosition)

Description copied from interface: ILayer

Returns the width in pixels of the given column. The width of invisible and non-existing columns is 0.

Specified by:

getColumnWidthByPosition in interface ILayer

Parameters:

columnPosition - The column position in this layer.

Returns:

The width of the column.

isColumnPositionResizable

public boolean isColumnPositionResizable(int columnPosition)

Description copied from interface: ILayer

Check if the column at the given position is resizable.

Specified by:

isColumnPositionResizable in interface ILayer

Parameters:

columnPosition - The column position to check.

Returns:

true if the column is resizable, false if not.

getColumnPositionByX

public int getColumnPositionByX(int x)

Description copied from interface: ILayer

Returns the column position that contains the given x coordinate.

Specified by:

getColumnPositionByX in interface ILayer

Parameters:

x - A horizontal pixel location relative to the pixel boundary of this layer.

Returns:

A column position relative to the associated coordinate system, or -1 if there is no column that contains x.

getStartXOfColumnPosition

public int getStartXOfColumnPosition(int columnPosition)

Description copied from interface: ILayer

Returns the x offset in pixels of the given column.

Specified by:

getStartXOfColumnPosition in interface ILayer

Parameters:

columnPosition - The column position in this layer.

Returns:

The x offset of the column, or -1.

getUnderlyingLayersByColumnPosition

public Collection<ILayer> getUnderlyingLayersByColumnPosition(int columnPosition)

Description copied from interface: ILayer

Returns the layers that are directly below this layer for the given column position. For simple layers this collection will typically only have one entry. Layer compositions might return multiple values, e.g. in a default grid there will be 2 layers in the collection as there are two layers involved in a column.

Specified by:

getUnderlyingLayersByColumnPosition in interface ILayer

Parameters:

columnPosition - The column position for which the underlying layers are requested.

Returns:

The layers that are directly below this layer for the given column position or null if this layer has no underlying layers.

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface ILayer

Returns:

The number of rows in this layer.

getPreferredRowCount

public int getPreferredRowCount()

Specified by:

getPreferredRowCount in interface ILayer

getRowIndexByPosition

public int getRowIndexByPosition(int rowPosition)

Description copied from interface: ILayer

Gets the underlying non-transformed row index for the given row position on this layer.

Specified by:

getRowIndexByPosition in interface ILayer

Parameters:

rowPosition - The row position relative to this layer.

Returns:

An underlying non-transformed row index, or -1 if the given row position does not exist within this coordinate system.

localToUnderlyingRowPosition

public int localToUnderlyingRowPosition(int localRowPosition)

Description copied from interface: ILayer

Convert a row position to the coordinates of the underlying layer. This is possible since each layer is aware of its underlying layer.

Specified by:

localToUnderlyingRowPosition in interface ILayer

Parameters:

localRowPosition - row position in local (the layer's own) coordinates

Returns:

row position in the underlying layer's coordinates

underlyingToLocalRowPosition

public int underlyingToLocalRowPosition(ILayer sourceUnderlyingLayer,
                                        int underlyingRowPosition)

Description copied from interface: ILayer

Transforms the row position relative to the given underlying layer to this layer coordinates.

Specified by:

underlyingToLocalRowPosition in interface ILayer

Parameters:

sourceUnderlyingLayer - The underlying layer to which the given row position matches.

underlyingRowPosition - The row position in the given underlying layer that should be converted to a local row position.

Returns:

The given row position transformed to be local to this layer.

underlyingToLocalRowPositions

public Collection<Range> underlyingToLocalRowPositions(ILayer sourceUnderlyingLayer,
                                                       Collection<Range> underlyingRowPositionRanges)

Description copied from interface: ILayer

Transforms the row position ranges relative to the given underlying layer to this layer coordinates.

Specified by:

underlyingToLocalRowPositions in interface ILayer

Parameters:

sourceUnderlyingLayer - The underlying layer to which the given row positions match.

underlyingRowPositionRanges - The row position ranges relative to the given underlying layer that should be converted to local row positions.

Returns:

The given row position ranges transformed to this layer.

getRowPositionByIndex

public int getRowPositionByIndex(int rowIndex)

Specified by:

getRowPositionByIndex in interface IUniqueIndexLayer

getHeight

public int getHeight()

Description copied from interface: ILayer

Returns the total height in pixels of this layer.

Specified by:

getHeight in interface ILayer

Returns:

The total height in pixels of this layer.

getPreferredHeight

public int getPreferredHeight()

Specified by:

getPreferredHeight in interface ILayer

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

Parameters:

rowPosition - The row position in this layer.

Returns:

The height of the row.

isRowPositionResizable

public boolean isRowPositionResizable(int rowPosition)

Description copied from interface: ILayer

Check if the row at the given position is resizable.

Specified by:

isRowPositionResizable in interface ILayer

Parameters:

rowPosition - The row position to check.

Returns:

true if the row is resizable, false if not.

getRowPositionByY

public int getRowPositionByY(int y)

Description copied from interface: ILayer

Returns the row position that contains the given y coordinate.

Specified by:

getRowPositionByY in interface ILayer

Parameters:

y - a vertical pixel location relative to the pixel boundary of this layer

Returns:

a row position relative to the associated coordinate system, or -1 if there is no row that contains y

getStartYOfRowPosition

public int getStartYOfRowPosition(int rowPosition)

Description copied from interface: ILayer

Returns the y offset in pixels of the given row.

Specified by:

getStartYOfRowPosition in interface ILayer

Parameters:

rowPosition - the row position in this layer

Returns:

the y offset of the row, or -1

getUnderlyingLayersByRowPosition

public Collection<ILayer> getUnderlyingLayersByRowPosition(int rowPosition)

Description copied from interface: ILayer

Returns the layers that are directly below this layer for the given row position. For simple layers this collection will typically only have one entry. Layer compositions might return multiple values, e.g. in a default grid there will be 2 layers in the collection as there are two layers involved in a row.

Specified by:

getUnderlyingLayersByRowPosition in interface ILayer

Parameters:

rowPosition - The row position for which the underlying layers are requested.

Returns:

The layers that are directly below this layer for the given row position or null if this layer has no underlying layers.

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.

getDisplayModeByPosition

public DisplayMode getDisplayModeByPosition(int columnPosition,
                                            int rowPosition)

Description copied from interface: ILayer

Returns the active DisplayMode for the cell at the given coordinates. Needed to retrieve the corresponding configurations out of the IConfigRegistry. The default value is DisplayMode.NORMAL. The SelectionLayer for example overrides this to return DisplayMode.SELECT for cells that are currently selected.

Specified by:

getDisplayModeByPosition in interface ILayer

Overrides:

getDisplayModeByPosition in class AbstractLayer

Parameters:

columnPosition - The column position of the cell.

rowPosition - The row position of the cell.

Returns:

DisplayMode for the cell at the given coordinates.

getConfigLabelsByPosition

public LabelStack getConfigLabelsByPosition(int columnPosition,
                                            int rowPosition)

Description copied from interface: ILayer

Returns the config labels for the cell at the given coordinates. Needed to retrieve the corresponding configurations out of the IConfigRegistry.

Specified by:

getConfigLabelsByPosition in interface ILayer

Overrides:

getConfigLabelsByPosition in class AbstractLayer

Parameters:

columnPosition - The column position of the cell.

rowPosition - The row position of the cell.

Returns:

The LabelStack with the config labels for the cell at the given coordinates.

getDataValueByPosition

public Object getDataValueByPosition(int columnPosition,
                                     int rowPosition)

Description copied from interface: ILayer

Returns the data value for the cell at the given coordinates.

Specified by:

getDataValueByPosition in interface ILayer

Parameters:

columnPosition - The column position of the cell.

rowPosition - The row position of the cell.

Returns:

The data value for the cell at the given coordinates.

getCellPainter

public ICellPainter getCellPainter(int columnPosition,
                                   int rowPosition,
                                   ILayerCell cell,
                                   IConfigRegistry configRegistry)

Description copied from interface: ILayer

Return the ICellPainter for the given ILayerCell at the given coordinates out of the given IConfigRegistry.

Specified by:

getCellPainter in interface ILayer

Overrides:

getCellPainter in class AbstractLayer

Parameters:

columnPosition - The column position of the cell.

rowPosition - The row position of the cell.

cell - The ILayerCell for which the ICellPainter is requested.

configRegistry - The IConfigRegistry to retrieve the painter from.

Returns:

The ICellPainter for the given cell at the given coordinates or null if no painter is configured.

getRegionLabelsByXY

public LabelStack getRegionLabelsByXY(int x,
                                      int y)

Description copied from interface: ILayer

Return the LabelStack containing the region labels for the cell at the given pixel position.

Specified by:

getRegionLabelsByXY in interface ILayer

Overrides:

getRegionLabelsByXY in class AbstractLayer

Parameters:

x - the x pixel coordinate

y - the y pixel coordinate

Returns:

LabelStack containing the region labels for the cell at the given pixel position.

getUnderlyingLayerByPosition

public ILayer getUnderlyingLayerByPosition(int columnPosition,
                                           int rowPosition)

Description copied from interface: ILayer

Returns the layer that is directly below this layer for the given cell coordinate.

Specified by:

getUnderlyingLayerByPosition in interface ILayer

Parameters:

columnPosition - The column position for which the underlying layer is requested.

rowPosition - The row position for which the underlying layer is requested.

Returns:

The layer that is directly below this layer for the given cell coordinates or null if this layer has no underlying layers.

isDynamicSizeLayer

public boolean isDynamicSizeLayer()

Specified by:

isDynamicSizeLayer in interface ILayer

Overrides:

isDynamicSizeLayer in class AbstractLayer

Returns:

true if the layer has a dynamic size (e.g. viewport) or a fixed size.