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

Class FreezeSelectionCommand

java.lang.Object

org.eclipse.nebula.widgets.nattable.freeze.command.FreezeSelectionCommand

All Implemented Interfaces:

ILayerCommand, IFreezeCommand

public class FreezeSelectionCommand
extends Object
implements IFreezeCommand

Will inform the handler to use the selection layer for its freeze coordinates.

Constructor Summary

Constructors

Constructor	Description
FreezeSelectionCommand()	Creates a simple FreezeSelectionCommand that doesn't toggle or override a current frozen state.
FreezeSelectionCommand(boolean toggle)	Creates a FreezeSelectionCommand that doesn't override a current frozen state.
FreezeSelectionCommand(boolean toggle, boolean overrideFreeze)	Creates a FreezeSelectionCommand.
FreezeSelectionCommand(boolean toggle, boolean overrideFreeze, boolean include)	Creates a FreezeSelectionCommand.

Method Summary

Modifier and Type	Method	Description
FreezeSelectionCommand	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.
boolean	isInclude()
boolean	isOverrideFreeze()	Indicates whether this command should override a current frozen state or if it should be skipped if a frozen state is already applied.
boolean	isToggle()	Indicates whether this command should toggle the frozen state between frozen and unfrozen, or if it should always result in a frozen state.

Methods inherited from class java.lang.Object

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

Constructor Detail

FreezeSelectionCommand

public FreezeSelectionCommand()

Creates a simple FreezeSelectionCommand that doesn't toggle or override a current frozen state.

FreezeSelectionCommand

public FreezeSelectionCommand(boolean toggle)

Creates a FreezeSelectionCommand that doesn't override a current frozen state. If it should toggle the current frozen state can be specified by parameter.

Parameters:

toggle - whether this command should toggle the frozen state between frozen and unfrozen, or if it should always result in a frozen state.

FreezeSelectionCommand

public FreezeSelectionCommand(boolean toggle,
                              boolean overrideFreeze)

Creates a FreezeSelectionCommand. If it should toggle or override the current frozen state can be specified by parameter.

Parameters:

toggle - whether this command should toggle the frozen state between frozen and unfrozen, or if it should always result in a frozen state.

overrideFreeze - whether this command should override a current frozen state or if it should be skipped if a frozen state is already applied.

FreezeSelectionCommand

public FreezeSelectionCommand(boolean toggle,
                              boolean overrideFreeze,
                              boolean include)

Creates a FreezeSelectionCommand. If it should toggle or override the current frozen state can be specified by parameter.

Parameters:

toggle - whether this command should toggle the frozen state between frozen and unfrozen, or if it should always result in a frozen state.

overrideFreeze - whether this command should override a current frozen state or if it should be skipped if a frozen state is already applied.

include - whether the selected cell should be included in the freeze region or not. Include means the freeze borders will be to the right and bottom, while exclude means the freeze borders are to the left and top. Default is false.

Since:

1.6

Method Detail

isToggle

public boolean isToggle()

Description copied from interface: IFreezeCommand

Indicates whether this command should toggle the frozen state between frozen and unfrozen, or if it should always result in a frozen state.

Specified by:

isToggle in interface IFreezeCommand

Returns:

true if a frozen state should be unfrozen when it is tried to freeze again

isOverrideFreeze

public boolean isOverrideFreeze()

Description copied from interface: IFreezeCommand

Indicates whether this command should override a current frozen state or if it should be skipped if a frozen state is already applied.

Specified by:

isOverrideFreeze in interface IFreezeCommand

Returns:

true if a current freeze state should be overriden, false if a requested freeze should be skipped on a already frozen state.

isInclude

public boolean isInclude()

Returns:

Whether the selected cell should be included to the frozen region or not. Included means the freeze borders will be to the right and bottom, exclude means the freeze borders are to the top and left. Default is false.

Since:

1.6

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 FreezeSelectionCommand 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)