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

Class FreezeGridAction

java.lang.Object

org.eclipse.nebula.widgets.nattable.freeze.action.FreezeGridAction

All Implemented Interfaces:

IKeyAction

public class FreezeGridAction
extends Object
implements IKeyAction

IKeyAction that will execute a FreezeSelectionCommand with the specified parameters.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	run(NatTable natTable, org.eclipse.swt.events.KeyEvent event)

Methods inherited from class java.lang.Object

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

Constructor Detail

FreezeGridAction

public FreezeGridAction()

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

FreezeGridAction

public FreezeGridAction(boolean toggle)

Creates a FreezeGridAction 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.

FreezeGridAction

public FreezeGridAction(boolean toggle,
                        boolean overrideFreeze)

Creates a FreezeGridAction. 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. Note: Setting this value to true will override the toggle behaviour.

FreezeGridAction

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

Creates a FreezeGridAction. 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. Note: Setting this value to true will override the toggle behaviour.

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

run

public void run(NatTable natTable,
                org.eclipse.swt.events.KeyEvent event)

Specified by:

run in interface IKeyAction