Class TickUpdateCommand
- java.lang.Object
-
- org.eclipse.nebula.widgets.nattable.tickupdate.command.TickUpdateCommand
-
- All Implemented Interfaces:
ILayerCommand
public class TickUpdateCommand extends Object implements ILayerCommand
Command to trigger a tick update on the current selected cells. Note: This command only works if the layer composition contains a SelectionLayer and the correspondingTickUpdateCommandHandler
is registered.
-
-
Constructor Summary
Constructors Modifier Constructor Description TickUpdateCommand(IConfigRegistry configRegistry, boolean increment)
protected
TickUpdateCommand(TickUpdateCommand command)
Constructor that is used by local cloning operation.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TickUpdateCommand
cloneCommand()
Same semantics asObject.clone()
Used to make a copies of the command if has to passed to different layer stacks.boolean
convertToTargetLayer(ILayer targetLayer)
Convert the row/column coordinates the command might be carrying from the source layer to the destination (target) layer.IConfigRegistry
getConfigRegistry()
boolean
isIncrement()
-
-
-
Constructor Detail
-
TickUpdateCommand
public TickUpdateCommand(IConfigRegistry configRegistry, boolean increment)
- Parameters:
configRegistry
- TheIConfigRegistry
of the current NatTable instance this command is executed in. Needed to determine several configurations on handling this command by its handler. As the command handler is not aware of the NatTable instance it is running in, and there is no kind of context, theIConfigRegistry
needs to be transported.increment
- Flag to determine whether the current value in the data model should be incremented or decremented.
-
TickUpdateCommand
protected TickUpdateCommand(TickUpdateCommand command)
Constructor that is used by local cloning operation.- Parameters:
command
- The command to create a new instance of.
-
-
Method Detail
-
cloneCommand
public TickUpdateCommand cloneCommand()
Description copied from interface:ILayerCommand
Same semantics asObject.clone()
Used to make a copies of the command if has to passed to different layer stacks.- Specified by:
cloneCommand
in interfaceILayerCommand
- Returns:
- a cloned instance of the command
- See Also:
GridLayer.doCommand(ILayerCommand)
-
convertToTargetLayer
public boolean convertToTargetLayer(ILayer targetLayer)
Description copied from interface:ILayerCommand
Convert the row/column coordinates the command might be carrying from the source layer to the destination (target) layer. If it is not possible to convert the command to the target layer, then this method will return false and the state of this command object will remain unchanged. Note: Commands should not be processed if they fail conversion.- Specified by:
convertToTargetLayer
in interfaceILayerCommand
- Parameters:
targetLayer
- the target layer- Returns:
- true if the command is valid after conversion, false if the command is no longer valid.
-
getConfigRegistry
public IConfigRegistry getConfigRegistry()
- Returns:
- The
IConfigRegistry
of the current NatTable instance this command is executed in. Needed to determine several configurations on handling this command by its handler. As the command handler is not aware of the NatTable instance it is running in, and there is no kind of context, theIConfigRegistry
needs to be transported.
-
isIncrement
public boolean isIncrement()
- Returns:
- Whether the current value in the data model should be incremented or decremented.
-
-