Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Control

The Control class is the base class for all content generating classes. Everything that gets instantiated by the ControlManager has Control as its base.

Control is an abstract class that provides basic access in to the Orange render process via the onElementSet() and onControlCreated() methods.

The onElementSet() is called when the element property gets assigned by the ControlManager; when the onElementSet() method gets called whe know that the control implementing it has been assigned an HTMLElement and it is safe to start interacting with the element property.

The onControlCreated() method is called by the ControlManager when a control is finalized; all current child controls have been created (their onControlCreated() has been executed).

Se ControlManager for more information on the creation process of controls.

Hierarchy

Index

Properties

Private _element

_element: HTMLElement = null

Private _id

_id: Uuid = null

Private _propertyChangedListeners

_propertyChangedListeners: Array<function> = new Array<(propertyName: string, value: any) => void>()

Private disposables

disposables: Array<object> = new Array<{ dispose(): void}>()

Static Private propertyRegex

propertyRegex: RegExp = /return ([_a-zA-Z0-9]+)(\.([_a-zA-Z0-9]+))*;?/

Accessors

element

  • get element(): HTMLElement
  • set element(element: HTMLElement): void

id

Methods

addDisposable

  • addDisposable(disposable: object): void
  • Parameters

    • disposable: object
      • dispose: function
        • dispose(): void

    Returns void

addPropertyChangedListener

  • addPropertyChangedListener(listener: function): void
  • Parameters

    • listener: function
        • (propertyName: string, value: any): void
        • Parameters

          • propertyName: string
          • value: any

          Returns void

    Returns void

dispose

  • dispose(): void

Protected onControlCreated

  • onControlCreated(): void

Protected onElementSet

  • onElementSet(): void

Protected onPropertyChanged

  • onPropertyChanged(propertyName: string, value: any): void
  • Parameters

    • propertyName: string
    • value: any

    Returns void

Protected raisePropertyChanged

  • raisePropertyChanged(property: string): void
  • raisePropertyChanged<T>(property: function): void
  • Parameters

    • property: string

    Returns void

  • Type parameters

    • T

    Parameters

    • property: function
        • (): T
        • Returns T

    Returns void

removePropertyChangedListener

  • removePropertyChangedListener(listener: function): void
  • Parameters

    • listener: function
        • (propertyName: string, value: any): void
        • Parameters

          • propertyName: string
          • value: any

          Returns void

    Returns void

Static Private getPropertyName

  • getPropertyName<T>(property: function): string
  • Type parameters

    • T

    Parameters

    • property: function
        • (): T
        • Returns T

    Returns string

Generated using TypeDoc