Options
All
  • Public
  • Public/Protected
  • All
Menu

Creates and hosts an instance of AtomControl available at given URL. Query string parameters from the url will be passed to view model as initial property values.

By default stack is turned off, so elements and controls will be destroyed when new control is hosted.

Hierarchy

Implements

Index

Constructors

constructor

Properties

app

app: App

backCommand

backCommand: function

Type declaration

    • (): void
    • Returns void

current

current: AtomControl

currentDisposable

currentDisposable: IDisposable

defaultControlStyle

defaultControlStyle: any

disposables

disposables: AtomDisposableList

element

element: HTMLElement

keepStack

keepStack: boolean

name

name: string

pagePresenter

pagePresenter: HTMLElement

Protected pendingInits

pendingInits: Array<function>

saveScrollPosition

saveScrollPosition: boolean

stack

stack: IPageItem[]

Static isControl

isControl: true = true

Accessors

canGoBack

  • get canGoBack(): boolean

controlStyle

data

  • get data(): any
  • set data(v: any): void

localViewModel

  • get localViewModel(): any
  • set localViewModel(v: any): void

parent

theme

url

  • get url(): string
  • set url(value: string): void

viewModel

  • get viewModel(): any
  • set viewModel(v: any): void

vsProps

  • get vsProps(): object | object | __type

Methods

append

atomParent

beginEdit

bind

  • bind(element: HTMLElement, name: string, path: PathList[], twoWays?: boolean | string[], valueFunc?: function, source?: any): IDisposable

bindEvent

  • bindEvent(element: HTMLElement, name?: string, method?: EventListenerOrEventListenerObject, key?: string): IDisposable

canChange

  • canChange(): Promise<boolean>

Protected clearStack

  • clearStack(): void

Protected create

  • create(): void

dispose

  • dispose(e?: HTMLElement): void

hasProperty

  • hasProperty(name: string): boolean
  • Control checks if property is declared on the control or not. Since TypeScript no longer creates enumerable properties, we have to inspect name and PropertyMap which is generated by @BindableProperty or the value is not set to undefined.

    Parameters

    • name: string

      name of Property

    Returns boolean

invalidate

  • invalidate(): void

load

Protected loadForReturn

  • loadForReturn(url: AtomUri, clearHistory?: boolean): Promise<any>

onBackCommand

  • onBackCommand(): Promise<void>

onPropertyChanged

  • onPropertyChanged(name: string): void

Protected onUpdateSize

  • onUpdateSize(): void

onUpdateUI

  • onUpdateUI(): void

popStack

  • popStack(windowClosed?: boolean): void
  • This will pop page from the stack and set as current

    Parameters

    • Optional windowClosed: boolean

      true if current page was closed by User Action

    Returns void

Protected preCreate

  • preCreate(): void

push

registerDisposable

Protected removeAllChildren

  • removeAllChildren(e: HTMLElement): void

Protected render

  • render(node: XNode, e?: any, creator?: any): void

Protected resolve

  • resolve<TService>(c: TService, selfName?: string | function): IAnyInstanceType<TService>

runAfterInit

  • runAfterInit(f: function): void

Protected setElementClass

  • setElementClass(element: HTMLElement, value: any, clear?: boolean): void

Protected setElementValue

  • setElementValue(element: HTMLElement, name: string, value: any): void

setLocalValue

  • setLocalValue(element: HTMLElement, name: string, value: any): void

setPrimitiveValue

  • setPrimitiveValue(element: HTMLElement, name: string, value: any): void

Protected setUrl

  • setUrl(urlString: string): void

toUpperCase

  • toUpperCase(s: string): string

unbind

  • unbind(element: HTMLElement, name?: string): void

unbindEvent

  • unbindEvent(element: HTMLElement, name?: string, method?: EventListenerOrEventListenerObject, key?: string): void

updateSize

  • updateSize(): void

Generated using TypeDoc