Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ToolBar

Toolbar UI component.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    Returns any

Properties

createdItems

createdItems: number

Created ToolBar items.

eventQueue

eventQueue: EmitterEvent[]

uiComponent

uiComponent: Element

The underlying HTML element.

Methods

addItem

  • Adds an item to the toolbar.

    Parameters

    Returns { el: HTMLDivElement; id: number }

    • el: HTMLDivElement
    • id: number

addSeparator

  • addSeparator(): void

  • Adds a separator.

    Returns void

destroy

  • destroy(): void

  • Destroys the UI component.

    Returns void

emit

  • emit(evtName: String, ...args: any): void

  • Fires an event.

    Parameters

    • evtName: String

      The event name to fire.

    • Rest ...args: any

      The arguments to pass.

    Returns void

getElement

  • getElement(): Element

  • Returns the element for this UI component.

    Returns Element

getItem

  • getItem(nameOrId: string | number): HTMLDivElement

  • Gets an item.

    Parameters

    • nameOrId: string | number

      The name or ID of the item to get.

    Returns HTMLDivElement

getItemById

  • getItemById(id: number): HTMLDivElement

  • Gets an item by id.

    Parameters

    • id: number

    Returns HTMLDivElement

getItemByName

  • getItemByName(name: string): HTMLDivElement

  • Gets an item by name.

    Parameters

    • name: string

      The name of the item to lookup.

    Returns HTMLDivElement

getSize

  • getSize(): { height: Number; w: Number }

  • Returns the size of the component.

    Returns { height: Number; w: Number }

    • height: Number
    • w: Number

init

  • init(): void

  • Optional initialization code.

    Returns void

on

  • on(evtName: String, callback: Function): void

  • Listens for an event.

    Parameters

    • evtName: String

      The event name to listen for.

    • callback: Function

      The callback to assign.

    Returns void

once

  • once(evtName: String, callback: Function): void

  • Listens for an event once.

    Parameters

    • evtName: String

      The event name to listen for.

    • callback: Function

      The callback to assign.

    Returns void

resetItemStates

  • resetItemStates(): void

  • Resets all item states.

    Returns void

setDisabled

  • setDisabled(ident: string | number, value: boolean): void

  • Sets whether an item is disabled.

    Parameters

    • ident: string | number

      The identifier of the item.

    • value: boolean

      The state to set.

    Returns void

setSize

  • setSize(w: string | number, h: string | number): void

  • Sets the size of the component.

    Parameters

    • w: string | number

      CSS prefixed width.

    • h: string | number

      CSS prefixed height.

    Returns void

Generated using TypeDoc