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

Class EditUtils

java.lang.Object

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

public class EditUtils
extends Object

Helper class for retrieving information regarding editing of selected cells.

Constructor Summary

Constructors

Constructor and Description
EditUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	allCellsEditable(SelectionLayer selectionLayer, IConfigRegistry configRegistry) For every cell that is selected it is checked whether the cell is editable or not.
static boolean	commitAndCloseActiveEditor() Checks if there is an active editor registered.
static ILayerCell	getLastSelectedCell(SelectionLayer selectionLayer)
static ICellEditor	getLastSelectedCellEditor(SelectionLayer selectionLayer, IConfigRegistry configRegistry)
static boolean	isCellEditable(SelectionLayer selectionLayer, IConfigRegistry configRegistry, PositionCoordinate cellCoords) Checks if the cell at the specified coordinates is editable or not.
static boolean	isConverterSame(SelectionLayer selectionLayer, IConfigRegistry configRegistry) Checks if all selected cells have the same IDisplayConverter configured.
static boolean	isEditorSame(SelectionLayer selectionLayer, IConfigRegistry configRegistry) Checks if all selected cells have the same ICellEditor configured.
static boolean	isValueSame(SelectionLayer selectionLayer) Checks if all selected cells contain the same canonical value.

Methods inherited from class java.lang.Object

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

Constructor Detail

EditUtils

public EditUtils()

Method Detail

getLastSelectedCell

public static ILayerCell getLastSelectedCell(SelectionLayer selectionLayer)

Parameters:

selectionLayer - The SelectionLayer to retrieve the current selection from.

Returns:

The last cell of the current selection in the specified SelectionLayer. Will return null if there is no selection.

getLastSelectedCellEditor

public static ICellEditor getLastSelectedCellEditor(SelectionLayer selectionLayer,
                                    IConfigRegistry configRegistry)

Parameters:

selectionLayer - The SelectionLayer to retrieve the current selection from.

configRegistry - The IConfigRegistry needed to access the configured ICellEditor.

Returns:

The ICellEditor of the last cell of the current selection in the specified SelectionLayer. Will return null if there is no selection.

allCellsEditable

public static boolean allCellsEditable(SelectionLayer selectionLayer,
                       IConfigRegistry configRegistry)

For every cell that is selected it is checked whether the cell is editable or not.

Parameters:

selectionLayer - The SelectionLayer to retrieve the current selection.

configRegistry - The IConfigRegistry needed to access the configured IEditableRules.

Returns:

true if all selected cells are editable, false if at least one cell is not editable.

isCellEditable

public static boolean isCellEditable(SelectionLayer selectionLayer,
                     IConfigRegistry configRegistry,
                     PositionCoordinate cellCoords)

Checks if the cell at the specified coordinates is editable or not.

Note: The coordinates need to be related to the given SelectionLayer, otherwise the wrong cell will be used for the check.

Parameters:

selectionLayer - The SelectionLayer to check the cell coordinates against.

configRegistry - The IConfigRegistry needed to access the configured IEditableRules.

cellCoords - The coordinates of the cell to check the editable state, related to the given SelectionLayer

Returns:

true if the cell is editable, false if not

isEditorSame

public static boolean isEditorSame(SelectionLayer selectionLayer,
                   IConfigRegistry configRegistry)

Checks if all selected cells have the same ICellEditor configured. This is needed for the multi edit feature to determine if a multi edit is possible.

Parameters:

selectionLayer - The SelectionLayer to retrieve the current selection.

configRegistry - The IConfigRegistry needed to access the configured ICellEditors.

Returns:

true if all selected cells have the same ICellEditor configured, false if at least one cell has another ICellEditor configured.

isConverterSame

public static boolean isConverterSame(SelectionLayer selectionLayer,
                      IConfigRegistry configRegistry)

Checks if all selected cells have the same IDisplayConverter configured. This is needed for the multi edit feature to determine if a multi edit is possible.

Let's assume there are two columns, one containing an Integer, the other a Date. Both have a TextCellEditor configured, so if only the editor is checked, the multi edit dialog would open. On committing a changed value an error would occur because of wrong conversion.

Parameters:

selectionLayer - The SelectionLayer to retrieve the current selection.

configRegistry - The IConfigRegistry needed to access the configured IDisplayConverters.

Returns:

true if all selected cells have the same IDisplayConverter configured, false if at least one cell has another IDisplayConverter configured.

isValueSame

public static boolean isValueSame(SelectionLayer selectionLayer)

Checks if all selected cells contain the same canonical value. This is needed for multi edit to know if the editor should be initialised with the value that is shared amongst all cells.

Parameters:

selectionLayer - The SelectionLayer to retrieve the current selection.

Returns:

true if all cells contain the same value, false if at least one cell contains another value.

commitAndCloseActiveEditor

public static boolean commitAndCloseActiveEditor()

Checks if there is an active editor registered. If there is one, it is tried to commit the value that is currently entered there.

Returns:

false if there is an open editor that can not be committed because of conversion/validation errors, true if there is no active open editor or it could be closed after committing the value.