Options
All
  • Public
  • Public/Protected
  • All
Menu

ExternalComponent view.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected _activatingForViewInContainer

_activatingForViewInContainer: boolean

Protected _active

_active: boolean

Protected _hasDiscoveredRegions

_hasDiscoveredRegions: boolean

Protected _isIE9

_isIE9: boolean = false

_isIE9

Protected _keyDownEventToken

_keyDownEventToken: any

Protected _notificationDisplayed

_notificationDisplayed: boolean = false

_notificationDisplayed

Protected _notificationViewId

_notificationViewId: string = "externalComponentStatusMessageView"

_notificationViewId

Protected _panes

_panes

Protected _windowLoadInterval

_windowLoadInterval: number = 250

_windowLoadInterval

Protected _windowUnloadInterval

_windowUnloadInterval: number = 500

_windowUnloadInterval

app

The Application

Private bindingSetupDelegates

bindingSetupDelegates: function[]

bindingTree

bindingTree: BindingNode

The tree of binding nodes represented in the markup.

bound

bound: boolean

Whether or not this view has been bound.

childRegions

childRegions: RegionAdapterBase[]

Regions belonging to (hosted in) this view.

configuration

configuration: any

Configuration materials.

description

description: Observable<string>

The Observable description of the view.

Private disposableBindings

disposableBindings: DisposableBinding[]

footerInsertDomElement

footerInsertDomElement: Observable<HTMLElement>

headerInsertDomElement

headerInsertDomElement: Observable<HTMLElement>

iconUri

iconUri: Observable<string>

The Observable icon URI of the view.

id

id: string

initiallyBound

initiallyBound: boolean

Indicates whether this view has been initialized and bound for the first time.

isActive

isActive: boolean

Whether or not this view is active.

isBusy

isBusy: Observable<boolean>

The Observable isBusy flag of the view.

isManaged

isManaged: boolean

Whether or not this view is allowed to be managed by some sort of view management component.

libraryId

libraryId: string

markupResource

markupResource: string

Resource name of the markup for this view (if any).

parentView

parentView: ViewBase

The parent view of this view, if this view is the result of a collection binding.

regionName

regionName: string

The name of the region that this view is hosted in.

root

root: HTMLElement

The root DOM element of this view.

scrollContainerBottom

scrollContainerBottom: Observable<number>

scrollContainerTop

scrollContainerTop: Observable<number>

title

title: Observable<string>

The Observable title of the view.

typeName

typeName: string

The type name of this view.

viewModel

The viewModel

Methods

Protected _broadcastClosedEvent

  • _broadcastClosedEvent(view: ViewBase, xButton: boolean, backButton: boolean): void

Protected _closeCurrentView

  • _closeCurrentView(ctx: any): void

Protected _documentKeyDown

  • _documentKeyDown(e: KeyboardEvent): void
  • Handles the document key down event so that the view container can be closed when the escape key is pressed.

    Parameters

    • e: KeyboardEvent

      The event object.

    Returns void

Protected _handleViewActivatedInContainerEvent

  • _handleViewActivatedInContainerEvent(view: ViewBase): void

activateContainer

  • activateContainer(): void

activated

  • activated(): void

addDisposableBinding

  • addDisposableBinding(observable: Observable<any>, token: string): void
  • Adds an Observable binding that will be disposed of when the view is destroyed.

    Parameters

    • observable: Observable<any>

      The Observable to bind to.

    • token: string

      The token received from binding to the observable.

    Returns void

addPaneItem

added

  • added(widgetViewHost?: ViewBase): void
  • Called when the view has been added to a region or as another view in the form of a widget.

    Parameters

    Returns void

applyBinding

  • Applies a binding expression to a DOM node based on the type name of the binding.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    • bindingNode: BindingNode

      The binding node to apply.

    Returns boolean

attach

  • attach(viewModelArg?: any): 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

buildAttributeBinding

  • buildAttributeBinding(el: HTMLElement, binding: BindingExpression, currentContext: any, directAttach?: boolean): boolean
  • Builds a DOM attribute binding, binding a DOM attribute to a view model property or attaching directly to the DOM object.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    • Optional directAttach: boolean

      Whether or not to directly modify the actual DOM element's own properties. Defaults to false.

    Returns boolean

buildClassBinding

  • buildClassBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean

buildDisabledBinding

  • buildDisabledBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean
  • Builds an enabled/disabled binding, simulating a cascading enabled/disabled state.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    Returns boolean

buildDomBinding

  • buildDomBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean
  • Builds a one-time DOM binding, binding to a DOM element in the view codebehind.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    Returns boolean

buildEventBinding

  • buildEventBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean
  • Builds an event binding, binding a DOM event to an event handler in the view.

    Parameters

    Returns boolean

buildSourceBinding

  • Builds a complex binding between a source and template element. Allows binding to collections of complex objects or singular complex objects.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    • bindingNode: BindingNode

      The current binding node in the binding tree.

    Returns boolean

buildStyleBinding

  • buildStyleBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean
  • Builds an inline CSS style binding.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    Returns boolean

buildTextBinding

  • buildTextBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean
  • Builds a sanitized text binding. Strips out unsafe characters, and allows direct referencing of language keys.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    Returns boolean

buildTree

  • Builds a tree of all binding expressions in this view and hooks up binding events as it goes. This method will recursively descend the DOM structure of its visual root and resolve binding expressions.

    Returns BindingNode

buildValueBinding

  • buildValueBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean
  • Builds a two-way binding between a form control and an Observable.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    Returns boolean

buildVarBinding

  • buildVarBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): void
  • Builds a var binding, creating a variable in the view that references a DOM element.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    Returns void

