Options
All
  • Public
  • Public/Protected
  • All
Menu

IntegrationModule

Hierarchy

Index

Constructors

constructor

Properties

Protected _ignoreUpdateInterval

_ignoreUpdateInterval: number = 250

_ignoreUpdateInterval

Protected _ignoreUpdatesTimer

_ignoreUpdatesTimer: number

_ignoreUpdatesTimer.

app

The application.

behaviorNames

behaviorNames: string[]

The names of behaviors associated with this module. Keeping these make it so when the module is destroyed we can purge the behaviors from the registry.

config

Configuration of the module.

configuration

configuration: any

The configuration object that this module was initialized with.

id

id: string

libraryId

libraryId: string

Methods

Protected _handleApplicationResizedEvent

  • _handleApplicationResizedEvent(): void
  • Handles the application resizing.

    Returns void

Protected _registerCommandsAndEvents

  • _registerCommandsAndEvents(): void
  • Initial setup of commands and/or events that this component consumes and produces.

    Returns void

applyState

  • applyState(state: any): Thenable<void>
  • Re-applies module state that was previously exported via exportState.

    param:

    state The module state to apply.

    return:

    A promise that is fulfilled when the state has been fully applied.

    Parameters

    • state: any

    Returns Thenable<void>

auto

  • auto(arg0: any, arg1: any, arg2: any): void
  • Binds a handler to an Observable or to a dojo.connect. Binding to an Observable: ``` this.auto(someObservable, function (newValue) { });

    with explicit scope:

    this.auto(someObservable, this, function (newValue) { });

    Alternately, pass an event name as a string to use dojo.connect:
    

    this.auto(window, "onclick", function () { }); ```

    Parameters

    • arg0: any

      Either an Observable (for observable bindings) or a regular object (if arg1 is a string)

    • arg1: any

      If arg0 is an Observable, a function or scope object. Otherwise, an event name (to use with dojo.connect).

    • arg2: any

      If arg0 is an Observable, a function handler.

    Returns void

destroy

  • destroy(): void
  • Disposes any bindings tracked by this object.

    Returns void

exportState

  • Exports the current state of the module, which can be reapplied later via applyState.

    return:

    A promise that is fulfilled with the module's exported state.

    Returns Thenable<Object>

getResource

  • getResource(resourceKey: string, locale?: string): string
  • Gets a language resource from the Application's resource dictionary, given a key, and optional locale. Returns null if the resource does not exist.

    Parameters

    • resourceKey: string
    • Optional locale: string

      The locale of the resource to fetch. Defaults to the current application locale.

    Returns string

getStateFilter

  • getStateFilter(): any
  • A filter that will be applied to state as it is exported or applied to the module. See {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.ObjectFilter} for information on how to define a filter.

    Returns any

initialize

onDestroy

  • onDestroy(): void
  • Called on module destruction. Used to clear the behavior registry of all behaviors associated with this module.

    Returns void

shutdown

  • shutdown(state: any): void
  • Called when an {@link geocortex.framework.application.Application} is shutting down.

    Parameters

    • state: any

      Custom state object, perhaps indicating a shutdown reason or exception.

    Returns void

trackCommandHandler

  • trackCommandHandler(command: any, token: any): void
  • Tracks a subscription to an {@link geocortex.framework.commands.Command}, disposing it when this object is disposed with the destroy method.

    Parameters

    • command: any
    • token: any

    Returns void

trackSubscription

  • trackSubscription(event: any, token: any): void
  • Tracks a subscription to an {@link geocortex.framework.events.Event}, disposing it when this object is disposed with the destroy method.

    Parameters

    • event: any
    • token: any

    Returns void