Constructordojox.widget.SortList

dojo.require("dojox.widget.SortList");
defined in dojox/widget/SortList.js

A sortable unordered-list with a fixed header for use in dijit.demos.chat for demonstration purposes only for now. feel free to make API suggestions or fixes.

Usage

function ()
parametertypedescription
paramsObjectOptional.
srcNodeRefDomNode|String 
dijit._Contained (from dijit.layout._LayoutWidget), dijit._Container (from dijit.layout._LayoutWidget), dijit._Templated

Jump to PropertiesFunctionsBack to top

FunctionaddChild(widget, insertIndex: Integer?)
Defined by dijit._Container
Process the given child widget, inserting it's dom node as a child of our dom node
Construct the UI for this widget from a template, setting this.domNode.
Functionconnect(obj: Object, event: String, method: String|Function)
Defined by dijit._Widget
Connects specified obj/event to specified method of this object and registers for disconnect() on widget destroy. Special event: "ondijitclick" triggers on a click or enter-down or space-up Similar to dojo.connect() but takes three arguments rather than four.
Functioncreate(params: Object?, srcNodeRef: DomNode|String)
Defined by dijit._Widget
Kick off the life-cycle of a widget
Functiondestroy(finalize: Boolean)
Defined by dijit._Widget
Destroy this widget, but not its descendants
Defined by dijit._Widget
Recursively destroy the children of this widget and their descendants.
Defined by dijit._Widget
Destroy this widget and it's descendants. This is the generic "destructor" function that all widget users should call to cleanly discard with a widget. Once a widget is destroyed, it's removed from the manager object.
Defined by dijit._Widget
Destroys the DOM nodes associated with this widget
Functiondisconnect(handles: Object)
Defined by dijit._Widget
Disconnects handle created by this.connect. Also removes handle from this widget's list of connects
Defined by dijit._Container
Returns array of children widgets
Defined by dijit._Widget
Returns all the widgets that contained by this, i.e., all widgets underneath this.containerNode.
Defined by dijit._Contained
Returns null if this is the last child of the parent, otherwise returns the next element sibling to the "right".
Defined by dijit._Contained
Returns the parent widget of this widget, assuming the parent implements dijit._Container
Defined by dijit._Contained
Returns null if this is the first child of the parent, otherwise returns the next element sibling to the "left".
Defined by dijit._Container
Returns true if widget has children
Defined by dijit._Widget
Return true if this widget can currently be focused and false if not
Defined by dijit._Widget
Checks the DOM to for the text direction for bi-directional support
Widgets override this method to size & position their contents/children. When this is called this._contentBox is guaranteed to be set (see resize()). This is called after startup(), and also when the widget's size has been changed.
Defined by dijit._Widget
stub function. Override or connect to this method to receive notifications for when the widget moves out of focus.
stub function, passes the last changed item, and is fired after current state
Defined by dijit._Widget
Callback if someone tries to close the child, child will be closed if func returns true
Defined by dijit._Widget
stub function. Override or connect to this method to receive notifications for when the widget moves into focus.
FunctiononSort(e)
sort the data, and style the nodes.
Called after a widget's dom has been setup
Defined by dijit._Widget
Called after the parameters to the widget have been read-in, but before the widget template is instantiated. Especially useful to set properties that are referenced in the widget template.
Functionpostscript(params: Object?, srcNodeRef: DomNode|String)
Defined by dijit._Widget
FunctionremoveChild(widget)
Defined by dijit._Container
Removes the passed widget instance from this widget but does not destroy it
Functionresize(args: Object?)
do our additional calculations when resize() is called by or in a parent
FunctionsetAttribute(attr: String, value)
Defined by dijit._Widget
Set native HTML attributes reflected in the widget, such as readOnly, disabled, and maxLength in TextBox widgets.
FunctionsetTitle(title: String)
Sets the widget title to a String
Called after all the widgets have been instantiated and their dom nodes have been inserted somewhere under dojo.doc.body. Widgets should override this method to do any initialization dependent on other widgets existing, and then call this superclass method to finish things off. startup() in subclasses shouldn't do anything size related because the size of the widget hasn't been set yet.
Defined by dijit._Widget
Defined by dijit._Widget
stub function. Override to implement custom widget tear-down behavior.
Function_addItem(item)
Function_attachTemplateNodes(rootNode: DomNode, getAttrFunc: Function?)
Defined by dijit._Templated
Iterate through the template and attach functions and nodes accordingly.
Defined by dijit._Templated
relocate source contents to templated container node this.containerNode must be able to receive children, or exceptions will be thrown
Function_getSibling(which)
Defined by dijit._Contained
Defined by dijit._Container
Get the next or previous widget sibling of child
click listener for data portion of widget. toggle selected state of node, and update this.selected array accordingly
Defined by dijit._Widget
Defined by dijit._Widget
Function_set(e)
set hover state
Function_sorter(a, b)
a basic sort function, use query sort, or keep this?
Defined by dijit._Templated
Function_unset(e)
remove hover state (FIXME: combine with _set?)

Jump to FunctionsPropertiesBack to top

Defined by dijit._Widget
A map of attributes and attachpoints -- typically standard HTML attributes -- to set on the widget's dom, at the "domNode" attach point, by default. Other node references can be specified as properties of 'this'
Defined by dijit._Widget
HTML class attribute
Defined by dijit._Templated
holds child elements. "containerNode" is generally set via a dojoAttachPoint assignment and it designates where children of the src dom node will be placed
Toggle sort order based on this value.
Defined by dijit._Widget
Unsupported by Dijit, but here for completeness. Dijit only supports setting text direction on the entire document. Bi-directional support, as defined by the [HTML DIR](http://www.w3.org/TR/html401/struct/dirlang.html#adef-dir) attribute. Either left-to-right "ltr" or right-to-left "rtl".
this is our visible representation of the widget! Other DOM Nodes may by assigned to other properties, usually through the template system's dojoAttachPonit syntax, but the domNode property is the canonical "top level" node in widget UI.
In the event a parent container is expecting a title="" attribute, set it for the parent via title, and the title of this widget via heading="" ... assuming you want different titles for each. eg: TabContainer, AccordionContainer, etc.
Defined by dijit._Widget
a unique, opaque ID string that can be assigned by users or by the system. If the developer passes an ID which is known not to be unique, the specified ID is ignored and the system-generated ID is used instead.
Defined by dijit._Widget
Rarely used. Overrides the default Dojo locale used to render this widget, as defined by the [HTML LANG](http://www.w3.org/TR/html401/struct/dirlang.html#adef-lang) attribute. Value must be among the list of locales specified during by the Dojo bootstrap, formatted according to [RFC 3066](http://www.ietf.org/rfc/rfc3066.txt) (like en-us).
Overrides dijit._Widget
A list of the selected <li> nodes at any given time.
toggle to enable/disable sorting
Defined by dijit._Widget
pointer to original dom node
Defined by dijit._Widget
HTML style attribute
Defined by dijit._Templated
a node that represents the widget template. Pre-empts both templateString and templatePath.
Overrides dijit._Templated
Path to template (HTML file) for this widget relative to dojo.baseUrl
Defined by dijit._Templated
a string that represents the widget template. Pre-empts the
Overrides dijit._Widget
The title in the header
Defined by dijit._Templated
should we parse the template to find widgets that might be declared in markup inside it? false by default.
Defined by dijit._Widget