Class RevStandardInputElementCellEditor<BGS, BCS, SF>`Abstract`

Type Parameters

Hierarchy (View Summary)

RevStandardElementCellEditor<BGS, BCS, SF>
- RevStandardInputElementCellEditor

Index

Constructors

Properties

cellClosedEventer keyDownEventer

Accessors

Methods

closeCell focus processGridKeyDownEvent selectAll setBounds setReadonly tryOpenCell

Constructors

constructor

new RevStandardInputElementCellEditor<
    BGS extends RevBehavioredGridSettings,
    BCS extends RevBehavioredColumnSettings,
    SF extends RevSchemaField,
>(
    grid: RevClientGrid<BGS, BCS, SF>,
    dataServer: RevDataServer<SF>,
    inputType: string,
): RevStandardInputElementCellEditor<BGS, BCS, SF>
Type Parameters
- BGS extends RevBehavioredGridSettings
- BCS extends RevBehavioredColumnSettings
- SF extends RevSchemaField
Parameters
- grid: RevClientGrid<BGS, BCS, SF>
- dataServer: RevDataServer<SF>
- inputType: string
Returns RevStandardInputElementCellEditor<BGS, BCS, SF>
Overrides RevStandardElementCellEditor.constructor

Properties

cellClosedEventer

cellClosedEventer: CellClosedEventer

Editor can optionally use this eventer to notify Grid that it has completed

keyDownEventer

keyDownEventer: KeyDownEventer

Accessors

readonly

get readonly(): boolean
Indicates if editor can only display data

Returns boolean
Inherited from RevStandardElementCellEditor.readonly
set readonly(value: boolean): void
Indicates if editor can only display data
Parameters
- value: boolean
Returns void
Inherited from RevStandardElementCellEditor.readonly

Methods

closeCell

closeCell(field: SF, subgridRowIndex: number, cancel: boolean): void
Close the editor - returns data that was in editor or undefined if cancel specified
Parameters
- field: SF
- subgridRowIndex: number
- cancel: boolean
Returns void
Overrides RevStandardElementCellEditor.closeCell

focus

focus(): void
Returns void
Inherited from RevStandardElementCellEditor.focus

processGridKeyDownEvent

processGridKeyDownEvent(
    event: KeyboardEvent,
    fromEditor: boolean,
    _schemaColumn: SF,
    _subgridRowIndex: number,
): boolean
See if the editor wants the key down event. If fromEditor is true, then this editor generated the event in the first place
Parameters
- event: KeyboardEvent
- fromEditor: boolean
- _schemaColumn: SF
- _subgridRowIndex: number
Returns boolean
Overrides RevStandardElementCellEditor.processGridKeyDownEvent

selectAll

selectAll(): void
Returns void

setBounds

setBounds(bounds: undefined | RevRectangle): void
Parameters
- bounds: undefined | RevRectangle
Returns void
Inherited from RevStandardElementCellEditor.setBounds

setReadonly

setReadonly(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides RevStandardElementCellEditor.setReadonly

tryOpenCell

tryOpenCell(
    viewCell: RevViewCell<BCS, SF>,
    openingKeyDownEvent: undefined | KeyboardEvent,
    openingClickEvent: undefined | MouseEvent,
): boolean
Provide the initial data to the editor. This is done after all events have been subscribed to - so editor can start running
Parameters
- viewCell: RevViewCell<BCS, SF>
- openingKeyDownEvent: undefined | KeyboardEvent
- openingClickEvent: undefined | MouseEvent
Returns boolean
Overrides RevStandardElementCellEditor.tryOpenCell