Options
All
  • Public
  • Public/Protected
  • All
Menu

DivStackRegionAdapter Models a number of views as a stack of div elements.Views are brought to the top when activated. Multiple views may be visible at once and may overlap each other.

Hierarchy

Index

Constructors

constructor

Properties

activateViewsInLastPosition

activateViewsInLastPosition: boolean

Whether or not to move a view to the last position in the region's DOM container when activating.

activeViews

activeViews: ViewBase[]

Array of all the active views in this region.

app

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

defaultTransitionDelay

defaultTransitionDelay: number

Default time that views should take in transitioning from different states (active~inactive).

domElement

domElement: HTMLElement

The DOM element that this adapter works against.

isActive

isActive: boolean

Whether or not this region has one or more active views.

name

name: string

The name of this region adapter. Must be globally unique.

options

options: any

A key value-pair collection of configured options, specific to the particular region adapter.

ownerView

ownerView: ViewBase

The view that owns this region, if it's associated with one.

views

views: ViewBase[]

Any views hosted in this region.

Methods

activateView

  • Activates a view, making it visible and bringing it to the top of the active stack.

    Parameters

    • view: ViewBase

      The view to activate. This view should already be hosted in the region.

    Returns void

cancelActivate

  • Because the adding of the "active" class is asynchronous (through setTimeout(0)), there can be a potential race condition whereby if a view is immediately deactivated after getting activated, it may actually get the "activated" class added to it after it has been deactivated. To prevent this from happening, this method should be called when deactivating or simply hiding a view.

    Parameters

    Returns void

cancelDeactivate

  • cancelDeactivate(view: ViewBase): void

deactivateView

  • Deactivates a view, making it non-visible and removing it from the active stack.

    Parameters

    • view: ViewBase

      The view to deactivate. This view should already be hosted in the region.

    Returns void

host

  • host(element: HTMLElement, options?: any): void
  • inherited

    Parameters

    • element: HTMLElement
    • Optional options: any

    Returns void

hostView

  • Adds a view to the region and binds it to its view model, if present.

    Parameters

    Returns boolean

unhost

  • unhost(): void
  • Called when the region adapter is to be removed from the user interface.

    Returns void

unhostView