org.eclipse.nebula.widgets.nattable.selection

Class SelectionLayer

java.lang.Object

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

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

org.eclipse.nebula.widgets.nattable.selection.SelectionLayer

All Implemented Interfaces:

ILayer, ILayerListener, IUniqueIndexLayer, IPersistable

public class SelectionLayer
extends AbstractIndexLayerTransform

Enables selection of column, rows, cells etc. on the table. Also responds to UI bindings by changing the current selection. Internally it uses the ISelectionModel to track the selection state.

See Also:

DefaultSelectionLayerConfiguration, SelectionLayer.MoveDirectionEnum

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SelectionLayer.MoveDirectionEnum

Field Summary

Fields

Modifier and Type	Field and Description
protected PositionCoordinate	lastSelectedCell
protected org.eclipse.swt.graphics.Rectangle	lastSelectedRegion
static int	MOVE_ALL
static int	NO_SELECTION
protected PositionCoordinate	selectionAnchor
protected ISelectionModel	selectionModel
protected IUniqueIndexLayer	underlyingLayer

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
SelectionLayer(IUniqueIndexLayer underlyingLayer)
SelectionLayer(IUniqueIndexLayer underlyingLayer, boolean useDefaultConfiguration)
SelectionLayer(IUniqueIndexLayer underlyingLayer, ISelectionModel selectionModel, boolean useDefaultConfiguration)
SelectionLayer(IUniqueIndexLayer underlyingLayer, ISelectionModel selectionModel, boolean useDefaultConfiguration, boolean registerDefaultEventHandler)

Method Summary

Methods

Modifier and Type	Method and Description
void	addSelection(org.eclipse.swt.graphics.Rectangle selection)
void	clear()
void	clear(boolean fireSelectionEvent)
void	clearSelection(int columnPosition, int rowPosition)
void	clearSelection(org.eclipse.swt.graphics.Rectangle selection)
boolean	doCommand(ILayerCommand command) Opportunity to respond to a command as it flows down the stack.
void	fireCellSelectionEvent(int columnPosition, int rowPosition, boolean forcingEntireCellIntoViewport, boolean withShiftMask, boolean withControlMask)
protected PositionCoordinate	getCellPositionToMoveFrom(boolean withShiftMask, boolean withControlMask) When extending a selected area we need to start adding cells from the last selected cell.
LabelStack	getConfigLabelsByPosition(int columnPosition, int rowPosition)
String	getDisplayModeByPosition(int columnPosition, int rowPosition)
int[]	getFullySelectedColumnPositions()
int[]	getFullySelectedRowPositions()
PositionCoordinate	getLastSelectedCellPosition()
org.eclipse.swt.graphics.Rectangle	getLastSelectedRegion()
ILayerPainter	getLayerPainter()
PositionCoordinate[]	getSelectedCellPositions()
int[]	getSelectedColumnPositions()
int	getSelectedRowCount()
Set<Range>	getSelectedRowPositions()
PositionCoordinate	getSelectionAnchor()
ISelectionModel	getSelectionModel()
protected boolean	handleColumnHideCommand(ColumnHideCommand command) Will check if there are fully selected column positions.
protected boolean	handleColumnResizeCommand(ColumnResizeCommand command) Will check if there are fully selected column positions.
protected boolean	handleMultiColumnHideCommand(MultiColumnHideCommand command) Previous to processing the given MultiColumnHideCommand down the layer stack, the fully selected column positions selection state will be cleared.
protected boolean	handleMultiRowHideCommand(MultiRowHideCommand command) Previous to processing the given MultiRowHideCommand down the layer stack, the fully selected row positions selection state will be cleared.
protected boolean	handleRowHideCommand(RowHideCommand command) Will check if there are fully selected row positions.
protected boolean	handleRowResizeCommand(RowResizeCommand command) Will check if there are fully selected row positions.
boolean	hasColumnSelection()
boolean	hasRowSelection()
boolean	isCellPositionSelected(int columnPosition, int rowPosition)
boolean	isColumnPositionFullySelected(int columnPosition)
boolean	isColumnPositionSelected(int columnPosition)
boolean	isRowPositionFullySelected(int rowPosition)
boolean	isRowPositionSelected(int rowPosition)
void	moveSelectionAnchor(int startColumnPositionInRegion, int startRowPosition)
protected void	registerCommandHandlers() Layers should use this method to register their command handlers and call it from their constructor.
void	selectAll()
void	selectCell(int columnPosition, int rowPosition, boolean withShiftMask, boolean withControlMask) Calculates the selected cells - taking into account Shift and Ctrl key presses.
void	selectColumn(int columnPosition, int rowPosition, boolean withShiftMask, boolean withControlMask)
void	selectRegion(int startColumnPosition, int startRowPosition, int regionWidth, int regionHeight)
void	selectRow(int columnPosition, int rowPosition, boolean withShiftMask, boolean withControlMask)
void	setLastSelectedCell(int columnPosition, int rowPosition)
void	setSelectedCell(int columnPosition, int rowPosition)
void	setSelectionModel(ISelectionModel selectionModel)

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

