Class RevFocusSelectBehavior<BGS, BCS, SF>

constructor

• new RevFocusSelectBehavior<
      BGS extends RevBehavioredGridSettings,
      BCS extends RevBehavioredColumnSettings,
      SF extends RevSchemaField,
  >(
      clientId: string,
      internalParent: RevClientObject,
      _gridSettings: RevOnlyGridSettings,
      _columnsManager: RevColumnsManager<BCS, SF>,
      _selection: RevSelection<BGS, BCS, SF>,
      _focus: RevFocus<BGS, BCS, SF>,
      _viewLayout: RevViewLayout<BGS, BCS, SF>,
  ): RevFocusSelectBehavior<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>
  • _selection: RevSelection<BGS, BCS, SF>
  • _focus: RevFocus<BGS, BCS, SF>
  • _viewLayout: RevViewLayout<BGS, BCS, SF>

  Returns RevFocusSelectBehavior<BGS, BCS, SF>

ReadonlyclientId

ReadonlyinternalParent

focusOnlySelectCell

• focusOnlySelectCell(
      activeColumnIndex: number,
      subgridRowIndex: number,
      subgrid: RevSubgrid<BCS, SF>,
      ensureFullyInView: "Never" | "IfNotVisible" | "Always",
  ): void

  Select only a single cell and try to focus it. If focused, ensure it is in view.

  Parameters

  • activeColumnIndex: number
  • subgridRowIndex: number
  • subgrid: RevSubgrid<BCS, SF>
  • ensureFullyInView: "Never" | "IfNotVisible" | "Always"

  Returns void

focusOnlySelectColumn

• focusOnlySelectColumn(
      activeColumnIndex: number,
      ensureFullyInView: "Never" | "IfNotVisible" | "Always",
  ): void

  Parameters

  • activeColumnIndex: number
  • ensureFullyInView: "Never" | "IfNotVisible" | "Always"

  Returns void

focusOnlySelectRectangle

• focusOnlySelectRectangle(
      leftOrExRightActiveColumnIndex: number,
      topOrExBottomSubgridRowIndex: number,
      width: number,
      height: number,
      subgrid: RevSubgrid<BCS, SF>,
      ensureFullyInView: "Never" | "IfNotVisible" | "Always",
  ): void

  Parameters

  • leftOrExRightActiveColumnIndex: number
  • topOrExBottomSubgridRowIndex: number
  • width: number
  • height: number
  • subgrid: RevSubgrid<BCS, SF>
  • ensureFullyInView: "Never" | "IfNotVisible" | "Always"

  Returns void

focusOnlySelectRow

• focusOnlySelectRow(
      subgridRowIndex: number,
      subgrid: RevSubgrid<BCS, SF>,
      ensureFullyInView: "Never" | "IfNotVisible" | "Always",
  ): void

  Parameters

  • subgridRowIndex: number
  • subgrid: RevSubgrid<BCS, SF>
  • ensureFullyInView: "Never" | "IfNotVisible" | "Always"

  Returns void

focusReplaceLastArea

• focusReplaceLastArea(
      areaTypeId: RevSelectionAreaTypeId,
      leftOrExRightActiveColumnIndex: number,
      topOrExBottomSubgridRowIndex: number,
      width: number,
      height: number,
      subgrid: RevSubgrid<BCS, SF>,
      ensureFullyInView: "Never" | "IfNotVisible" | "Always",
  ): void

  Parameters

  • areaTypeId: RevSelectionAreaTypeId
  • leftOrExRightActiveColumnIndex: number
  • topOrExBottomSubgridRowIndex: number
  • width: number
  • height: number
  • subgrid: RevSubgrid<BCS, SF>
  • ensureFullyInView: "Never" | "IfNotVisible" | "Always"

  Returns void

focusReplaceLastAreaWithRectangle

• focusReplaceLastAreaWithRectangle(
      leftOrExRightActiveColumnIndex: number,
      topOrExBottomSubgridRowIndex: number,
      width: number,
      height: number,
      subgrid: RevSubgrid<BCS, SF>,
      ensureFullyInView: "Never" | "IfNotVisible" | "Always",
  ): void

  Parameters

  • leftOrExRightActiveColumnIndex: number
  • topOrExBottomSubgridRowIndex: number
  • width: number
  • height: number
  • subgrid: RevSubgrid<BCS, SF>
  • ensureFullyInView: "Never" | "IfNotVisible" | "Always"

  Returns void

focusSelectCell

