Namespace: ui

Classes

Alert

Bar

BoundPanel

Box

Button

Buttons

Calendar

Chart

Checkboxes

Clipboard

CodeInput

ColorInput

ColorPicker

Columns

Component

DatePicker

DateTimeInput

Diagram

Dock

Drawing

DropDown

Editable

Editor

Emotion

Finder

FontInput

FontPicker

Form

Foundation

Fragment

Gallery

Graph

Icon

IFrame

ImageInput

ImageViewer

InfoView

Input

Layout

Link

LinkInput

Links

List

LocationInput

LocationPicker

MarkupEditor

MediaSimulator

Menu

ModelEditor

NumberInput

NumberValidator

ObjectInput

ObjectList

Overflow

Overlay

Pages

Panel

Picker

Presentation

ProgressBar

ProgressIndicator

Radiobuttons

Rendering

RevealingToolbar

Rows

SearchField

Segmented

Selection

Slider

Source

Split

Structure

StyleEditor

StyleLength

Tab

Tabs

TextInput

Tiles

TimeLine

TokenField

Toolbar

Upload

VideoPlayer

Window

Wizard

Namespaces

Flash

Methods

---

<static> addFocusClass(options)

Add focus class to an element

Parameters:

Name	Type	Description
options	Object	{element : Element, class : String}

Source:

• ui.js, line 576

---

<static> callAncestors()

Send a message to all ancestors of a widget

Source:

• ui.js, line 732

---

<static> callDelegatesDrop()

Send a global drag and drop message

Source:

• DragDrop.js, line 2

---

<static> callDescendants()

Send a message to all descendants of a widget

Source:

• ui.js, line 743

---

<static> callVisible()

Signal that a widget has changed visibility

Source:

• ui.js, line 759

---

<static> confirmOverlay(options)

Show a confirming overlay

options: {
 element : Element, // the element to show at
 widget : Widget, // the widget to show at
 text : String, // the text message
 okText : String, // text of OK button
 cancelText String, // text of cancel button
 $ok: Function, // called when user clicks the OK button
 $cancel: Function // called when user clicks the Cancel button
}

Parameters:

Name	Type	Description
options	Object	The options

Source:

• ui.js, line 127

---

<static> destroy(widget)

Unregisters a widget

Parameters:

Name	Type	Description
widget	Widget	The widget to destroy

Source:

• ui.js, line 175

---

<static> get(nameOrComponent)

Get a component by name

Parameters:

Name	Type	Description
nameOrComponent	hui.ui.Component | String	Get a component by name, if the parameter is already a component it is returned

Source:

• ui.js, line 63

Returns:

The component with the name or undefined

Type

hui.ui.Component

---

<static> getAncestors(widget)

Gets all ancestors of a widget

Parameters:

Name	Type	Description
widget	Widget	A widget

Source:

• ui.js, line 210

Returns:

An array of all ancestors

Type

Array

---

<static> getElement(widgetOrElement)

Get the element of a widget if not already an element

Parameters:

Name	Type	Description
widgetOrElement	Widget | Element	The widget to get the element for

Source:

• ui.js, line 530

Returns:

The element or null

Type

Element

---

<static> getText(key)

Get a localized text, defaults to english or the key

Parameters:

Name	Type	Description
key	String	The key of the text

Source:

• ui.js, line 378

Returns:

The localized string

Type

String

---

<static> include()

Load som UI from an URL

Source:

• ui.js, line 872

---

<static> listen()

Listen for global events

Source:

• ui.js, line 764

---

<static> onReady()

Called when the DOM is ready and hui.ui is ready

Source:

• ui.js, line 79

---

<static> request(options)

Parameters:

Name	Type	Description
options	Object	Properties Name Type Description message Object Properties Name Type Description start String success String

Source:

• ui.js, line 953

---

<static> require(names, func)

Import some widgets by name

Parameters:

Name	Type	Description
names	Array	Array of widgets to import
func	function	The function to call when finished

Source:

• ui.js, line 1051

---

<static> showCurtain()

Shows a "curtain" behind an element
#param options { widget: Widget, color: String, zIndex: Number }

Source:

• ui.js, line 328

---

<static> stress(widget)

Make a widget draw attention to itself

Parameters:

Name	Type	Description
widget	Widget	The widget to stress

Source:

• ui.js, line 590

---

<static> tellContainers(event, value)

Sends a message to ancestor frames (will call all the way up)

Parameters:

Name	Type	Description
event	String
value	Object

Source:

• ui.js, line 816