Skip to content

FocusOrder

Description

Initializes the focus order manager with the merged cell getter and row and column index mappers used to navigate focus through merged regions.

Methods

buildFocusOrder

Source code

focusOrder.buildFocusOrder(selectedRanges)

Rebuilds the focus order list based on the provided selection.

ParamTypeDescription
selectedRangesArray<CellRange>The selected ranges to build the focus order for.

getCurrentHorizontalNode

Source code

focusOrder.getCurrentHorizontalNode() ⇒ NodeStructure

Gets the currently selected node data from the horizontal focus order list.

getCurrentVerticalNode

Source code

focusOrder.getCurrentVerticalNode() ⇒ NodeStructure

Gets the currently selected node data from the vertical focus order list.

getFirstHorizontalNode

Source code

focusOrder.getFirstHorizontalNode() ⇒ NodeStructure

Gets the first node data from the horizontal focus order list.

getFirstVerticalNode

Source code

focusOrder.getFirstVerticalNode() ⇒ NodeStructure

Gets the first node data from the vertical focus order list.

getNextHorizontalNode

Source code

focusOrder.getNextHorizontalNode() ⇒ FocusNodeData

Gets the next selected node data from the horizontal focus order list.

getNextVerticalNode

Source code

focusOrder.getNextVerticalNode() ⇒ FocusNodeData

Gets the next selected node data from the vertical focus order list.

getPrevHorizontalNode

Source code

focusOrder.getPrevHorizontalNode() ⇒ FocusNodeData

Gets the previous selected node data from the horizontal focus order list.

getPrevVerticalNode

Source code

focusOrder.getPrevVerticalNode() ⇒ FocusNodeData

Gets the previous selected node data from the vertical focus order list.

setActiveNode

Source code

focusOrder.setActiveNode(row, column, selectionLayerIndex) ⇒ FocusOrder

Sets the active node based on the provided row and column.

ParamTypeDescription
rownumberThe visual row index.
columnnumberThe visual column index.
selectionLayerIndexnumberThe index of the selection layer to which the focus should be marked as active.

setNextNodeAsActive

Source code

focusOrder.setNextNodeAsActive()

Sets the previous node from the horizontal focus order list as active.

setPrevNodeAsActive

Source code

focusOrder.setPrevNodeAsActive()

Sets the previous node from the vertical focus order list as active.