Namespace: Widget

Classes

ControllerClass

Members

<private, static> detected :Boolean

Whether the detect method has been called at least once.

Type:

• Boolean

Source:

• js/widget.js, line 17

<static, readonly> root :String

Path to widgets directory.

Type:

• String

Source:

• js/widget.js, line 11

<static, readonly> types :Object

Index of all Widget types that have been detected.

Type:

• Object

Source:

• js/widget.js, line 23

<private, inner> onDisconnect :callbackGeneric

Fired on termination of User Server XMPP connection. Facilitates event cascade to all Widgets.

Type:

• callbackGeneric

Source:

• js/widget.js, line 514

See:

• Widget.ControllerClass#onDisconnect
• Starlet.onDisconnect
• Widget~onReconnect
• Widget~onUnload
• Widget~onExit

<private, inner> onExit :callbackGeneric

Fired before unloading Starlet, but only when Framework is about to exit. Expect no more than ~200ms before WebView stops. Facilitates event cascade to all Widgets.

Type:

• callbackGeneric

Source:

• js/widget.js, line 582

See:

• Widget.ControllerClass#onExit
• Starlet.onExit
• Widget~onDisconnect
• Widget~onReconnect
• Widget~onUnload

<private, inner> onReconnect :callbackGeneric

Fired on reestablishment of User Server XMPP connection. Facilitates event cascade to all Widgets.

Type:

• callbackGeneric

Source:

• js/widget.js, line 538

See:

• Widget.ControllerClass#onReconnect
• Starlet.onReconnect
• Widget~onDisconnect
• Widget~onUnload
• Widget~onExit

<private, inner> onUnload :callbackGeneric

Fired on reestablishment of User Server XMPP connection. Facilitates event cascade to all Widgets.

Type:

• callbackGeneric

Source:

• js/widget.js, line 562

See:

• Widget.ControllerClass#onRemove
• Starlet.onUnload
• Widget~onDisconnect
• Widget~onReconnect
• Widget~onExit

Methods

<static> add(type, $context)

Creates a Widget of specified type within the Starlet.

Parameters:

Name	Type	Argument	Default	Description
type	String			Type of widget to load resources for, must exist as a subdirectory in 'widgets'.
$context	jQuery | Element	<optional>	$('section#content')	Element to act as root.

Deprecated:

• since version 2.1

Source:

• js/widget.js, line 714

See:

• Widget.create
• Widget.remove

To Do:

• Make Widget a constructor to replace Widget.add/Widget.create, make Widget.remove a method of instantiated Widget controllers.

<static> create(type, parameters, baseUrl) → {jQuery|Element}

Creates a Widget of specified type within the Starlet, but in a way that avoids Widget.detect.

Parameters:

Name	Type	Argument	Description
type	String		Type of widget to load resources for, must exist as a subdirectory in 'widgets'.
parameters	Object		Attributes that would normally be detected on Widget tag.
baseUrl	String	<optional>	Location of widgets directory, if nonstandard.

Deprecated:

• since version 2.1

Source:

• js/widget.js, line 838

See:

• Widget.add
• Widget.remove

To Do:

• Make Widget a constructor to replace Widget.add/Widget.create, make Widget.remove a method of instantiated Widget controllers.

Returns:

Widget's containing element.

Type

jQuery | Element

<static> define(definition) → {Object}

Extends Widget with custom properties, methods, and callbacks. Call this in your Widget directory's index.js, it signifies to the synchronizer that fundamental custom Widget resources have been loaded and parsed.

Parameters:

Name	Type	Description
definition	Object	Structure with which to extend Widget, must include override for onRun to initiate any behavior.

Deprecated:

• since version 2.1

Source:

• js/widget.js, line 737

See:

• Widget.ControllerClass#attributes
• Widget.ControllerClass#onRun
• Widget.ControllerClass#onDisconnect
• Widget.ControllerClass#onReconnect
• Widget.ControllerClass#onUnload
• Widget.ControllerClass#onExit
• Widget.ControllerClass#onStarletVisible
• Widget.ControllerClass#onStarletActive
• Widget.ControllerClass#onStarletFocused
• Widget.ControllerClass#onStarletMinimized
• Widget.ControllerClass#onStarletHidden
• Widget.ControllerClass#onStarletMouse

