Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AtomComponent<T, TC>

Type parameters

Hierarchy

Implements

Index

Constructors

constructor

Properties

app

app: App

data

data: any

disposables

disposables: AtomDisposableList

element

element: T

localViewModel

localViewModel: any

Protected pendingInits

pendingInits: Array<function>

viewModel

viewModel: any

Static isControl

isControl: true = true

Accessors

parent

  • get parent(): TC

vsProps

  • get vsProps(): object | object | __type
  • Do not ever use, only available as intellisense feature for vs code editor.

    Returns object | object | __type

Methods

Abstract append

  • append(element: T | TC): TC

Abstract atomParent

  • atomParent(e: T): TC

beginEdit

bind

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

    • element: T
    • name: string
    • path: PathList[]
    • Optional twoWays: boolean | string[]
    • Optional valueFunc: function
        • (...v: any[]): any
        • Parameters

          • Rest ...v: any[]

          Returns any

    • Optional source: any

    Returns IDisposable

bindEvent

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

Protected create

  • create(): void

dispose

  • dispose(e?: T): 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

onPropertyChanged

  • onPropertyChanged(name: string): void

onUpdateUI

  • onUpdateUI(): void

Protected preCreate

  • preCreate(): void

registerDisposable

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 setElementValue

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

setLocalValue

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

setPrimitiveValue

  • setPrimitiveValue(element: T, name: string, value: any): void
  • Use this method if you want to set attribute on HTMLElement immediately but defer atom control property

    Parameters

    • element: T

      HTMLElement

    • name: string

      string

    • value: any

      any

    Returns void

unbind

  • unbind(element: T, name?: string): void
  • Remove all bindings associated with given element and optional name

    Parameters

    • element: T

      T

    • Optional name: string

      string

    Returns void

unbindEvent

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

    • element: T
    • Optional name: string
    • Optional method: EventListenerOrEventListenerObject
    • Optional key: string

    Returns void

Generated using TypeDoc