configure, dispose, getCellByPosition, getCellPainter, getColumnCount, getColumnIndexByPosition, getColumnPositionByIndex, getColumnPositionByX, getColumnWidthByPosition, getDataValueByPosition, getHeight, getPreferredColumnCount, getPreferredHeight, getPreferredRowCount, getPreferredWidth, getRegionLabelsByXY, getRowCount, getRowHeightByPosition, getRowIndexByPosition, getRowPositionByIndex, getRowPositionByY, getStartXOfColumnPosition, getStartYOfRowPosition, getUnderlyingLayer, getUnderlyingLayerByPosition, getUnderlyingLayersByColumnPosition, getUnderlyingLayersByRowPosition, getWidth, isColumnPositionResizable, isRowPositionResizable, loadState, localToUnderlyingColumnPosition, localToUnderlyingRowPosition, saveState, setClientAreaProvider, setUnderlyingLayer, underlyingToLocalColumnPosition, underlyingToLocalColumnPositions, underlyingToLocalRowPosition, underlyingToLocalRowPositions

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

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

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

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

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

handleLayerEvent

Field Detail

MOVE_ALL

public static final int MOVE_ALL

See Also:

Constant Field Values

NO_SELECTION

public static final int NO_SELECTION

See Also:

Constant Field Values

selectionModel

protected ISelectionModel selectionModel

underlyingLayer

protected IUniqueIndexLayer underlyingLayer

lastSelectedCell

protected final PositionCoordinate lastSelectedCell

selectionAnchor

protected final PositionCoordinate selectionAnchor

lastSelectedRegion

protected org.eclipse.swt.graphics.Rectangle lastSelectedRegion

Constructor Detail

SelectionLayer

public SelectionLayer(IUniqueIndexLayer underlyingLayer)

SelectionLayer

public SelectionLayer(IUniqueIndexLayer underlyingLayer,
              boolean useDefaultConfiguration)

SelectionLayer

public SelectionLayer(IUniqueIndexLayer underlyingLayer,
              ISelectionModel selectionModel,
              boolean useDefaultConfiguration)

SelectionLayer

public SelectionLayer(IUniqueIndexLayer underlyingLayer,
              ISelectionModel selectionModel,
              boolean useDefaultConfiguration,
              boolean registerDefaultEventHandler)

Method Detail

getSelectionModel

public ISelectionModel getSelectionModel()

setSelectionModel

public void setSelectionModel(ISelectionModel selectionModel)

getLayerPainter

public ILayerPainter getLayerPainter()

Specified by:

getLayerPainter in interface ILayer

Overrides:

getLayerPainter in class AbstractIndexLayerTransform

Returns:

ILayerPainter. Defaults to GridLineCellLayerPainter

addSelection

public void addSelection(org.eclipse.swt.graphics.Rectangle selection)

clear

public void clear()

clear

public void clear(boolean fireSelectionEvent)

clearSelection

public void clearSelection(int columnPosition,
                  int rowPosition)

clearSelection

public void clearSelection(org.eclipse.swt.graphics.Rectangle selection)

selectAll

public void selectAll()

isCellPositionSelected

public boolean isCellPositionSelected(int columnPosition,
                             int rowPosition)

setSelectedCell

public void setSelectedCell(int columnPosition,
                   int rowPosition)

getCellPositionToMoveFrom

protected PositionCoordinate getCellPositionToMoveFrom(boolean withShiftMask,
                                           boolean withControlMask)

When extending a selected area we need to start adding cells from the last selected cell. If we are not extending a selection we need to move from the selection anchor.

getSelectedCellPositions

public PositionCoordinate[] getSelectedCellPositions()

selectCell

public void selectCell(int columnPosition,
              int rowPosition,
              boolean withShiftMask,
              boolean withControlMask)

Calculates the selected cells - taking into account Shift and Ctrl key presses.

selectRegion

public void selectRegion(int startColumnPosition,
                int startRowPosition,
                int regionWidth,
                int regionHeight)

getSelectionAnchor

public PositionCoordinate getSelectionAnchor()

moveSelectionAnchor

public void moveSelectionAnchor(int startColumnPositionInRegion,
                       int startRowPosition)

getLastSelectedCellPosition

public PositionCoordinate getLastSelectedCellPosition()

setLastSelectedCell

public void setLastSelectedCell(int columnPosition,
                       int rowPosition)

getLastSelectedRegion

public org.eclipse.swt.graphics.Rectangle getLastSelectedRegion()

hasColumnSelection

public boolean hasColumnSelection()

getSelectedColumnPositions

public int[] getSelectedColumnPositions()

isColumnPositionSelected

public boolean isColumnPositionSelected(int columnPosition)

getFullySelectedColumnPositions

public int[] getFullySelectedColumnPositions()

isColumnPositionFullySelected

public boolean isColumnPositionFullySelected(int columnPosition)