To Do:

• Document definition, Make Widget a constructor to replace Widget.add/Widget.create, make Widget.remove a method of instantiated Widget controllers.

Returns:

Widget definition reference.

Type

Object

<static> detect(scope) → {Number}

Queries DOM for any uninitialized widgets, initializes new Widget controllers.

Parameters:

Name	Type	Argument	Default	Description
scope	jQuery | Element	<optional>	undefined	Root element to query within.

Source:

• js/widget.js, line 795

See:

• Widget.define
• Widget.load

Returns:

Count of new Widget types detected.

Type

Number

<static> instances(typeFilter) → {Array:.<Object:>}

Lists all Widget controllers within Starlet.

Parameters:

Name	Type	Argument	Default	Description
typeFilter	String	<optional>	''	Type to list, or undefined for all.

Source:

• js/widget.js, line 901

See:

• Widget.add
• Widget.create
• Widget.remove

Returns:

Widget controller instances.

Type

Array:.<Object:>

<static> lightbox(name, url, width, height) → {Object}

Opens a lightbox overlay with specific location and dimensions.

Parameters:

Name	Type	Description
name	String	Framework name of new WebView.
url	String	Location to open in lightbox.
width	Number	Width at which to open lightbox.
height	Number	Height at which to open lightbox.

Source:

• js/widget.js, line 637

See:

• Widget.lightbox(2):
• Widget.ControllerClass#lightbox
• Widget.ControllerClass#lightbox(2):
• Starlet.lightbox
• Starlet.lightbox(2):
• OrionLightbox.open

Returns:

Starlet

Type

Object

<static> lightbox(name) → {Object}

Closes a lightbox overlay by name.

Parameters:

Name	Type	Description
name	String	Framework name of WebView to close.

Source:

• js/widget.js, line 655

See:

• Widget.lightbox
• Widget.ControllerClass#lightbox
• Widget.ControllerClass#lightbox(2):
• Starlet.lightbox
• Starlet.lightbox(2):
• OrionLightbox.close
• OrionLightbox.setClosedCallback

Returns:

Starlet

Type

Object

<static> load(type, baseUrl) → {Object}

Fetches assets associated with a particular Widget type.

Parameters:

Name	Type	Argument	Description
type	String		Type of widget to load resources for, must exist as a subdirectory in 'widgets'.
baseUrl	String	<optional>	Location of widgets directory, if nonstandard.

Source:

• js/widget.js, line 927

See:

• Widget.detect
• Widget.define

Returns:

jQuery AJAX request.

Type

Object

<static> modal(html, options) → {Object}

Creates a Bootstrap modal dialog in a manner that forces a consistent z-index.

Parameters:

Name	Type	Argument	Default	Description
html	String			Raw html to pass through to Bootstrap modal method.
options	Object	<optional>	{}	Additional options. Properties Name Type Argument Default Description className String <optional> Custom CSS class name to add to modal element. backdrop Boolean | String <optional> 'static' Whether to include backdrop, and to allow click to dismiss. keyboard Boolean <optional> true Whether to allow esc to dismiss. show Boolean <optional> true Whether to show immediately. remote Boolean | String <optional> false Remote content URL.

Source:

• js/widget.js, line 673

See:

• Widget.modal(2):
• Widget.ControllerClass#modal
• Widget.ControllerClass#modal(2):
• Starlet.modal
• Starlet.modal(2):
• http://getbootstrap.com/2.3.2/javascript.html#modals

Returns:

Starlet.$modal

Type

Object

<static> modal(action) → {Object}

Controls Bootstrap modal dialog.

Parameters:

Name	Type	Description
action	String	Action (show|hide|toggle) to pass through to Bootstrap modal method.

Source:

• js/widget.js, line 695

See:

• Widget.modal
• Widget.ControllerClass#modal
• Widget.ControllerClass#modal(2):
• Starlet.modal
• Starlet.modal(2):
• http://getbootstrap.com/2.3.2/javascript.html#modals

Returns:

Starlet.$modal

Type

Object

<static> remove(widget)

Fetches assets associated with a particular Widget type.

Parameters:

Name	Type	Description
widget	Object | jQuery	Controller or element of Widget to remove.

Source:

• js/widget.js, line 991

See:

• Widget.add
• Widget.create