Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

  • Initializes a new instance of the {@link geocortex.framework.ui.RegionAdapterBase} class.

    Parameters

    • name: string

      The name of the region adapter.

    • app: Application

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

    Returns MultiDivRegionAdapter

Properties

activeViews

activeViews: ViewBase[]

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.

stickyViewActive

stickyViewActive: boolean

Boolean indicating that sticky mode is active. All view activations in the region blocked until current view is deactivated.

views

views: ViewBase[]

Any views hosted in this region.

Methods

activateView

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

  • deactivateView(view: ViewBase, activatePrevious?: boolean): void

getHostedTagName

  • getHostedTagName(): string

hideAllViews

  • hideAllViews(): void

host

  • host(element: HTMLElement, options?: any): void
  • Hosts the region in the given DOM element. Views will be adapted for this element.

    Parameters

    • element: HTMLElement

      The DOM element to adapt views for.

    • Optional options: any

      The data region options as a key-value pair collection (i.e. an object).

    Returns void

hostView

unhost

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

    Returns void

unhostView