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

Class ColumnGroupExpandCollapseAction

java.lang.Object

org.eclipse.nebula.widgets.nattable.group.action.ColumnGroupExpandCollapseAction

All Implemented Interfaces:

IMouseAction, IMouseClickAction

public class ColumnGroupExpandCollapseAction
extends Object
implements IMouseClickAction

Constructor Summary

Constructors

Constructor	Description
ColumnGroupExpandCollapseAction()	Creates a non-exclusive ColumnGroupExpandCollapseAction.
ColumnGroupExpandCollapseAction(boolean exclusive)

Method Summary

Modifier and Type	Method	Description
boolean	isExclusive()	Configuration of this IMouseClickAction to specify the behaviour when this action is configured to be a single click action, and there is also a double click action registered.
void	run(NatTable natTable, org.eclipse.swt.events.MouseEvent event)	Translates the SWT MouseEvent to a NatTable command and executes that command accordingly.

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnGroupExpandCollapseAction

public ColumnGroupExpandCollapseAction()

Creates a non-exclusive ColumnGroupExpandCollapseAction.

ColumnGroupExpandCollapseAction

public ColumnGroupExpandCollapseAction(boolean exclusive)

Parameters:

exclusive - true if the expand action should be exclusive, which means the action to select the columns is not triggered. If set to false the selection will be triggered together with the expand/collapse action.

Since:

1.6

Method Detail

run

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

Description copied from interface: IMouseAction

Translates the SWT MouseEvent to a NatTable command and executes that command accordingly.

Specified by:

run in interface IMouseAction

Parameters:

natTable - The NatTable instance on which the MouseEvent was fired and on which the command should be executed.

event - The received MouseEvent.

isExclusive

public boolean isExclusive()

Description copied from interface: IMouseClickAction

Configuration of this IMouseClickAction to specify the behaviour when this action is configured to be a single click action, and there is also a double click action registered.

If this method returns true, this means either the single OR the double click action is executed. Returning false will execute the single click action immediately and the double click action additionally.

Note: Being an exclusive action means that the double click action will be executed and the single click action will be cancelled. This also means that the single click action will not be performed until the double click action time is waited.

Specified by:

isExclusive in interface IMouseClickAction

Returns:

true if this action is exclusive, false if not.