Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

  • Initializes a new instance of the {@link geocortex.framework.application.ModuleBase} class.

    Parameters

    • app: Application

      The {@link geocortex.framework.application.Application} that this module belongs to.

    • libraryId: string

      The ID of the library that this component originated from.

    Returns ResultsModule

Properties

_currentResultsView

_currentResultsView: "table" | "list"

_enableDataLinkObjectIdFieldOnExport

_enableDataLinkObjectIdFieldOnExport: boolean

_featureIndexName

_featureIndexName: string

_featureIndexRoundUpPerFeatureSet

_featureIndexRoundUpPerFeatureSet: number

_includeDataLinksOnExport

_includeDataLinksOnExport: boolean

Protected _isDestroyed

_isDestroyed: boolean

_resultsViewOpened

_resultsViewOpened: boolean

_showInvisibleAttributes

_showInvisibleAttributes: boolean

_supportedFormats

_supportedFormats: string[]

app

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.

configuration

configuration: any

The configuration object that this module was initialized with.

id

id: string

libraryId

libraryId: string

resultMappings

resultMappings: any

schema

schema: any

Methods

applyState

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
  • Destroys the object completely

    Returns void

destroyBindings

  • destroyBindings(): void

exportState

exportTo

  • exportTo(params: object): void
  • Parameters

    Returns void

exportToCanExecute

  • exportToCanExecute(args: any): boolean
  • Parameters

    • args: any

    Returns boolean

exportToError

  • exportToError(error: string, statusMsgId: string, f: string): void
  • Parameters

    • error: string
    • statusMsgId: string
    • f: string

    Returns void

exportToSuccess

  • exportToSuccess(data: any, f: string): void
  • Parameters

    • data: any
    • f: string

    Returns void

fsmCollectionOpenedHandler

fsmCollectionSetCommand

  • fsmCollectionSetCommand(command?: string, sourceName?: string): void
  • Parameters

    • Optional command: string
    • Optional sourceName: string

    Returns void

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

initialize

  • initialize(config: any): void
  • Parameters

    • config: any

    Returns void

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

subscribeToEvents

  • subscribeToEvents(): void
  • 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

wireUpResultMapping

  • wireUpResultMapping(): void
  • Returns void