Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ToolBase

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.tools.ToolBase} class.

    class

    ToolBase provides a general purpose, loosely coupled model for creating components that have tool-like behavior.

    constructs
    memberof

    geocortex.essentialsHtmlViewer.mapping.infrastructure.tools

    Parameters

    • app: ViewerApplication

      The {@link geocortex.essentialsHtmlViewer.ViewerApplication} that this tool belongs to.

    • mixin: ToolConfig

      An object to provide additional configuration of this tool.

    Returns ToolBase

Properties

app

app: ViewerApplication

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

closeTitle

closeTitle: string

Optional title for the close tool UI element. Defaults to "Deactivate Tool".

enabled

enabled: Observable<boolean>

Whether the tool is enabled (can be used). The tool will be assumed to not support disabling if left undefined.

iconUri

iconUri: string

Optional URI of the icon to display with the status.

isActive

isActive: boolean

Whether this tool is active.

type

{boolean}

keyboardStatusText

keyboardStatusText: string

Optional, alternate status text to display for keyboard users. Can be i18ned.

libraryId

libraryId: string

Library to look up i18n string keys from. Required to display i18n strings.

name

name: string

The name of this tool.

type

{string}

statusClass

statusClass: string

Optional CSS class for the status displayed for this tool.

statusText

statusText: string

Status text to display while the tool is active. Can be i18ned.

Methods

onActivated

  • onActivated(): void

  • Called when the tool is activated.

    Returns void

onDeactivated

  • onDeactivated(): void

  • Called when the tool is deactivated.

    Returns void

setActive

  • setActive(active: boolean): void

  • Sets the active state of the tool.

    Parameters

    • active: boolean

      The desired active state of the tool.

    Returns void