Options
All
  • Public
  • Public/Protected
  • All
Menu

Default view model for a SmartPanelView.

Hierarchy

Index

Constructors

constructor

Properties

Protected _activeViews

_activeViews: any

Protected _backButtonOnRootView

_backButtonOnRootView: boolean

Protected _fullTitleFormatString

_fullTitleFormatString: string

Protected _insertedViews

_insertedViews: any

Protected _isDestroyed

_isDestroyed: boolean

Protected _ordering

_ordering: object

Type declaration

  • [viewId: string]: number

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

defaultViewIconUri

defaultViewIconUri: string

footerInsertDomElement

footerInsertDomElement: Observable<HTMLElement>

fullTitle

fullTitle: Observable<string>

hasCustomFooterComponent

hasCustomFooterComponent: Observable<boolean>

hasCustomHeaderComponent

hasCustomHeaderComponent: Observable<boolean>

hasExecutableMenuItems

hasExecutableMenuItems: Observable<boolean>

Whether or not the currently hoisted menu (if present) has any executable menu items.

hasHoistedMenu

hasHoistedMenu: Observable<boolean>

Whether or not a menu is available for presentation as a hoisted menu.

headerInsertDomElement

headerInsertDomElement: Observable<HTMLElement>

headerIsVisible

headerIsVisible: Observable<boolean>

hoistedMenuViewModel

hoistedMenuViewModel: Observable<MenuViewModel>

The view model for the currently hoisted menu. When there is no hoisted menu present, this should be set to emptyMenuViewModel.

id

id: string

inlineMenuIsOpen

inlineMenuIsOpen: Observable<boolean>

Whether or not the inline menu is open.

libraryId

libraryId: string

managedViewsOnly

managedViewsOnly: boolean

menuRegion

menuRegion: string

An option region name specifying a region to activate menu views in. If specified in configuration, new menu views will be created and activated in this region rather than being dropdowns.

panelMaximized

panelMaximized: Observable<boolean>

Whether or not this panel is currently maximized

regionName

regionName: Observable<string>

regionType

regionType: Observable<string>

resizeX

resizeX: boolean

Whether the views that are linked to this are able to be resized on the x axis

resizeY

resizeY: boolean

Whether the views that are linked to this are able to be resized on the y axis

showBusyIndicator

showBusyIndicator: Observable<boolean>

showHostedViews

showHostedViews: Observable<boolean>

showingBackButton

showingBackButton: Observable<boolean>

showingMaximizeButton

showingMaximizeButton: Observable<boolean>

Whether to display the maximize button on this smart panel. Defaults to false

showingXButton

showingXButton: Observable<boolean>

statusRegion

statusRegion: string

Optional region where status messages related to this smart panel are to be shown. If specified in configuration, the status messages will be created and activated in this region.

statusRegionType

statusRegionType: string

The region type for status messages. Defaults to geocortex.framework.ui.DivRegionAdapter

titleBarIsVisible

titleBarIsVisible: Observable<boolean>

viewDescriptors

viewTitle

viewTitle: Observable<string>

Static emptyMenuViewModel

emptyMenuViewModel: MenuViewModel

An empty menu view model to use when no hoisted menu is available.

Methods

Protected _addOrderedView

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

    Returns void

destroyBindings

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

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

getZerothViewId

  • getZerothViewId(): string

handleViewActivatedEvent

  • handleViewActivatedEvent(view: ViewBase): void

handleViewDeactivatedEvent

  • handleViewDeactivatedEvent(view: ViewBase): void

handleViewHosted

handleViewUnhosted

initialize

  • initialize(config: any): void

insertActiveViewDescriptor

onDestroy

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

    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