jsdoc

$.ui.simplicityWidget

Namespace $.ui.simplicityWidget

Base class widget to automate common actions.
Defined in: ui.simplicityWidget.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
<private> <static>  
$.ui.simplicityWidget._addClass(target, cssClass)
Wrapper around $.addClass that registers a destroy hook.
<private> <static>  
$.ui.simplicityWidget._bind(target, eventName, handler)
Wrapper around $.bind that registers a destroy hook.
<private> <static>  
$.ui.simplicityWidget._registerDestroyHook(destroyHook)
Register a function to be called during widget destruction.
<static>  
$.ui.simplicityWidget.destroy()
Widget destructor, runs any registered destroy hooks.
Namespace Detail
$.ui.simplicityWidget
Method Detail
<private> <static> $.ui.simplicityWidget._addClass(target, cssClass)
Wrapper around $.addClass that registers a destroy hook.
Parameters:
target
Optional selector or DOM node, if missing defaults to this.element.
cssClass
CSS class to add

<private> <static> $.ui.simplicityWidget._bind(target, eventName, handler)
Wrapper around $.bind that registers a destroy hook. The traditional use of:
$(selector).bind('click', $.proxy(this._handler, this));
Would be written as:
this._bind(selector, 'click', this._handler);
Parameters:
target
Optional selector or DOM node, if missing defaults to this.element.
eventName
The event to bind to
handler
Handler function or name (looked up against this) which is automatically proxied.

<private> <static> $.ui.simplicityWidget._registerDestroyHook(destroyHook)
Register a function to be called during widget destruction.
Parameters:
destroyHook
The function to be registered

<static> $.ui.simplicityWidget.destroy()
Widget destructor, runs any registered destroy hooks.

Documentation generated by JsDoc Toolkit 2.4.0