GridNavigation
Mixin

Mixin for Grid that handles cell to cell navigation.

See Grid for more information on grid cell keyboard navigation.

Properties

Properties are getters/setters or publicly accessible variables on this class

cellCSSSelector : String

READONLY

CSS selector for currently focused cell. Format is "[data-index=index] [data-column-id=columnId]".
focusedCell : GridLocation

Grid GridLocation which encapsulates the currently focused cell. Set to focus a cell or use focusCell.
isActionableLocation : Boolean

READONLY

This property is true if an element within a cell is focused.
isGridNavigation : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of GridNavigation class, or subclass thereof.

Functions are methods available for calling on the class

focusCell( cellSelector, options )
: GridLocation

Navigates to a cell and/or its row (depending on selectionMode)

Triggers: navigate
internalNextPrevCell( nexttrue )
: Object

private

Selects the cell before or after currently focused cell.
internalNextPrevRow( next, skipSpecialRowstrue, moveToHeadertrue )
: GridLocation/Boolean

private

Selects the next or previous record in relation to the current selection. Scrolls into view if outside.
isFocused( cellSelector )
: Boolean

Checks whether a cell is focused.
navigateDown( )
: GridLocation

Navigates to the cell below the currently focused cell
navigateLeft( )
: GridLocation

Select the cell before the currently focused one.
navigateRight( )
: GridLocation

Select the cell after the currently focused one.
navigateUp( )
: GridLocation

Navigates to the cell above the currently focused cell
onGridBodyFocusIn( focusEvent )

private

This function handles focus moving into, or within the grid.
restoreActiveItem( activeItem )

internal

Sets the passed record as the current focused record for keyboard navigation and selection purposes. This API is used by Combo to activate items in its picker.

Events are triggered for certain actions in this class and can be listened for to react to those actions in your code

Event handlers are callbacks called as a result of certain actions in this class

Grid/view/mixin/GridNavigation.js