Class PromptDialogBox

Standard dialog class

Hierarchy

Constructors

Properties

#m_timers: Map<string, Function>
m_auto_close: boolean
m_buttons: FormButtons
m_closable: boolean
m_edit: TextEdit<TextEditProps, TextEditEventMap>
m_form_cb: InitFormCallback
m_icon: IconID
m_last_down: number
m_maximizable: boolean
m_maximized: boolean
m_minFormSize: Size
m_minimizable: boolean
m_minimized: boolean
m_movable: boolean
m_rc_max: Rect
m_rc_min: Rect
m_title: string
m_ui_mask: HTMLElement
m_ui_title: Label
modal_stack: HTMLElement[] = []

Accessors

  • get dom(): HTMLElement
  • return the DOM associated with the Component (if any)

    Returns HTMLElement

  • set title(title: string): void
  • change the dialog title

    Parameters

    • title: string

    Returns void

Methods

  • Parameters

    • with_dom: boolean
    • timers: boolean

    Returns void

  • Parameters

    • tabIndex: number | boolean
    • defValue: number = 0

    Returns void

  • a some classnames to the component classes can be separated by a space

    Example

    ```typescript addClass( 'my class name @flex' );

    Parameters

    • name: string

    Returns void

  • add an application shortcut

    Parameters

    • sequence: string | string[]

      key sequence Shift+Ctrl+Alt+K

    • name: string
    • callback: EventHandler<KeyboardEvent> = null

      callback to call

    • immediate: boolean = false

    Returns void

  • remove all classes from the object this is usefull for component recycling & reusing

    Returns string

  • display the popup at a specific position

    Parameters

    • x: number
    • y: number
    • align: string = 'top left'
    • Optional offset: {
          x: any;
          y: any;
      }
      • x: any
      • y: any

    Returns void

  • enable or disable the element

    Parameters

    • Optional enable: boolean

    Returns void

  • get an attribute value

    Returns

    attribute value

    Example

    ```typescript let chk = el.getAttribute( 'checked' ); @review double cache

    Parameters

    • name: string

      attribute name

    Returns string

  • Returns

    the bounding rectangle

    Example

    ```typescript let rc = el.getBoundingRect( ); console.log( rc.left, rc.top, rc.right, rc.bottom );

    Parameters

    • withMargins: boolean = false

    Returns Rect

  • get the Component data value

    Parameters

    • name: string | Symbol

      name to get

    Returns any

  • check if the element has an attribute

    Returns

    true is attribute is present

    Example

    ```typescript if( el.hasAttribute('checked') ) { }

    Parameters

    • name: string

      attribute name

    Returns boolean

  • Remove a class from the element

    Example

    ```typescript el.removeClass( 'myclass' ); el.removeClass( 'myclass1 myclass2' );

    Parameters

    • name: string

      classes in string form can be space separated

    Returns void

  • ensure the component is visible @param: alignToTop

    Parameters

    • Optional arg: boolean | ScrollIntoViewOptions

    Returns void

  • change a single attribute

    Parameters

    • name: string

      attribute name

    • value: any

      new value

    Returns void

  • set the Component data value

    Parameters

    • name: string | Symbol

      name to get

    • value: any

    Returns void

  • resize the dialog

    Parameters

    • width: number
    • height: number

    Returns void

  • change the object style

    Example

    ```typescript el.setStyle( {left:100} );

    Parameters

    • style: object

      style to add

    Returns void

  • change a style value

    Parameters

    • name: string

      string style nale

    • value: any

      any style value or null to remove style

    Returns void

  • Parameters

    • tag: string
    • Optional namespace: string

    Returns void

  • display the popup on screen

    Parameters

    • Optional modal: boolean

    Returns void

  • start a new timer

    Parameters

    • name: string

      timer name

    • timeout: number

      time out in ms

    • repeat: boolean = true

      if true this is an auto repeat timer

    • callback: TimerCallback = null

      if !null, the callback to call else a EvTimer is fired

    Returns void

  • Toggle a class from the element (if present remove, if absent add)

    Example

    ```typescript el.toggleClass( 'myclass' ); el.toggleClass( 'myclass1 myclass2'); el.toggleClass( ['myclass1','myclass2']);

    Parameters

    • name: string

      classes in string form can be space separated

    Returns void

  • get a component from a DOM element move up to the hierarchy to find the request class type.

    Returns

    Example

    with a DOM like that:
    Button
    Label
    Icon <- the DOM you have (dom-icon)

    let btn = Component.getElement( dom-icon, Button );

    Type Parameters

    Parameters

    • dom: Element | HTMLElement
    • Optional classname: string | Constructor<T>

    Returns T

Generated using TypeDoc