PlutoGridShortcutAction class abstract

Define the action by implementing the execute method as an action that can be mapped to a shortcut key.

User-defined behavior other than the default implemented class can be implemented by extending this class.

PlutoGridActionMoveCellFocus Move the current cell focus in the direction direction.

If the current cell is not selected, focus the first cell.

If PlutoGridConfiguration.enableMoveHorizontalInEditing is true, Moves to the previous or next cell when the text cursor reaches the left or right edge while the cell is in edit state.

PlutoGridActionMoveSelectedCellFocus Moves the selected focus in the direction direction in the cell or row selection state.

PlutoGridActionMoveCellFocusByPage Move the focus of the current cell page by page.

If direction is up or down, it moves in the vertical direction on the current page.

If direction is left or right, the page moves when pagination is enabled. If pagination is not enabled, no action is taken.

PlutoGridActionMoveSelectedCellFocusByPage Moves the selection position page by page in cell or row selection mode.

When direction is left or right, no action is taken.

PlutoGridActionDefaultTab This is the action in which the default action of the tab key is set.

If there is no currently focused cell, focus the first cell.

Move the focus to the previous or next cell with the shift key combination.

If PlutoGridConfiguration.tabKeyAction is moveToNextOnEdge , continue moving focus to the next or previous row when focus reaches the end.

PlutoGridActionDefaultEnterKey This action is the default action of the Enter key.

If PlutoGrid.mode is in selection mode, the PlutoGrid.onSelected callback that returns information of the currently selected row is called.

Otherwise, it behaves according to PlutoGridConfiguration.enterKeyAction.

PlutoGridActionDefaultEscapeKey This is the action in which the default behavior of the Escape key is set.

If PlutoGridMode is in selection or popup mode, call the PlutoGrid.onSelected callback, which returns a PlutoGridOnSelectedEvent with a null value meaning unselected.

In other cases, it cancels the currently edited cell.

PlutoGridActionMoveCellFocusToEdge Move the focus of the current cell to the end of the direction direction.

PlutoGridActionMoveSelectedCellFocusToEdge Moves the selected focus to the end of the direction direction in the cell or row selection state.

PlutoGridActionSetEditing Set the current cell to edit state.

PlutoGridActionFocusToColumnFilter Move the focus from the current cell position to the filtering TextField of the corresponding column.

PlutoGridActionToggleColumnSort Toggles the sort state of the column.

PlutoGridActionCopyValues Copies the value of the current cell or the selected cell or row to the clipboard.

PlutoGridActionPasteValues Pastes the copied values to the clipboard depending on the position of the current cell or row.

PlutoGridActionSelectAll Select all cells or rows.

Implementers

• PlutoGridActionCopyValues
• PlutoGridActionDefaultEnterKey
• PlutoGridActionDefaultEscapeKey
• PlutoGridActionDefaultTab
• PlutoGridActionFocusToColumnFilter
• PlutoGridActionMoveCellFocus
• PlutoGridActionMoveCellFocusByPage
• PlutoGridActionMoveCellFocusToEdge
• PlutoGridActionMoveSelectedCellFocus
• PlutoGridActionMoveSelectedCellFocusByPage
• PlutoGridActionMoveSelectedCellFocusToEdge
• PlutoGridActionPasteValues
• PlutoGridActionSelectAll
• PlutoGridActionSetEditing
• PlutoGridActionToggleColumnSort

Constructors

PlutoGridShortcutAction()

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

execute({required PlutoKeyManagerEvent keyEvent, required PlutoGridStateManager stateManager}) → void

Implement actions to be mapped to shortcut keys.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited