org.eclipse.nebula.widgets.nattable.copy.command

Class CopyDataCommandHandler

java.lang.Object

org.eclipse.nebula.widgets.nattable.command.AbstractLayerCommandHandler<CopyDataToClipboardCommand>

org.eclipse.nebula.widgets.nattable.copy.command.CopyDataCommandHandler

All Implemented Interfaces:

ILayerCommandHandler<CopyDataToClipboardCommand>

public class CopyDataCommandHandler
extends AbstractLayerCommandHandler<CopyDataToClipboardCommand>

Handler class for copying selected data within the SelectionLayer to the clipboard. This handler is registered by default with the SelectionLayer, without references to the header regions. You can override the copy data behaviour by registering an instance of this handler to a layer above the SelectionLayer. This way the registered custom instance will consume a CopyDataToClipboardCommand and the registered default handler won't be called.

Constructor Summary

Constructors

Constructor and Description
CopyDataCommandHandler(SelectionLayer selectionLayer) Creates an instance that only checks the SelectionLayer for data to add to the clipboard.
CopyDataCommandHandler(SelectionLayer selectionLayer, ILayer columnHeaderDataLayer, ILayer rowHeaderDataLayer) Creates an instance that checks the SelectionLayer and the header layers if they are given.

Method Summary

Methods

Modifier and Type	Method and Description
protected ILayerCell[]	assembleBody(int currentRowPosition) Collects and assembles the selected data per row position that should be copied to the clipboard.
protected ILayerCell[][]	assembleColumnHeaders() Creates the two dimensional array whose dimensions are calculated based on the selection within the SelectionLayer and the configured column and row headers.
protected ILayerCell[][]	assembleCopiedDataStructure() Collects and assembles the selected data that should be copied to the clipboard.
boolean	doCommand(CopyDataToClipboardCommand command)
Class<CopyDataToClipboardCommand>	getCommandClass()
void	setCopyFormattedText(boolean copyFormattedText) TODO

Methods inherited from class org.eclipse.nebula.widgets.nattable.command.AbstractLayerCommandHandler

doCommand

Methods inherited from class java.lang.Object

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

Constructor Detail

CopyDataCommandHandler

public CopyDataCommandHandler(SelectionLayer selectionLayer)

Creates an instance that only checks the SelectionLayer for data to add to the clipboard.

Parameters:

selectionLayer - The SelectionLayer within the NatTable. Can not be null.

CopyDataCommandHandler

public CopyDataCommandHandler(SelectionLayer selectionLayer,
                      ILayer columnHeaderDataLayer,
                      ILayer rowHeaderDataLayer)

Creates an instance that checks the SelectionLayer and the header layers if they are given.

Parameters:

selectionLayer - The SelectionLayer within the NatTable. Can not be null.

columnHeaderDataLayer - The column header data layer within the NatTable grid. Can be null.

rowHeaderDataLayer - The row header data layer within the NatTable grid. Can be null.

Method Detail

setCopyFormattedText

public void setCopyFormattedText(boolean copyFormattedText)

TODO

Parameters:

copyFormattedText -

doCommand

public boolean doCommand(CopyDataToClipboardCommand command)

Specified by:

doCommand in class AbstractLayerCommandHandler<CopyDataToClipboardCommand>

getCommandClass

public Class<CopyDataToClipboardCommand> getCommandClass()

assembleCopiedDataStructure

protected ILayerCell[][] assembleCopiedDataStructure()

Collects and assembles the selected data that should be copied to the clipboard.

Returns:

A two dimensional array containing the selected cells to copy to the clipboard. The first level of this array represent the row positions of the cells, while the second level contains the cells itself based on the column position.

assembleColumnHeaders

protected ILayerCell[][] assembleColumnHeaders()

Creates the two dimensional array whose dimensions are calculated based on the selection within the SelectionLayer and the configured column and row headers. If there is a column header configured for this handler, the column header information will be added to the resulting array in here. If there is no column header configured an empty array with the matching dimensions will be returned.

Returns:

A two dimensional array with the dimensions to store the selected data to copy to the clipboard. Will also contain the column header information for the copy operation if there is one configured.

assembleBody

protected ILayerCell[] assembleBody(int currentRowPosition)

Collects and assembles the selected data per row position that should be copied to the clipboard. If there is a row header layer configured for this handler, the row header cells of the selected row position are also added to the resulting array.

Parameters:

currentRowPosition - The row position of which the selected cells should be collected.

Returns:

An array containing the selected cells that should be copied to the clipboard.