Class RevFocusScrollBehavior<BGS, BCS, SF>

The major classes in RevClient implement this interface to assist with debugging.

Type Parameters

Implements

RevClientObject

Constructors

constructor

new RevFocusScrollBehavior<
    BGS extends RevBehavioredGridSettings,
    BCS extends RevBehavioredColumnSettings,
    SF extends RevSchemaField,
>(
    clientId: string,
    internalParent: RevClientObject,
    _gridSettings: RevOnlyGridSettings,
    _columnsManager: RevColumnsManager<BCS, SF>,
    _subgridsManager: RevSubgridsManager<BCS, SF>,
    _viewLayout: RevViewLayout<BGS, BCS, SF>,
    _focus: RevFocus<BGS, BCS, SF>,
): RevFocusScrollBehavior<BGS, BCS, SF>
Type Parameters
- BGS extends RevBehavioredGridSettings
- BCS extends RevBehavioredColumnSettings
- SF extends RevSchemaField
Parameters
- clientId: string
- internalParent: RevClientObject
- _gridSettings: RevOnlyGridSettings
- _columnsManager: RevColumnsManager<BCS, SF>
- _subgridsManager: RevSubgridsManager<BCS, SF>
- _viewLayout: RevViewLayout<BGS, BCS, SF>
- _focus: RevFocus<BGS, BCS, SF>
Returns RevFocusScrollBehavior<BGS, BCS, SF>

Properties

`Readonly`clientId

clientId: string

A unique string allowing you to identify different instances

`Readonly`internalParent

internalParent: RevClientObject

The parent of an object allowing you to easily navigate during debugging

Methods

scrollBottom

scrollBottom(): boolean
Returns boolean

scrollFirstColumn

scrollFirstColumn(): boolean
Returns boolean

scrollLastColumn

scrollLastColumn(): boolean
Returns boolean

scrollTop

scrollTop(): boolean
Returns boolean

tryFocusBottom

tryFocusBottom(): boolean
Returns boolean

tryFocusFirstColumn

tryFocusFirstColumn(): boolean
Returns boolean

tryFocusLastColumn

tryFocusLastColumn(): boolean
Returns boolean

tryFocusTop

tryFocusTop(): boolean
Returns boolean

tryFocusXAndEnsureInView

tryFocusXAndEnsureInView(x: number): boolean
Parameters
- x: number
Returns boolean

tryFocusXYAndEnsureInView

tryFocusXYAndEnsureInView(
    x: number,
    y: number,
    cell: undefined | RevViewCell<BCS, SF>,
): boolean
Parameters
- x: number
- y: number
- cell: undefined | RevViewCell<BCS, SF>
Returns boolean

tryFocusYAndEnsureInView

tryFocusYAndEnsureInView(y: number): boolean
Parameters
- y: number
Returns boolean

tryMoveFocusDown

tryMoveFocusDown(): boolean
Returns boolean

tryMoveFocusLeft

tryMoveFocusLeft(): boolean
Returns boolean

tryMoveFocusRight

tryMoveFocusRight(): boolean
Returns boolean

tryMoveFocusUp

tryMoveFocusUp(): boolean
Returns boolean

tryPageFocusDown

tryPageFocusDown(): boolean
Returns boolean

tryPageFocusLeft

tryPageFocusLeft(): boolean
Returns boolean

tryPageFocusRight

tryPageFocusRight(): boolean
Returns boolean

tryPageFocusUp

tryPageFocusUp(): boolean
Returns boolean

tryScrollDown

tryScrollDown(): boolean
Returns boolean

tryScrollLeft

tryScrollLeft(): boolean
Returns boolean

tryScrollPageDown

tryScrollPageDown(): boolean
Returns boolean

tryScrollPageLeft

tryScrollPageLeft(): boolean
Returns boolean

tryScrollPageRight

tryScrollPageRight(): boolean
Returns boolean

tryScrollPageUp

tryScrollPageUp(): boolean
Returns boolean

tryScrollRight

tryScrollRight(): boolean
Returns boolean

tryScrollUp

tryScrollUp(): boolean
Returns boolean

tryStepScroll

tryStepScroll(
directionCanvasOffsetX: number,
directionCanvasOffsetY: number,
): boolean
Scroll down one full page.
Parameters
- directionCanvasOffsetX: number
- directionCanvasOffsetY: number
Returns boolean

tryStepScrollColumn

tryStepScrollColumn(directionCanvasOffsetX: number): boolean
Parameters
- directionCanvasOffsetX: number
Returns boolean

tryStepScrollRow

tryStepScrollRow(directionCanvasOffsetY: number): boolean
Parameters
- directionCanvasOffsetY: number
Returns boolean