Package org.eclipse.nebula.widgets.nattable.hierarchical.command

Class HierarchicalTreeCopyDataCommandHandler

java.lang.Object

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

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

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

org.eclipse.nebula.widgets.nattable.hierarchical.command.HierarchicalTreeCopyDataCommandHandler

All Implemented Interfaces:

ILayerCommandHandler<CopyDataToClipboardCommand>

public class HierarchicalTreeCopyDataCommandHandler
extends RowSpanningCopyDataCommandHandler

Handler class for copying selected data on a HierarchicalTreeLayer to the clipboard. Will treat cells with row spanning as a single cell and will not create gaps for rows with no cell to copy. Will also not copy cells of collapsed nodes if the labels HierarchicalTreeLayer.COLLAPSED_CHILD or HierarchicalTreeLayer.NO_OBJECT_IN_LEVEL are applied.

Since:

1.6

See Also:

• HierarchicalTreePasteDataCommandHandler

Field Summary

Fields inherited from class org.eclipse.nebula.widgets.nattable.copy.command.RowSpanningCopyDataCommandHandler

clipboard

Fields inherited from class org.eclipse.nebula.widgets.nattable.copy.command.CopyDataCommandHandler

selectionLayer

Constructor Summary

Constructors

Constructor	Description
HierarchicalTreeCopyDataCommandHandler(SelectionLayer selectionLayer, HierarchicalTreeLayer treeLayer, InternalCellClipboard clipboard)	Creates an instance that only checks the SelectionLayer for data to add to the clipboard.
HierarchicalTreeCopyDataCommandHandler(SelectionLayer selectionLayer, HierarchicalTreeLayer treeLayer, ILayer columnHeaderLayer, InternalCellClipboard clipboard)	Creates an instance that checks the SelectionLayer and the column header layer if given for data to add to the clipboard.

Method Summary

Modifier and Type	Method	Description
protected boolean	isCopyAllowed(ILayerCell cellToCopy)	Checks if the given cell can be copied.

Methods inherited from class org.eclipse.nebula.widgets.nattable.copy.command.RowSpanningCopyDataCommandHandler

assembleBody, internalDoCommand, postInternalCopy, preInternalCopy

Methods inherited from class org.eclipse.nebula.widgets.nattable.copy.command.CopyDataCommandHandler

assembleColumnHeaders, assembleCopiedDataStructure, doCommand, getColumnHeaderLayer, getCommandClass, getCopyLayer, getRowHeaderLayer, getSelectedColumnPositions, isEmpty, setCopyFormattedText, setCopyLayer

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 Details

HierarchicalTreeCopyDataCommandHandler

public HierarchicalTreeCopyDataCommandHandler(SelectionLayer selectionLayer,
 HierarchicalTreeLayer treeLayer,
 InternalCellClipboard clipboard)

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.

treeLayer - The HierarchicalTreeLayer that will be used as copyLayer from which the cells are identified to copy.

clipboard - The InternalCellClipboard that should be used for copy/paste operations within a NatTable instance.

HierarchicalTreeCopyDataCommandHandler

public HierarchicalTreeCopyDataCommandHandler(SelectionLayer selectionLayer,
 HierarchicalTreeLayer treeLayer,
 ILayer columnHeaderLayer,
 InternalCellClipboard clipboard)

Creates an instance that checks the SelectionLayer and the column header layer if given for data to add to the clipboard.

Parameters:

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

treeLayer - The HierarchicalTreeLayer that will be used as copyLayer from which the cells are identified to copy.

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

clipboard - The InternalCellClipboard that should be used for copy/paste operations within a NatTable instance.

Method Details

isCopyAllowed

protected boolean isCopyAllowed(ILayerCell cellToCopy)

Description copied from class: CopyDataCommandHandler

Checks if the given cell can be copied.

Overrides:

isCopyAllowed in class CopyDataCommandHandler

Parameters:

cellToCopy - The ILayerCell that should be copied.

Returns:

true if the cell can be copied, false if a copy operation for that cell should be avoided.