Class RevFocusSelectBehavior<BGS, BCS, SF>

constructor

• new RevFocusSelectBehavior<
      BGS extends RevBehavioredGridSettings,
      BCS extends RevBehavioredColumnSettings,
      SF extends RevSchemaField,
  >(
      clientId: string,
      internalParent: RevClientObject,
      _gridSettings: RevOnlyGridSettings,
      _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
  • _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

  Parameters

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

  Returns void

focusOnlySelectRectangle

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

  Parameters

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

  Returns void

focusReplaceLastArea

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

  Parameters

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

  Returns void

focusReplaceLastAreaWithRectangle

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

  Parameters

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

  Returns void

focusSelectCell

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

  Parameters

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

  Returns void

focusToggleSelectCell

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

  Parameters

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

  Returns boolean

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