org.eclipse.nebula.widgets.nattable.command
Class StructuralRefreshCommand

java.lang.Object
  org.eclipse.nebula.widgets.nattable.command.StructuralRefreshCommand

All Implemented Interfaces:

ILayerCommand

public class StructuralRefreshCommand
extends Object
implements ILayerCommand

Command that triggers a StructuralRefreshEvent. To support refreshing of every layer in a NatTable the StructuralRefreshCommandHandler should be registered against the DataLayer.

Author:

Dirk Fauth

Constructor Summary

StructuralRefreshCommand()

Method Summary

ILayerCommand	cloneCommand() Same semantics as Object.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

StructuralRefreshCommand

public StructuralRefreshCommand()

Method Detail

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 interface ILayerCommand

Parameters:

targetLayer - the target layer

Returns:

true if the command is valid after conversion, false if the command is no longer valid.

cloneCommand

public ILayerCommand cloneCommand()

Description copied from interface: ILayerCommand

Same semantics as Object.clone() Used to make a copies of the command if has to passed to different layer stacks.

Specified by:

cloneCommand in interface ILayerCommand

Returns:

a cloned instance of the command

See Also:

GridLayer.doCommand(ILayerCommand)