Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AccessibleMapComponent

Base class for accessible components

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

_map

_map: Map

The map instance.

app

app: ViewerApplication

The {@link geocortex.essentialsHtmlViewer.ViewerApplication} that this Draw toolbar instance belongs to.

id

id: string

inputMethod

inputMethod: string

The mode the component is running - e.g. mouse, keyboard

isKeyboardActive

isKeyboardActive: boolean

suspended

suspended: boolean

Methods

Protected _onKeyDown

  • _onKeyDown(event: KeyboardEvent): void

  • Internal method that subclasses should override to provide keyboard handling.

    Parameters

    • event: KeyboardEvent

    Returns void

Protected _onKeyUp

  • _onKeyUp(event: KeyboardEvent): void

  • Internal method that subclasses should override to provide keyboard handling.

    Parameters

    • event: KeyboardEvent

    Returns void

activateKeyboardControls

  • activateKeyboardControls(resetInputMode?: boolean): void

  • Parameters

    • Optional resetInputMode: boolean

    Returns void

activateMouseControls

  • activateMouseControls(resetInputMethod?: boolean): void

  • Parameters

    • Optional resetInputMethod: boolean

    Returns void

deactivateKeyboardControls

  • deactivateKeyboardControls(resetInputMethod?: boolean): void

  • Parameters

    • Optional resetInputMethod: boolean

    Returns void

deactivateMouseControls

  • deactivateMouseControls(resetInputMethod?: boolean): void

  • Parameters

    • Optional resetInputMethod: boolean

    Returns void

disableMapNavigation

  • disableMapNavigation(hideZoomSlider?: boolean, hidePanArrows?: boolean, disableGraphicMouseEvents?: boolean): MapNavigationState

  • Parameters

    • Optional hideZoomSlider: boolean
    • Optional hidePanArrows: boolean
    • Optional disableGraphicMouseEvents: boolean

    Returns MapNavigationState

enableMapNavigation

  • enableMapNavigation(showZoomSlider?: boolean, showPanArrows?: boolean, enableGraphicMouseEvents?: boolean, mapState?: MapNavigationState): void

  • Parameters

    • Optional showZoomSlider: boolean
    • Optional showPanArrows: boolean
    • Optional enableGraphicMouseEvents: boolean
    • Optional mapState: MapNavigationState

    Returns void

getMapState

onInputMethodChange

  • onInputMethodChange(result: object): void

  • Fired when the input method for this component (e.g. keyboard, mouse) has changed.

    Parameters

    • result: object
      • newMethod: string
      • previousMethod: string

    Returns void

onKeyboardStart

  • onKeyboardStart(): void

  • Internal method that subclasses should override to provide keyboard handling.

    Returns void

onKeyboardStop

  • onKeyboardStop(cancelled?: boolean): void

  • Internal method that subclasses should override to provide keyboard handling.

    Parameters

    • Optional cancelled: boolean

      Whether the operation was cancelled.

    Returns void

resume

  • resume(): void

  • Returns void

setApp

  • Parameters

    Returns void

setInputMethod

  • setInputMethod(method: string): void

  • Sets the current input method for this component (for example, mouse or keyboard).

    Parameters

    • method: string

      The input method. See {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.accessibility.InputMethod} for valid values.

    Returns void

setKeyboardActive

  • setKeyboardActive(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

setMap

  • setMap(map: Map): void

  • Parameters

    • map: Map

    Returns void

suspend

  • suspend(): void

  • Returns void

toggleKeyboardMode

  • toggleKeyboardMode(): void

  • Returns void