org.uberfire.ext.wires.core.grids.client.widget.grid.impl

Class BaseKeyboardOperation

java.lang.Object

org.uberfire.ext.wires.core.grids.client.widget.grid.impl.BaseKeyboardOperation

All Implemented Interfaces:

KeyboardOperation

Direct Known Subclasses:

KeyboardOperationClearCell, KeyboardOperationEditCell, KeyboardOperationInvokeContextMenuForSelectedCell, KeyboardOperationMove, KeyboardOperationSelectBottomRightCell, KeyboardOperationSelectTopLeftCell

public abstract class BaseKeyboardOperation
extends Object
implements KeyboardOperation

Nested Class Summary

Nested classes/interfaces inherited from interface org.uberfire.ext.wires.core.grids.client.widget.grid.impl.KeyboardOperation

KeyboardOperation.TriStateBoolean

Field Summary

Fields

Modifier and Type	Field and Description
protected GridLayer	gridLayer

Constructor Summary

Constructors

Constructor and Description
BaseKeyboardOperation(GridLayer gridLayer)

Method Summary

Modifier and Type	Method and Description
protected GridData.SelectedCell	getSelectedCellOrigin(GridData gridModel, boolean isHeaderCellSelected) It retrieves the selected cell in GridData model, which could be an header cell or a simple one.
KeyboardOperation.TriStateBoolean	isControlKeyDown() Gets the control-key state that this operation matches.
boolean	isExecutable(GridWidget gridWidget) Decides about @link{GridWidget} state for execution of the operation.
KeyboardOperation.TriStateBoolean	isShiftKeyDown() Gets the shift-key state that this operation matches.
protected boolean	scrollSelectedCellIntoView(GridWidget gridWidget)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.uberfire.ext.wires.core.grids.client.widget.grid.impl.KeyboardOperation

getKeyCode, perform

Field Detail

gridLayer

protected GridLayer gridLayer

Constructor Detail

BaseKeyboardOperation

public BaseKeyboardOperation(GridLayer gridLayer)

Method Detail

isShiftKeyDown

public KeyboardOperation.TriStateBoolean isShiftKeyDown()

Description copied from interface: KeyboardOperation

Gets the shift-key state that this operation matches.

Specified by:

isShiftKeyDown in interface KeyboardOperation

Returns:

true if the shift-key is down.

isControlKeyDown

public KeyboardOperation.TriStateBoolean isControlKeyDown()

Description copied from interface: KeyboardOperation

Gets the control-key state that this operation matches.

Specified by:

isControlKeyDown in interface KeyboardOperation

Returns:

true if the control-key is down.

isExecutable

public boolean isExecutable(GridWidget gridWidget)

Description copied from interface: KeyboardOperation

Decides about @link{GridWidget} state for execution of the operation. By implementing this @link(BaseGridWidgetKeyboardHandler} will know which registered operations can be executed.

Specified by:

isExecutable in interface KeyboardOperation

Parameters:

gridWidget - The GridWidget on which to perform the operation.

Returns:

true if the gridWidget is in an appropriate state, false otherwise

scrollSelectedCellIntoView

protected boolean scrollSelectedCellIntoView(GridWidget gridWidget)

getSelectedCellOrigin

protected GridData.SelectedCell getSelectedCellOrigin(GridData gridModel,
                                                      boolean isHeaderCellSelected)

It retrieves the selected cell in GridData model, which could be an header cell or a simple one. In case of an header cell, it manages a possible case where a cell is spanned over multiple columns: when pressing KEY_RIGHT, it selected the last cell of the selected header cells group in order to show all the spanned cell. The otherwise in all other cases

Parameters:

gridModel -

isHeaderCellSelected -

Returns: