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

Class EditSelectionCommand

java.lang.Object

org.eclipse.nebula.widgets.nattable.command.AbstractContextFreeCommand

org.eclipse.nebula.widgets.nattable.edit.command.EditSelectionCommand

All Implemented Interfaces:

ILayerCommand

public class EditSelectionCommand
extends AbstractContextFreeCommand

Command that will trigger activating the edit mode for the current selection. The corresponding command handler is responsible for determining if activation should proceed because of race conditions like e.g. the cell is configured to be editable or another editor is active containing an invalid data.

Constructor Summary

Constructors

Constructor	Description
EditSelectionCommand(org.eclipse.swt.widgets.Composite parent, IConfigRegistry configRegistry)
EditSelectionCommand(org.eclipse.swt.widgets.Composite parent, IConfigRegistry configRegistry, boolean byTraversal)
EditSelectionCommand(org.eclipse.swt.widgets.Composite parent, IConfigRegistry configRegistry, Character character)
EditSelectionCommand(org.eclipse.swt.widgets.Composite parent, IConfigRegistry configRegistry, Character character, boolean byTraversal)

Method Summary

Modifier and Type	Method	Description
Character	getCharacter()
IConfigRegistry	getConfigRegistry()
org.eclipse.swt.widgets.Composite	getParent()
boolean	isByTraversal()

Methods inherited from class org.eclipse.nebula.widgets.nattable.command.AbstractContextFreeCommand

cloneCommand, convertToTargetLayer

Methods inherited from class java.lang.Object

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

Constructor Detail

EditSelectionCommand

public EditSelectionCommand(org.eclipse.swt.widgets.Composite parent,
                            IConfigRegistry configRegistry)

Parameters:

parent - The parent Composite, needed for the creation of the editor control.

configRegistry - The IConfigRegistry containing the configuration of the current NatTable instance the command should be executed for. This is necessary because the edit controllers in the current architecture are not aware of the instance they are running in.

EditSelectionCommand

public EditSelectionCommand(org.eclipse.swt.widgets.Composite parent,
                            IConfigRegistry configRegistry,
                            Character character)

Parameters:

parent - The parent Composite, needed for the creation of the editor control.

configRegistry - The IConfigRegistry containing the configuration of the current NatTable instance the command should be executed for. This is necessary because the edit controllers in the current architecture are not aware of the instance they are running in.

character - The Character represented by the key that was typed in case this command should be executed because of typing a letter or digit key. Can be null if this command should be executed because of a pressed control key (like F2) or a programmatical execution.

EditSelectionCommand

public EditSelectionCommand(org.eclipse.swt.widgets.Composite parent,
                            IConfigRegistry configRegistry,
                            boolean byTraversal)

EditSelectionCommand

public EditSelectionCommand(org.eclipse.swt.widgets.Composite parent,
                            IConfigRegistry configRegistry,
                            Character character,
                            boolean byTraversal)

Method Detail

getConfigRegistry

public IConfigRegistry getConfigRegistry()

Returns:

The IConfigRegistry containing the configuration of the current NatTable instance the command should be executed for.

getCharacter

public Character getCharacter()

Returns:

The Character represented by the key that was typed in case this command should be executed because of typing a letter or digit key. Can be null if this command should be executed because of a pressed control key (like F2) or a programmatical execution.

getParent

public org.eclipse.swt.widgets.Composite getParent()

Returns:

The parent Composite, needed for the creation of the editor control.

isByTraversal

public boolean isByTraversal()

Returns:

true if this command was triggered by traversal, false if it was triggered otherwise (e.g. pressing F2)