Options
All
  • Public
  • Public/Protected
  • All
Menu

View model for the ExternalComponentView.

Hierarchy

Index

Constructors

constructor

Properties

Protected _activeViews

_activeViews: any

Protected _backButtonOnRootView

_backButtonOnRootView: boolean

Protected _fullTitleFormatString

_fullTitleFormatString: string

Protected _insertedViews

_insertedViews: any

Protected _ordering

_ordering: __type

Protected _originalHeaderIsVisibleSetting

_originalHeaderIsVisibleSetting: boolean

Protected _showBackButton

_showBackButton: boolean

Protected _showBackButtonAsX

_showBackButtonAsX: boolean

Protected _showHeaderForStandaloneViews

_showHeaderForStandaloneViews: boolean

Protected _viewDescriptorConstructor

_viewDescriptorConstructor: string

activeViewDescriptors

activeViewDescriptors: ObservableCollection<ViewDescriptor>

app

backTitle

backTitle: Observable<string>

closeOnEscape

closeOnEscape: boolean

closeTitle

closeTitle: Observable<string>

containerManagedTitle

containerManagedTitle: Observable<string>

containerTitle

containerTitle: Observable<string>

currentView

currentView: ViewBase

defaultPaneItems

defaultPaneItems: ObservableCollection<ExternalComponent> = new ObservableCollection<ExternalComponent>()

inherited

defaultViewIconUri

defaultViewIconUri: string

displayedPaneItems

displayedPaneItems: ObservableCollection<ExternalComponent> = new ObservableCollection<ExternalComponent>()

The collection of pane items currently being displayed in the multi pane view or in separate windows.

footerInsertDomElement

footerInsertDomElement: Observable<HTMLElement>

fullTitle

fullTitle: Observable<string>

hasCustomFooterComponent

hasCustomFooterComponent: Observable<boolean>

hasCustomHeaderComponent

hasCustomHeaderComponent: Observable<boolean>

headerInsertDomElement

headerInsertDomElement: Observable<HTMLElement>

headerIsVisible

headerIsVisible: Observable<boolean>

id

id: string

libraryId

libraryId: string

managedViewsOnly

managedViewsOnly: boolean

overlayIsVisible

overlayIsVisible: Observable<boolean> = new Observable(false)

overlayIsVisible

paneItems

paneItems: ObservableCollection<ExternalComponent> = new ObservableCollection<ExternalComponent>()

inherited

regionName

regionName: Observable<string>

regionType

regionType: Observable<string>

showBusyIndicator

showBusyIndicator: Observable<boolean>

showHostedViews

showHostedViews: Observable<boolean>

showingBackButton

showingBackButton: Observable<boolean>

showingXButton

showingXButton: Observable<boolean>

statusText

statusText: Observable<string> = new Observable<string>("")

statusText

titleBarIsVisible

titleBarIsVisible: Observable<boolean>

undockedPaneItems

undockedPaneItems: ObservableCollection<ExternalComponent> = new ObservableCollection<ExternalComponent>()

The collection of pane items which are currently hosted in their own windows.

viewDescriptors

viewTitle

viewTitle: Observable<string>

Methods

Protected _addOrderedView

Protected _registerCommandsAndEvents

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

    Returns void

activateViewInContainer

  • activateViewInContainer(view: ViewBase): 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

closeCurrentView

  • closeCurrentView(): void

createDescriptorForView

deactivateCurrentView

  • deactivateCurrentView(): void

deactivateViewInContainer

  • deactivateViewInContainer(view: ViewBase): void

deactivateViews

  • deactivateViews(): void

destroy

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

    Returns void

dispose

  • dispose(): void
  • Disposes of event handlers and child views. This should be called whenever a ViewContainerViewModel is no longer needed so that this object can be garbage collected, and so that child views are destroyed.

    Returns void

findDisplayedPaneItemById

  • findDisplayedPaneItemById(paneItemId: string): any
  • Find pane item by Id.

    Parameters

    • paneItemId: string

    Returns any

findPaneItemById

  • findPaneItemById(paneItemId: string): any
  • Find pane item by id.

    Parameters

    • paneItemId: string

    Returns any

findUndockedPaneItemById

  • Finds an undocked pane item by the given ID

    Parameters

    • paneItemId: string

      The ID of the undocked pane item to find.

    Returns ExternalComponent

getDescriptorForActiveView

getDescriptorForView

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

getViewPriority

  • getViewPriority(id: string): number

handleViewActivatedEvent

  • handleViewActivatedEvent(view: ViewBase): void

handleViewDeactivatedEvent

  • handleViewDeactivatedEvent(view: ViewBase): void

handleViewHosted

handleViewUnhosted

haveDockedPanes

  • haveDockedPanes(): boolean
  • Whether or not we have panes that are docked in the viewer.

    Returns boolean

initialize

insertActiveViewDescriptor

  • Inserts a view descriptor into the collection of descriptors representing active views, maintaining the configured order.

    Parameters

    Returns void

isDockedPaneItem

  • Whether or not the given pane item is docked in the viewer.

    Parameters

    • paneItem: ExternalComponent

      The pane item to check if it is in docked in the viewer.

    Returns boolean

isUndockedPaneItem

  • Whether or not the given pane item is undocked from the viewer, and hosted in its own window.

    Parameters

    • paneItem: ExternalComponent

      The pane item to check if it is hosted in its own window.

    Returns boolean

onDestroy

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

    Returns void

setDefaultComponents

  • setDefaultComponents(componentIds: string[]): void
  • Sets the configured default components.

    Parameters

    • componentIds: string[]

      An array of external component ids, which will be added to the default component list.

    Returns void

showOrHideCloseButtons

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