Class DomAbstract

Hierarchy

  • Dom

Accessors

Attribute Styles

Methods

ClassSelector Disable Enable GenerateUniqueId GetElementById GetElementByUniqueId GetFocusableElements IsInsidePopupWidget Move SetInputValue TagSelector TagSelectorAll

Constructors

constructor

Accessors

Static Attribute

  • get Attribute(): typeof AttributeManipulation

  • Getter of the class that helps to manipulate the HTML attributes.

    Static

    Memberof

    OSFramework.Helper.Dom

    Returns typeof AttributeManipulation

Static Styles

  • get Styles(): typeof StyleManipulation

  • Getter of the class that helps to manipulate the HTML styles and classes.

    Static

    Memberof

    OSFramework.Helper.Dom

    Returns typeof StyleManipulation

Methods

Static ClassSelector

  • Function that performs a querySelector of a given class in a given element.

    Static

    Returns

    {(HTMLElement | undefined)} Return the HTMLElement found, of if not undefined.

    Memberof

    OSFramework.Helper.Dom

    Parameters

    • element: HTMLElement | Document

      Element to be queried.

    • cssClass: string

      CSS class to test its value.

    Returns HTMLElement

Static Disable

  • Method that makes disables a given element.

    Static

    Memberof

    OSFramework.Helper.Dom

    Parameters

    • element: HTMLElement

    Returns void

Static Enable

  • Method that enables a given element.

    Static

    Memberof

    OSFramework.Helper.Dom

    Parameters

    • element: HTMLElement

    Returns void

Static GenerateUniqueId

  • Generate a Random String that could be assigned as a pattern UniqueId

    Export

    Returns

    {string}

    Returns string

Static GetElementById

  • Responsable for finding a DOM Element by its Id.

    Static

    Returns

    {HTMLElement} The respective DOM Element.

    Memberof

    OSFramework.Helper.Dom

    Parameters

    • id: string

      Id of the element to be returned.

    Returns HTMLElement

Static GetElementByUniqueId

  • Responsable for finding a DOM Element by its name attribute. That is commonly used to store the uniqueID generated by the framework.

    Static

    Returns

    {HTMLElement} The respective DOM Element.

    Memberof

    OSFramework.Helper.Dom

    Parameters

    • uniqueId: string

      uniqueId generated by the framework.

    Returns HTMLElement

Static GetFocusableElements

  • Method to get the list of focusable elements

    Static

    Returns

    {HTMLElement[]} List of focusable elements

    Memberof

    Dom

    Parameters

    • element: HTMLElement

      Element to be queried.

    • Optional includeTabIndexHidden: boolean = false

      Include elements with tabindex -1

    Returns HTMLElement[]

Static IsInsidePopupWidget

  • Method to check if element is inside a Popup widget

    Static

    Returns

    {boolean}

    Memberof

    Dom

    Parameters

    • element: HTMLElement

    Returns boolean

Static Move

  • Moves a given HTML element to target position.

    Static

    Memberof

    OSFramework.Helper.Dom

    Parameters

    • element: HTMLElement

      Element to be moved.

    • target: HTMLElement

      Location to where the Element is to be moved.

    Returns void

Static SetInputValue

  • Method that will help on setting the value of an input and trigger that change to the platform in order to update it's assigned variable, otherwise platform value do not get updated if/when only a value attribute get set!

    Memberof

    OSFramework.Helper.Dom

    Parameters

    • inputElem: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement

      Element where the value will be assigned!

    • value: string

      Value to be assigned

    Returns void

Static TagSelector

  • Function that performs a querySelector of a given html tag in a given element.

    Static

    Returns

    {(HTMLElement | undefined)}

    Memberof

    OSFramework.Helper.Dom

    Parameters

    • element: HTMLElement

      Element to be queried.

    • htmlTag: string

      HTML element to be searched for.

    Returns HTMLElement

Static TagSelectorAll

  • Function that performs a querySelectorAll of a given html tag in a given element.

    Static

    Returns

    {(HTMLElement | undefined)}

    Memberof

    OSFramework.Helper.Dom

    Parameters

    • element: HTMLElement | Document

      Element to be queried.

    • htmlTag: string

      HTML element to be searched for.

    Returns HTMLElement[]

Constructors

constructor

Settings

Member Visibility

Theme