public class TestLayer extends Object implements IUniqueIndexLayer
DOT, VALUE_SEPARATOR
Constructor and Description |
---|
TestLayer(int columnCount,
int preferredColumnCount,
int preferredWidth,
int rowCount,
int preferredRowCount,
int preferredHeight,
String columnsInfo,
String rowsInfo,
String cellsInfo) |
TestLayer(int columnCount,
int rowCount,
String columnsInfo,
String rowsInfo,
String cellsInfo) |
Modifier and Type | Method and Description |
---|---|
void |
addLayerListener(ILayerListener listener) |
void |
configure(ConfigRegistry configRegistry,
UiBindingRegistry uiBindingRegistry)
Every layer gets this call back, starting at the top of the stack.
|
void |
dispose() |
boolean |
doCommand(ILayerCommand command)
Opportunity to respond to a command as it flows down the stack.
|
void |
fireLayerEvent(ILayerEvent event)
Events can be fired to notify other components of the grid.
|
org.eclipse.swt.graphics.Rectangle |
getBoundsByPosition(int columnPosition,
int rowPosition)
Calculates the bounds in pixel for the given cell position.
|
ILayerCell |
getCellByPosition(int columnPosition,
int rowPosition) |
ICellPainter |
getCellPainter(int columnPosition,
int rowPosition,
ILayerCell cell,
IConfigRegistry configRegistry) |
IClientAreaProvider |
getClientAreaProvider() |
int |
getColumnCount() |
int |
getColumnIndexByPosition(int columnPosition)
Gets the underlying non-transformed column index for the given column position.
|
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) |
Object |
getDataValueByPosition(int columnPosition,
int rowPosition) |
String |
getDisplayModeByPosition(int columnPosition,
int rowPosition) |
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)
Layer can apply its own labels to any cell it wishes.
|
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.
|
int |
getRowPositionByIndex(int rowIndex) |
int |
getRowPositionByY(int y)
Returns the row position that contains the given y coordinate.
|
int |
getStartXOfColumnPosition(int targetColumnPosition)
Returns the x offset in pixels of the given column.
|
int |
getStartYOfRowPosition(int targetRowPosition)
Returns the y offset in pixels of the given row.
|
ILayer |
getUnderlyingLayerByPosition(int columnPosition,
int rowPosition) |
Collection<ILayer> |
getUnderlyingLayersByColumnPosition(int columnPosition) |
Collection<ILayer> |
getUnderlyingLayersByRowPosition(int rowPosition) |
int |
getWidth()
Returns the total width in pixels of this layer.
|
void |
handleLayerEvent(ILayerEvent event)
Handle an event notification from an
ILayer |
boolean |
hasLayerListener(Class<? extends ILayerListener> layerListenerClass) |
boolean |
isColumnPositionResizable(int columnPosition) |
boolean |
isRowPositionResizable(int rowPosition) |
void |
loadState(String prefix,
Properties properties)
Restore the state out of the given Properties identified by the specified prefix.
|
int |
localToUnderlyingColumnPosition(int localColumnPosition)
Convert a column position to the coordinates of the underlying layer.
|
int |
localToUnderlyingRowPosition(int localRowPosition) |
void |
parseCellsInfo(String cellsInfo) |
void |
registerCommandHandler(ILayerCommandHandler<?> commandHandler) |
void |
registerPersistable(IPersistable persistable)
Persistables registered with a layer will have a chance to write their data out to the
Properties instance when the layer is persisted. |
void |
removeLayerListener(ILayerListener listener) |
void |
saveState(String prefix,
Properties properties)
Saves the state to the given Properties using the specified prefix.
|
void |
setClientAreaProvider(IClientAreaProvider clientAreaProvider) |
int |
underlyingToLocalColumnPosition(ILayer sourceUnderlyingLayer,
int underlyingColumnPosition) |
Collection<Range> |
underlyingToLocalColumnPositions(ILayer sourceUnderlyingLayer,
Collection<Range> underlyingColumnPositionRanges) |
int |
underlyingToLocalRowPosition(ILayer sourceUnderlyingLayer,
int underlyingRowPosition) |
Collection<Range> |
underlyingToLocalRowPositions(ILayer sourceUnderlyingLayer,
Collection<Range> underlyingRowPositionRanges) |
void |
unregisterCommandHandler(Class<? extends ILayerCommand> commandClass) |
void |
unregisterPersistable(IPersistable persistable) |
public TestLayer(int columnCount, int rowCount, String columnsInfo, String rowsInfo, String cellsInfo)
public void parseCellsInfo(String cellsInfo)
public void registerPersistable(IPersistable persistable)
ILayer
Properties
instance when the layer is persisted.registerPersistable
in interface ILayer
persistable
- the persistable to be registeredpublic void unregisterPersistable(IPersistable persistable)
unregisterPersistable
in interface ILayer
public void saveState(String prefix, Properties properties)
IPersistable
saveState
in interface IPersistable
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.public void loadState(String prefix, Properties properties)
IPersistable
loadState
in interface IPersistable
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.public void configure(ConfigRegistry configRegistry, UiBindingRegistry uiBindingRegistry)
ILayer
NatTable.configure()
method. This is an opportunity to add
any key/mouse bindings and other general configuration.public boolean doCommand(ILayerCommand command)
ILayer
ILayerCommand.convertToTargetLayer(ILayer)
public void registerCommandHandler(ILayerCommandHandler<?> commandHandler)
registerCommandHandler
in interface ILayer
public void unregisterCommandHandler(Class<? extends ILayerCommand> commandClass)
unregisterCommandHandler
in interface ILayer
public void handleLayerEvent(ILayerEvent event)
ILayerListener
ILayer
handleLayerEvent
in interface ILayerListener
event
- the eventpublic void addLayerListener(ILayerListener listener)
addLayerListener
in interface ILayer
public void removeLayerListener(ILayerListener listener)
removeLayerListener
in interface ILayer
public boolean hasLayerListener(Class<? extends ILayerListener> layerListenerClass)
hasLayerListener
in interface ILayer
layerListenerClass
- The type of ILayerListener
to check for existencetrue
if this ILayer
has a ILayerListener
registered for the specified type, false
if there is
no such listener registered alreadypublic ILayerPainter getLayerPainter()
getLayerPainter
in interface ILayer
public IClientAreaProvider getClientAreaProvider()
getClientAreaProvider
in interface ILayer
public void setClientAreaProvider(IClientAreaProvider clientAreaProvider)
setClientAreaProvider
in interface ILayer
public LabelStack getRegionLabelsByXY(int x, int y)
ILayer
getRegionLabelsByXY
in interface ILayer
x
- the x pixel coordinatey
- the y pixel coordinatepublic int getColumnCount()
getColumnCount
in interface ILayer
public int getPreferredColumnCount()
getPreferredColumnCount
in interface ILayer
public int getColumnIndexByPosition(int columnPosition)
ILayer
getColumnIndexByPosition
in interface ILayer
columnPosition
- a column position relative to this coordinate modelpublic int localToUnderlyingColumnPosition(int localColumnPosition)
ILayer
localToUnderlyingColumnPosition
in interface ILayer
localColumnPosition
- column position in local (the layer's own) coordinatespublic int underlyingToLocalColumnPosition(ILayer sourceUnderlyingLayer, int underlyingColumnPosition)
underlyingToLocalColumnPosition
in interface ILayer
public Collection<Range> underlyingToLocalColumnPositions(ILayer sourceUnderlyingLayer, Collection<Range> underlyingColumnPositionRanges)
underlyingToLocalColumnPositions
in interface ILayer
public int getColumnPositionByIndex(int columnIndex)
getColumnPositionByIndex
in interface IUniqueIndexLayer
public int getWidth()
ILayer
public int getPreferredWidth()
getPreferredWidth
in interface ILayer
public int getColumnWidthByPosition(int columnPosition)
ILayer
getColumnWidthByPosition
in interface ILayer
columnPosition
- the column position in this layerpublic boolean isColumnPositionResizable(int columnPosition)
isColumnPositionResizable
in interface ILayer
public int getColumnPositionByX(int x)
ILayer
getColumnPositionByX
in interface ILayer
x
- a horizontal pixel location relative to the pixel boundary of this layerpublic int getStartXOfColumnPosition(int targetColumnPosition)
ILayer
getStartXOfColumnPosition
in interface ILayer
targetColumnPosition
- the column position in this layerpublic Collection<ILayer> getUnderlyingLayersByColumnPosition(int columnPosition)
getUnderlyingLayersByColumnPosition
in interface ILayer
public int getRowCount()
getRowCount
in interface ILayer
public int getPreferredRowCount()
getPreferredRowCount
in interface ILayer
public int getRowIndexByPosition(int rowPosition)
ILayer
getRowIndexByPosition
in interface ILayer
rowPosition
- a row position relative to this coordinate modelpublic int localToUnderlyingRowPosition(int localRowPosition)
localToUnderlyingRowPosition
in interface ILayer
public int underlyingToLocalRowPosition(ILayer sourceUnderlyingLayer, int underlyingRowPosition)
underlyingToLocalRowPosition
in interface ILayer
public Collection<Range> underlyingToLocalRowPositions(ILayer sourceUnderlyingLayer, Collection<Range> underlyingRowPositionRanges)
underlyingToLocalRowPositions
in interface ILayer
public int getRowPositionByIndex(int rowIndex)
getRowPositionByIndex
in interface IUniqueIndexLayer
public int getHeight()
ILayer
public int getPreferredHeight()
getPreferredHeight
in interface ILayer
public int getRowHeightByPosition(int rowPosition)
ILayer
getRowHeightByPosition
in interface ILayer
rowPosition
- the row position in this layerpublic boolean isRowPositionResizable(int rowPosition)
isRowPositionResizable
in interface ILayer
public int getRowPositionByY(int y)
ILayer
getRowPositionByY
in interface ILayer
y
- a vertical pixel location relative to the pixel boundary of this layerpublic int getStartYOfRowPosition(int targetRowPosition)
ILayer
getStartYOfRowPosition
in interface ILayer
targetRowPosition
- the row position in this layerpublic Collection<ILayer> getUnderlyingLayersByRowPosition(int rowPosition)
getUnderlyingLayersByRowPosition
in interface ILayer
public ILayerCell getCellByPosition(int columnPosition, int rowPosition)
getCellByPosition
in interface ILayer
public org.eclipse.swt.graphics.Rectangle getBoundsByPosition(int columnPosition, int rowPosition)
ILayer
getBoundsByPosition
in interface ILayer
columnPosition
- the column position of the cellrowPosition
- the row position of the cellnull
if there are no valid boundspublic String getDisplayModeByPosition(int columnPosition, int rowPosition)
getDisplayModeByPosition
in interface ILayer
columnPosition
- the column position of the cellrowPosition
- the row position of the cellDisplayMode
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.
public LabelStack getConfigLabelsByPosition(int columnPosition, int rowPosition)
getConfigLabelsByPosition
in interface ILayer
public Object getDataValueByPosition(int columnPosition, int rowPosition)
getDataValueByPosition
in interface ILayer
public ILayer getUnderlyingLayerByPosition(int columnPosition, int rowPosition)
getUnderlyingLayerByPosition
in interface ILayer
public void fireLayerEvent(ILayerEvent event)
ILayer
Example: When the contents of the grid change IVisualChangeEvent
can be
fired to notify other layers to refresh their caches etc.
fireLayerEvent
in interface ILayer
event
- the event to firepublic ICellPainter getCellPainter(int columnPosition, int rowPosition, ILayerCell cell, IConfigRegistry configRegistry)
getCellPainter
in interface ILayer
Copyright © 2013. All Rights Reserved.