buildVisibilityBinding

  • buildVisibilityBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean
  • Builds a visibility binding.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    Returns boolean

buildWidgetBinding

  • buildWidgetBinding(el: HTMLElement, binding: BindingExpression, currentContext: any): boolean
  • Builds a (one-time) widget binding.

    Parameters

    • el: HTMLElement

      The element being bound.

    • binding: BindingExpression

      The binding expression.

    • currentContext: any

      The current data context.

    Returns boolean

canAddPaneItem

  • canAddPaneItem(paneItem: any): boolean
  • Can add paneItem.

    Parameters

    • paneItem: any

    Returns boolean

canDestroyPaneItem

  • canDestroyPaneItem(paneItem: any): boolean
  • Can destroy pane item.

    Parameters

    • paneItem: any

    Returns boolean

clearDockedPaneItems

  • clearDockedPaneItems(): void
  • Removes all pane items that are docked in the multi pane view.

    Returns void

clearPaneItems

  • clearPaneItems(): void
  • Removes all pane items from the multi pane view.

    Returns void

deactivateContainer

  • deactivateContainer(): void

deactivated

  • deactivated(): void
  • Called when the view has been deactivated.

    Returns void

delayedResize

  • delayedResize(): void
  • Works the same as resize() but after a small delay. This is useful if other elements still need to settle down.

    Returns void

destroy

  • destroy(): void

destroyBindings

  • destroyBindings(): void
  • Destroys all of this view's bindings, and by extension any views bound under this one. The primary purpose of this is to remove event subscriptions due to binding as well as dereferencing expensive DOM nodes so that they may be discarded.

    Returns void

destroyPaneItem

  • destroyPaneItem(paneItem: any): boolean
  • Remove a pane item from the layout.

    Parameters

    • paneItem: any

      The pane item to remove from the layout.

    Returns boolean

destroyPaneItemById

  • destroyPaneItemById(paneItemId: string, isWindowUnload?: boolean): void
  • Removes a pane item with the specified ID from the layout.

    Parameters

    • paneItemId: string

      The ID of the pane item to remove.

    • Default value isWindowUnload: boolean = false

      Whether or not the pane item is being destroyed due to its window unloading.

    Returns void

destroyUndockedPaneItem

  • Remove a pane item that is hosted in its own window.

    Parameters

    • paneItem: ExternalComponent

      The pane item that is undocked from the viewer and to be removed.

    Returns void

dockPaneItemById

  • dockPaneItemById(paneItemId: string): void
  • Dock the pane item in the multi pane view. If the pane item corresponding to the ID is already in a seperate windowed, it will be closed.

    Parameters

    • paneItemId: string

      The ID of the pane item to dock to the multi pane view.

    Returns void

findPaneForPaneItem

  • Find pane for pane item.

    Parameters

    • paneItem: any

    Returns ExternalComponentPaneView

getBindingTarget

  • Returns the target of a binding expression, taking into consideration Observables and pseudo-targets.

    Parameters

    Returns any

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

getZerothView

handleApplicationResizedEvent

  • handleApplicationResizedEvent(): void
  • Resize event handler.

    Returns void

handleClickBack

  • handleClickBack(evt: Event, el: HTMLElement, ctx: any): void
  • Parameters

    • evt: Event
    • el: HTMLElement
    • ctx: any

    Returns void

handleClickClose

  • handleClickClose(): void

handleClickCloseTab

  • handleClickCloseTab(evt: Event, el: HTMLElement, ctx: any): void

handleClickTab

  • handleClickTab(evt: Event, el: HTMLElement, ctx: any): void
  • Parameters

    • evt: Event
    • el: HTMLElement
    • ctx: any

    Returns void

handleRegionActivatedEvent

handleRegionDeactivatedEvent

handleScrollChange

  • handleScrollChange(evt: Event, el: HTMLElement, ctx: any): void

handleUnSelectPane

  • inherited

    Parameters

    Returns void

handleViewDeactivatedEvent

  • Deactivated event handler.

    Parameters

    Returns void

isTruthy

  • isTruthy(thing: any): boolean
  • Given some sort of thing, decide whether or not it is "truthy". Works with ObservableCollection.

    Parameters

    • thing: any

      The thing to check truthiness upon.

    Returns boolean

onDestroy

  • onDestroy(): void
  • Override or attach to provide custom clean-up behaviour.

    Returns void

pulseAll

  • pulseAll(): void
  • Performs the initial data bind of the UI.

    Returns void

removed

  • removed(): void
  • Called when a view has been removed from a region.

    Returns void

resize

  • resize(): void
  • Style the top/bottom offsets of the scroll region to accommodate any inserts (header or footer).

    Returns void

resolveBindingTemplate

  • Given a binding expression and a view model, resolves the correct template to use.

    Parameters

    • binding: BindingExpression

      The binding being satisfied.

    • viewModel: any

      The view model participating in the binding.

    Returns any

resolveWidget

  • Override this method to resolve widgets by ID and context. Return a {@link geocortex.framework.config.WidgetConfig}, or null.

    Parameters

    • widgetId: string

      The ID of the widget to resolve.

    • context: any

      The data context (view model) to bind the widget view to.

    • Optional binding: BindingExpression

      The binding expression that triggered this call to resolveWidget.

    Returns any

setBindingTargetValue

  • Sets the value of the target of a binding expression, taking into consideration Observables and pseudo-targets.

    Parameters

    • binding: BindingExpression

      The binding whose target should be resolved.

    • value: any

      The value to set.

    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

undockPaneItemById

  • undockPaneItemById(paneItemId: string): void
  • Undock the pane item from the multi pane view and opens it in a new window.

    Parameters

    • paneItemId: string

      The ID of the pane item to undock from the multi pane view.

    Returns void