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

Class AbstractRegionCommand

java.lang.Object

org.eclipse.nebula.widgets.nattable.command.AbstractContextFreeCommand

org.eclipse.nebula.widgets.nattable.command.AbstractRegionCommand

All Implemented Interfaces:

ILayerCommand

Direct Known Subclasses:

ColumnSizeConfigurationCommand, ColumnWidthResetCommand, RowHeightResetCommand, RowSizeConfigurationCommand

public abstract class AbstractRegionCommand
extends AbstractContextFreeCommand

Abstract command that can be used to send a command into a specific region of a composition like a grid.

Since:

1.5

Field Summary

Fields

Modifier and Type	Field	Description
final String	label	The label that needs to be applied in order to process the command.

Constructor Summary

Constructors

Constructor	Description
AbstractRegionCommand(String label)

Method Summary

Modifier and Type	Method	Description
abstract AbstractRegionCommand	cloneForRegion()	Creates and returns a clone of this instance with necessary modifications for further processing.

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

cloneCommand, convertToTargetLayer

Methods inherited from class java.lang.Object

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

Field Details

label

public final String label

The label that needs to be applied in order to process the command. If the label matches a region, the command will be only processed down the layer stack of the corresponding region. If the label is null or a cell label, the command will be processed by all or the first layer in the composition that has a handler configured.

Constructor Details

AbstractRegionCommand

public AbstractRegionCommand(String label)

Parameters:

label - The label that needs to be applied in order to process the command. If the label matches a region, the command will be only processed down the layer stack of the corresponding region. If the label is null or a cell label, the command will be processed by all or the first layer in the composition that has a handler configured.

Method Details

cloneForRegion

public abstract AbstractRegionCommand cloneForRegion()

Creates and returns a clone of this instance with necessary modifications for further processing. Typically the label information is removed or adjusted for processing further down the region layer stack.

Returns:

A clone of this command prepared for further processing down the region layer stack.