Class FreezeRowCommand
- java.lang.Object
-
- org.eclipse.nebula.widgets.nattable.command.AbstractRowCommand
-
- org.eclipse.nebula.widgets.nattable.freeze.command.FreezeRowCommand
-
- All Implemented Interfaces:
ILayerCommand
,IFreezeCommand
public class FreezeRowCommand extends AbstractRowCommand implements IFreezeCommand
Command that can be used to freeze a grid for whole rows.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
FreezeRowCommand(FreezeRowCommand command)
Constructor used for cloning the command.FreezeRowCommand(ILayer layer, int rowPosition)
Creates a FreezeRowCommand for the given row position related to the given layer, that doesn't toggle or override a current frozen state.FreezeRowCommand(ILayer layer, int rowPosition, boolean toggle)
Creates a FreezeRowCommand for the given row position related to the given layer, that doesn't override a current frozen state.FreezeRowCommand(ILayer layer, int rowPosition, boolean toggle, boolean overrideFreeze)
Creates a FreezeRowCommand for the given row position related to the given layer.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ILayerCommand
cloneCommand()
Same semantics asObject.clone()
Used to make a copies of the command if has to passed to different layer stacks.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 org.eclipse.nebula.widgets.nattable.command.AbstractRowCommand
convertToTargetLayer, getLayer, getRowPosition, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.nebula.widgets.nattable.command.ILayerCommand
convertToTargetLayer
-
-
-
-
Constructor Detail
-
FreezeRowCommand
public FreezeRowCommand(ILayer layer, int rowPosition)
Creates a FreezeRowCommand for the given row position related to the given layer, that doesn't toggle or override a current frozen state.- Parameters:
layer
- The layer to which the row position matches.rowPosition
- The row position that will be the bottom row in the frozen part.
-
FreezeRowCommand
public FreezeRowCommand(ILayer layer, int rowPosition, boolean toggle)
Creates a FreezeRowCommand for the given row position related to the given layer, that doesn't override a current frozen state. If it should toggle the current frozen state can be specified by parameter.- Parameters:
layer
- The layer to which the row position matches.rowPosition
- The row position that will be the bottom row in the frozen part.toggle
- whether this command should toggle the frozen state between frozen and unfrozen, or if it should always result in a frozen state.
-
FreezeRowCommand
public FreezeRowCommand(ILayer layer, int rowPosition, boolean toggle, boolean overrideFreeze)
Creates a FreezeRowCommand for the given row position related to the given layer. If it should toggle or override the current frozen state can be specified by parameter.- Parameters:
layer
- The layer to which the row position matches.rowPosition
- The row position that will be the bottom row in the frozen part.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.
-
FreezeRowCommand
protected FreezeRowCommand(FreezeRowCommand command)
Constructor used for cloning the command.- Parameters:
command
- The command which is the base for the new cloned instance.
-
-
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 interfaceIFreezeCommand
- 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 interfaceIFreezeCommand
- Returns:
true
if a current freeze state should be overriden,false
if a requested freeze should be skipped on a already frozen state.
-
cloneCommand
public ILayerCommand 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)
-
-