selectColumn

public void selectColumn(int columnPosition,
                int rowPosition,
                boolean withShiftMask,
                boolean withControlMask)

hasRowSelection

public boolean hasRowSelection()

getSelectedRowCount

public int getSelectedRowCount()

getSelectedRowPositions

public Set<Range> getSelectedRowPositions()

isRowPositionSelected

public boolean isRowPositionSelected(int rowPosition)

getFullySelectedRowPositions

public int[] getFullySelectedRowPositions()

isRowPositionFullySelected

public boolean isRowPositionFullySelected(int rowPosition)

selectRow

public void selectRow(int columnPosition,
             int rowPosition,
             boolean withShiftMask,
             boolean withControlMask)

getDisplayModeByPosition

public String getDisplayModeByPosition(int columnPosition,
                              int rowPosition)

Specified by:

getDisplayModeByPosition in interface ILayer

Overrides:

getDisplayModeByPosition in class AbstractIndexLayerTransform

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 AbstractIndexLayerTransform

registerCommandHandlers

protected void registerCommandHandlers()

Description copied from class: AbstractLayer

Layers should use this method to register their command handlers and call it from their constructor. This allows easy overriding if required of command handlers

Overrides:

registerCommandHandlers in class AbstractLayer

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 AbstractIndexLayerTransform

Parameters:

command - the command to perform

Returns:

true if the command has been handled, false otherwise

fireCellSelectionEvent

public void fireCellSelectionEvent(int columnPosition,
                          int rowPosition,
                          boolean forcingEntireCellIntoViewport,
                          boolean withShiftMask,
                          boolean withControlMask)

handleColumnHideCommand

protected boolean handleColumnHideCommand(ColumnHideCommand command)

Will check if there are fully selected column positions. If there is at least one fully selected column position, the ColumnHideCommand will be consumed and a MultiColumnHideCommand will be created and executed further down the layer stack, that contains all fully selected column positions. Otherwise the given command will be executed further.
This is necessary because neither the ColumnHideShowLayer nor the action that caused the execution of the ColumnHideCommand is aware of the presence of the SelectionLayer. Without this transformation, only the column on which the action was called will be hidden instead of all selected ones.

Parameters:

command - The ColumnHideCommand to process

Returns:

true if the command has been handled, false otherwise

handleMultiColumnHideCommand

protected boolean handleMultiColumnHideCommand(MultiColumnHideCommand command)

Previous to processing the given MultiColumnHideCommand down the layer stack, the fully selected column positions selection state will be cleared. This is necessary so the selection also disappears for the selected columns. Otherwise after hiding the selection will be showed for different columns.

Parameters:

command - The MultiColumnHideCommand to process

Returns:

true if the command has been handled, false otherwise

handleRowHideCommand

protected boolean handleRowHideCommand(RowHideCommand command)

Will check if there are fully selected row positions. If there is at least one fully selected row position, the RowHideCommand will be consumed and a MultiRowHideCommand will be created and executed further down the layer stack, that contains all fully selected row positions. Otherwise the given command will be executed further.
This is necessary because neither the RowHideShowLayer nor the action that caused the execution of the RowHideCommand is aware of the presence of the SelectionLayer. Without this transformation, only the row on which the action was called will be hidden instead of all selected ones.

Parameters:

command - The RowHideCommand to process

Returns:

true if the command has been handled, false otherwise

handleMultiRowHideCommand

protected boolean handleMultiRowHideCommand(MultiRowHideCommand command)

Previous to processing the given MultiRowHideCommand down the layer stack, the fully selected row positions selection state will be cleared. This is necessary so the selection also disappears for the selected rows. Otherwise after hiding the selection will be showed for different rows.

Parameters:

command - The MultiRowHideCommand to process

Returns:

true if the command has been handled, false otherwise

handleColumnResizeCommand

protected boolean handleColumnResizeCommand(ColumnResizeCommand command)

Will check if there are fully selected column positions. If there is at least one fully selected column position, the ColumnResizeCommand will be consumed and a MultiColumnResizeCommand will be created and executed further down the layer stack, that contains all fully selected column positions. Otherwise the given command will be executed further.
This is necessary because neither the underlying layers are not aware of the presence of the SelectionLayer. Without this transformation, only the column on which the action was called will be resized instead of all selected ones.

Parameters:

command - The ColumnResizeCommand to process

Returns:

true if the command has been handled, false otherwise

handleRowResizeCommand

protected boolean handleRowResizeCommand(RowResizeCommand command)

Will check if there are fully selected row positions. If there is at least one fully selected row position, the RowResizeCommand will be consumed and a MultiRowResizeCommand will be created and executed further down the layer stack, that contains all fully selected row positions. Otherwise the given command will be executed further.
This is necessary because neither the underlying layers are not aware of the presence of the SelectionLayer. Without this transformation, only the row on which the action was called will be resized instead of all selected ones.

Parameters:

command - The RowResizeCommand to process

Returns:

true if the command has been handled, false otherwise