• focusSelectCell(
      activeColumnIndex: number,
      subgridRowIndex: number,
      subgrid: RevSubgrid<BCS, SF>,
      ensureFullyInView: "Never" | "IfNotVisible" | "Always",
  ): void

  Parameters

  • activeColumnIndex: number
  • subgridRowIndex: number
  • subgrid: RevSubgrid<BCS, SF>
  • ensureFullyInView: "Never" | "IfNotVisible" | "Always"

  Returns void

focusToggleSelectCell

• focusToggleSelectCell(
      activeColumnIndex: number,
      subgridRowIndex: number,
      subgrid: RevSubgrid<BCS, SF>,
      ensureFullyInView: "Never" | "IfNotVisible" | "Always",
  ): boolean

  Toggles the selection state of a cell at the specified coordinates and attempts to set focus to it. If the cell becomes selected and focus is successfully set, optionally ensures the cell is fully visible in the view. Also flags the selection as focus-linked if focus is set.

  Parameters

  • activeColumnIndex: number

    The active column index of the cell.
  • subgridRowIndex: number

    The row index within the subgrid of the cell.
  • subgrid: RevSubgrid<BCS, SF>

    The subgrid containing the cell.
  • ensureFullyInView: "Never" | "IfNotVisible" | "Always"

    Specifies whether to scroll to ensure the cell is visible in the view.

  Returns boolean

  true if the cell is selected after toggling; otherwise, false.

isMouseAddToggleExtendSelectionAreaAllowed

• isMouseAddToggleExtendSelectionAreaAllowed(event: MouseEvent): boolean

  Parameters

  • event: MouseEvent

  Returns boolean

onlySelectColumn

• onlySelectColumn(activeColumnIndex: number): void

  Parameters

  • activeColumnIndex: number

  Returns void

onlySelectColumns

• onlySelectColumns(activeColumnIndex: number, count: number): void

  Parameters

  • activeColumnIndex: number
  • count: number

  Returns void

onlySelectRow

• onlySelectRow(subgridRowIndex: number, subgrid: RevSubgrid<BCS, SF>): void

  Parameters

  • subgridRowIndex: number
  • subgrid: RevSubgrid<BCS, SF>

  Returns void

onlySelectRows

• onlySelectRows(
      subgridRowIndex: number,
      count: number,
      subgrid: RevSubgrid<BCS, SF>,
  ): void

  Parameters

  • subgridRowIndex: number
  • count: number
  • subgrid: RevSubgrid<BCS, SF>

  Returns void

onlySelectViewCell

• onlySelectViewCell(
      viewLayoutColumnIndex: number,
      viewLayoutRowIndex: number,
  ): void

  Parameters

  • viewLayoutColumnIndex: number
  • viewLayoutRowIndex: number

  Returns void

selectAllRows

• selectAllRows(subgrid: RevSubgrid<BCS, SF>): void

  Parameters

  • subgrid: RevSubgrid<BCS, SF>

  Returns void

selectColumn

• selectColumn(activeColumnIndex: number): void

  Parameters

  • activeColumnIndex: number

  Returns void

selectColumns

• selectColumns(activeColumnIndex: number, count: number): void

  Parameters

  • activeColumnIndex: number
  • count: number

  Returns void

selectRow

• selectRow(subgridRowIndex: number, subgrid: RevSubgrid<BCS, SF>): void

  Parameters

  • subgridRowIndex: number
  • subgrid: RevSubgrid<BCS, SF>

  Returns void

selectRows

• selectRows(
      subgridRowIndex: number,
      count: number,
      subgrid: RevSubgrid<BCS, SF>,
  ): void

  Parameters

  • subgridRowIndex: number
  • count: number
  • subgrid: RevSubgrid<BCS, SF>

  Returns void

toggleSelectColumn

• toggleSelectColumn(activeColumnIndex: number): void

  Parameters

  • activeColumnIndex: number

  Returns void

toggleSelectRow

• toggleSelectRow(subgridRowIndex: number, subgrid: RevSubgrid<BCS, SF>): void

  Parameters

  • subgridRowIndex: number
  • subgrid: RevSubgrid<BCS, SF>

  Returns void

tryExtendLastSelectionAreaAsCloseAsPossibleToFocus

• tryExtendLastSelectionAreaAsCloseAsPossibleToFocus(): boolean

  Returns boolean

tryOnlySelectFocusedCell

• tryOnlySelectFocusedCell(): boolean

  Returns boolean