A list of widgets on a page. A roll-up for common dijit methods Display tooltip w/specified contents in specified position. See description of dijit.Tooltip.defaultPosition for details on position parameter. If position is not specified then dijit.Tooltip.defaultPosition is used. hide the tooltip tests whether the current selection is empty Retrieves a bookmark that can be used with moveToBookmark to return to the same range Moves current selection to a bookmark This should be a returned object from dojo.html.selection.getBookmark() Returns the current focus and selection. Called when a popup appears (either a top level menu or a dialog), or when a toolbar/menubar receives focus A handle to restore focus/selection The menu that's being opened iframe in which menu was opened Sets the focused node and the selection according to argument. To set focus to an iframe's content, pass in the iframe itself. object returned by get(), or a DomNode Registers listeners on the specified window (either the main window or an iframe) to detect when the user has clicked somewhere. Anyone that creates an iframe should call this function. Called when focus leaves a node. Usually ignored, _unless_ it *isn't* follwed by touching another node, which indicates that we tabbed off the last field on the page, in which case every widget is marked inactive Callback when node is focused or mouse-downed Returns a widget by its id, or if passed a widget, no-op (like dojo.byId()) Returns the widget as referenced by node Returns the widget whose dom tree contains node or null if the node is not contained within the dom tree of any widget Tests if an element is tab-navigable Finds the following descendants of the specified root node: * the first tab-navigable element in document order without a tabindex or with tabindex=&quot;0&quot; * the last tab-navigable element in document order without a tabindex or with tabindex=&quot;0&quot; * the first element in document order with the lowest positive tabindex value * the last element in document order with the highest positive tabindex value Finds the descendant of the specified root node that is first in the tabbing order Finds the descendant of the specified root node that is last in the tabbing order Positions one of the node's corners at specified position such that node is fully visible in viewport. Object like {x: 10, y: 20} Array of Strings representing order to try corners in, like [&quot;TR&quot;, &quot;BL&quot;]. Possible values are: * &quot;BL&quot; - bottom left * &quot;BR&quot; - bottom right * &quot;TL&quot; - top left * &quot;TR&quot; - top right Try to place node's top right corner at (10,20). If that makes node go (partially) off screen, then try placing bottom left corner at (10,20). placeOnScreen(node, {x: 10, y: 20}, ["TR", "BL"]) Given a list of spots to put node, put it at the first spot where it fits, of if it doesn't fit anywhere then the place with the least overflow of elements like: {corner: 'TL', pos: {x: 10, y: 20} } Above example says to put the top-left corner of the node at (10,20) (node aroundNodeCorner, nodeCorner) for things like tooltip, they are displayed differently (and have different dimensions) based on their orientation relative to the parent. This adjusts the popup based on orientation. Determines if an element has a particular non-XHTML role. true if elem has the specific non-XHTML role attribute and false if not. for backwards compatibility if role parameter not provided, returns true if has non XHTML role Gets the non-XHTML role for an element (which should be a wai role). The non-XHTML role of elem or an empty string if elem does not have a role. Sets the role on an element. Removes the specified non-XHTML role from an element. removes role attribute if no specific role provided (for backwards compat.) Determines if an element has a given state. true if elem has a value for the given state and false if it does not. Gets the value of a state on an element. The value of the requested state on elem or an empty string if elem has no value for state. Sets a state on an element. Removes a state from an element. Get window object associated with document doc Select text in the input element argument, from start (default 0), to stop (default end). A keyboard accessible color-picking widget <div dojoType="dijit.ColorPalette"></div> number of milliseconds before a held key or button becomes typematic fraction of time used to change the typematic timer between events 1.0 means that each typematic event fires at defaultTimeout intervals &lt; 1.0 means that each typematic event fires at an increasing faster rate Size of grid, either &quot;7x10&quot; or &quot;3x4&quot;. Index of the currently focused color. This is the number of colors horizontally across. / This is the number of colors vertically down. Path to the template of this widget. Widget tabindex. Focus this ColorPalette. Puts focus on the first swatch. Callback when a color is selected. Hex value corresponding to color. console.debug(&quot;Color selected is: &quot;+color); Handler for click, enter key &amp; space key. Selects the color. The event. Handler for onMouseOver. Put focus on the color under the mouse. The mouse event. Handler for onFocus. Removes highlight of the color that just lost focus, and highlights the new color. The focus event. Called when color is hovered or focused. needed for Firefox 2 on Mac OS X This selects a color. It triggers the onChange event area: The area node that covers the color being selected. This is the callback for typematic. It changes the focus and the highlighed color. much the key is navigated. many times typematic has fired. This represents the value of the colors. The first level is a hashmap of the different arrays available The next two dimensions represent the columns and rows of colors. This is stores the path to the palette images This is a map that is used to calculate the coordinates of the images that make up the palette. Size of the supported palettes for alignment purposes. The Declaration widget allows a user to declare new widget classes directly from a snippet of markup. The component that grays out the screen behind the dialog Template has two divs; outer div is used for fade-in/fade-out, and also to hold background iframe. Inner div has opacity specified in CSS file. Append the underlay to the body Sets the background to the size of the viewport Show the dialog underlay hides the dialog underlay User defined function to do stuff when the user hits the submit button Callback when user has canceled dialog, to notify container (user shouldn't override) Callback when user is about to execute dialog, to notify container (user shouldn't override) callback when user hits submit button A modal dialog Widget <div dojoType="dijit.Dialog" href="test.html"></div> is True or False depending on state of dialog The time in milliseconds it takes the dialog to fade in and out A Toggle to modify the default focus behavior of a Dialog, which is to re-focus the element which had focus before being opened. False will disable refocusing. Default: true A Toggle to modify the default focus behavior of a Dialog, which is to focus on the first dialog element after opening the dialog. False will disable autofocusing. Default: true The pointer to the first focusable node in the dialog The pointer to which node has focus prior to our dialog Don't change this parameter from the default value. This ContentPane parameter doesn't make sense for Dialog, since Dialog is never a child of a layout container, nor can you specify the size of Dialog in order to control the size of an inner widget. Toggles the moveable aspect of the Dialog. If true, Dialog can be moved by it's title. If false it will remain centered in the viewport. when href is specified we need to reposition the dialog after the data is loaded Called after dragging the Dialog. Calculates the relative offset of the Dialog in relation to the viewport. stuff we need to do before showing the Dialog for the first time (but we defer it until right beforehand, for performance reasons) Make sure the dialog is small enough to fit in viewport. Position modal dialog in the viewport. If no relative offset in the viewport has been determined (by dragging, for instance), center the node. Otherwise, use the Dialog's stored relative offset, and position the node to top: left: values based on the viewport. handles the keyboard events for accessibility reasons display the dialog Hide the dialog Position the Dialog and the underlay Pops up a dialog that appears like a Tooltip Description of tooltip dialog (required for a11Y) Don't change this parameter from the default value. This ContentPane parameter doesn't make sense for TooltipDialog, since TooltipDialog is never a child of a layout container, nor can you specify the size of TooltipDialog in order to control the size of an inner widget. A Toggle to modify the default focus behavior of a Dialog, which is to focus on the first dialog element after opening the dialog. False will disable autofocusing. Default: true The pointer to the first focusable node in the dialog The domNode that had focus before we took it. configure widget to be displayed in given position relative to the button called when dialog is displayed keep keyboard focus in dialog; close dialog on escape key A rich text Editing widget a list of extra plugin names which will be appended to plugins array When using customUndo, not every keystroke will be saved as a step. Instead typing (including delete) will be grouped together: after a user stop typing for editActionInterval seconds, a step will be saved; if a user resume typing within editActionInterval seconds, the timeout will be restarted. By default, editActionInterval is 3 seconds. takes a plugin name as a string or a plugin instance and adds it to the toolbar and associates it with this editor instance. The resulting plugin is added to the Editor's plugins array. If index is passed, it's placed in the plugins array at that index. No big magic, but a nice helper for passing in plugin names via markup. String args object or plugin instance args: This object will be passed to the plugin constructor Used when creating an instance from something already in this.plugins. Ensures that the new instance is assigned to this.plugins at that index. An element with in-line edit capabilitites Changing the value automatically saves it; don't have to push save button (and save button isn't even displayed) Save button label Cancel button label Set this to true if the specified Editor's value should be interpreted as HTML rather than plain text (ie, dijit.Editor) Class name for Editor widget Set of parameters for editor, like {required: true} Width of editor. By default it's width=100% (ie, block mode) The display value of the widget in read-only mode The text that gets displayed when there is no value (so that the user has a place to click to edit) User should set this handler to be notified of changes to value User should set this handler to be notified when no change occured Hook to make attr(&quot;disabled&quot;, ...) work. Set disabled state of widget. Display the editor widget in place of the original (read only) markup. revert to display mode, and optionally focus on display node Save the contents of the editor and revert to display mode. Focus on the display mode text Hook to make attr(&quot;value&quot;, ...) work. Inserts specified HTML value into this node, or an &quot;input needed&quot; character if node is blank. Revert to display mode, discarding any changes made in the editor internal widget used by InlineEditBox, displayed when in editing mode to display the editor and maybe save/cancel buttons. Calling code should connect to save/cancel methods to detect when editing is finished Has mainly the same parameters as InlineEditBox, plus these values: style: Object Set of CSS attributes of display node, to replicate in editor value: String Value as an HTML string or plain text string, depending on renderAsHTML flag Callback when keypress in the edit box (see template). Called when focus moves outside the editor Called when the underlying widget fires an onChange event, which means that the user has finished entering the value User replacable function returning a Boolean to indicate if the Save button should be enabled or not - usually due to invalid conditions Array of dom node ids of nodes to attach to. Fill this with nodeIds upon widget creation and it becomes context menu for those nodes. if true, right clicking anywhere on the window will cause this context menu to open; if false, must specify targetNodeIds If true, menu will open on left click instead of right click, similiar to a file menu. pointer to menu that displayed me number of milliseconds before hovering (without clicking) causes the popup to automatically open used to record mouse and keyboard events to determine if a context menu is being opened with the keyboard or the mouse attach point for notification about when a menu item has been executed attach point for notification about when the user cancels the current menu Handle keyboard based menu navigation. Called when cursor is over a MenuItem Close all popups that are open and descendants of this menu Callback fires when mouse exits a MenuItem user defined function to handle clicks on an item Returns the window reference of the passed iframe Returns a reference to the document object inside iframe_el attach menu to given node detach menu from given node Open menu relative to the mouse callback when this menu is closed open the popup to the side of the current menu item returns an array of placeholders with the given label. There can be multiples. An array of placeholders that match the given label Label to search for - if not specified, then all placeholders are returned Internal function for opening myself when the user does a right-click or something similar A line item in a Menu Widget menu text Class to apply to div in button to make it display an icon if true, the menu item is disabled if false, the menu item is enabled callback when mouse is moved onto menu item callback when mouse is moved off of menu item User defined function to handle clicks Hook for attr('disabled', ...) to work. Enable or disable this menu item. The innerHTML contains both the menu item text and a popup widget <div dojoType="dijit.PopupMenuItem"> <span>pick me</span> <popup> ... </popup> </div> A line between two menu items over ride to always return false a checkbox-like menu item for toggling on and off Our checked state Hook so attr('checked', bool) works. Sets the class and state for the check box. User defined function to handle change events Clicking this item just toggles its state A progress indication widget <div dojoType="ProgressBar" places="0" progress="..." maximum="..."> </div> (Percentage or Number) initial progress value. with &quot;%&quot;: percentage value, 0% &lt;= progress &lt;= 100% or without &quot;%&quot;: absolute value, 0 &lt;= progress &lt;= maximum max sample number number of places to show in values; 0 by default If false: show progress. If true: show that a process is underway but that the progress is unknown update progress information may provide progress and/or maximum properties on this parameter, see attribute specs for details. Generates message to show; may be overridden by user User definable function fired when progress updates. A pane with a title on top, that can be opened or collapsed. // load a TitlePane from remote file: var foo = new dijit.TitlePane({ href: "foobar.html", title:"Title" }); foo.startup(); Whether pane is opened or closed. Time in milliseconds to fade in/fade out The root className to use for the various states of this widget Hook to make attr(&quot;open&quot;, boolean) control the open/closed state of the pane. True if you want to open the pane, false if you want to close it. Hook to make attr(&quot;content&quot;, ...) work. Typically called when an href is loaded. Our job is to make the animation smooth switches between opened and closed state set the open/close css state for the TitlePane callback when user hits a key handle blur and focus for this widget add/removeClass is safe to call without hasClass in this case sets the text of the title A Toolbar widget, used to hold things like dijit.Editor buttons A spacer between two Toolbar items This widget isn't focusable, so pass along that fact. Display tooltip w/specified contents to right specified node (To left if there's no space on the right, or if LTR==right) private function to set CSS for tooltip node based on which position it's in hide the tooltip Number of milliseconds to wait after hovering over/focusing on the object, before the tooltip is displayed. Id(s) of domNodes to attach the tooltip to. When user hovers over any of the specified dom nodes, the tooltip will appear. See description of dijit.Tooltip.defaultPosition for details on position parameter. display the tooltip; usually not called directly. hide the tooltip or cancel timer for show of tooltip Single node within a tree Text of this tree node dynamic loading-related stuff. When an empty folder node appears, it is &quot;UNCHECKED&quot; first, then after dojo.data query it becomes &quot;LOADING&quot; and, finally &quot;LOADED&quot; visually denote that tree is loading data, etc. clear markup from markProcessing() call set appropriate CSS classes for icon and label dom node (used to allow for item updates to change respective CSS) set appropriate CSS classes for this.domNode set the right image for the expando node show my children Sets the child items of this node, removing/adding nodes from current children to match specified items[] array. if this node wasn't already showing the expando node, turn it into one and call _setExpando() This widget displays hierarchical data from a store. A query is specified to get the &quot;top level children&quot; from a data store, and then those items are queried for their children and so on (but lazily, as the user clicks the expand node). Thus in the default mode of operation this widget is technically a forest, not a tree, in that there can be multiple &quot;top level children&quot;. However, if you specify label, then a special top level node (not corresponding to any item in the datastore) is created, to father all the top level children. {type:'continent'} Alternate interface from store to access data (and changes to data) in the tree Specifies datastore query to return the root item for the tree. Deprecated functionality: if the query returns multiple items, the tree is given a fake root node (not corresponding to any item in the data store), whose children are the items that match this query. The root node is shown or hidden based on whether a label is specified. Having a query return multiple items is deprecated. If your store doesn't have a root item, wrap the store with dijit.tree.ForestStoreModel, and specify model=myModel Deprecated. Use dijit.tree.ForestStoreModel directly instead. Used in conjunction with query parameter. If a query is specified (rather than a root node id), and a label is also specified, then a fake root node is created and displayed, with this label. Should the root node be displayed, or hidden? one ore more attributes that holds children of a tree node If true, clicking a folder node's label will open it, rather than calling onClick() enables/disables use of cookies for state saving. class name to use as as the dnd controller Publish a message for this widget/topic user specified a store&amp;query rather than model, so create model from store/query initial load of the tree load root node (possibly hidden) and it's children User overridable function to tell if an item has or may have children. Controls whether or not +/- expando icon is shown. (For efficiency reasons we may not want to check if an element actually has children until user clicks the expando node) User overridable function that return array of child items of given parent item, or if parentItem==null then return top items in tree user overridable function to get the label for a tree node (given the item) user overridable function to return CSS class name to display icon user overridable function to return CSS class name to display label translates keypress events into commands for the controller down arrow pressed; get next visible node, set focus there up arrow pressed; move to previous visible node right arrow pressed; go to child node Left arrow pressed. If not collapsed, collapse, else move to parent. home pressed; get first visible node, set focus there end pressed; go to last visible node letter key pressed; search for node starting with first char = key translates click events into commands for the controller to process user clicked the +/- icon; expand or collapse my children. user overridable function for executing a tree item callback when a node is opened callback when a node is closed get next visible node get first visible node called when the user has requested to collapse the node called when the user has requested to expand the node Removes focus from the currently focused node (which must be visible). Usually not called directly (just call focusNode() on another node instead) Focus on the specified node (which must be visible) We've moved away from the whole tree. The currently &quot;focused&quot; node (see focusNode above) should remain as the lastFocused node so we can tab back into the tree. Just change CSS to get rid of the dotted border until that time called from onFocus handler of treeitem labelNode to set styles, wai state and tabindex for currently focused treeitem. processes notification of a deletion of an item processes notification of a change to an item's scalar values like label processes notification of a change to an item's children create and save a cookie with the currently expanded nodes identifiers creates a TreeNode passed the arguments listed above (store, etc) {id:'ROOT'} one ore more attributes that holds children of a tree node If specified, get label for tree node from this attribute, rather than by calling store.getLabel() Pointer to the root item (read only, not a parameter) Specifies datastore query to return the root item for the tree. Must only return a single item. Alternately can just pass in pointer to root item. Calls onItem with the root item for the tree, possibly a fabricated item. Calls onError on error. Tells if an item has or may have children. Implementing logic here avoids showing +/- expando icon for nodes that we know don't have children. (For efficiency reasons we may not want to check if an element actually has children until user clicks the expando node) Calls onComplete() with array of child items of given parent item, all loaded. get the label for an item Creates a new item. See dojo.data.api.Write for details on args. Used in drag &amp; drop when item from external source dropped onto tree. Move or copy an item from one parent item to another. Used in drag &amp; drop Callback whenever an item has changed, so that Tree can update the label, icon, etc. Note that changes to an item's children or parent(s) will trigger an onChildrenChange() so you can ignore those changes here. Callback to do notifications about new, updated, or deleted items. Callback when an item has been deleted. handler for when new items appear in the store. handler for delete notifications from underlying store set data event on an item in the store Interface between Tree and a dojo.store that doesn't have a root item, ie, has multiple &quot;top level&quot; items. description Use this class to wrap a dojo.store, making all the items matching the specified query appear as children of a fabricated &quot;root item&quot;. If no query is specified then all the items returned by fetch() on the underlying store become children of the root item. It allows dijit.Tree to assume a single root item, even if the store doesn't have one. {type:'continent'} Label of fabricated root item Specifies the set of children of the root item. Tells if an item has or may have children. Implementing logic here avoids showing +/- expando icon for nodes that we know don't have children. (For efficiency reasons we may not want to check if an element actually has children until user clicks the expando node) Calls onComplete() with array of child items of given parent item, all loaded. Creates a new item. See dojo.data.api.Write for details on args. Used in drag &amp; drop when item from external source dropped onto tree. User can override this method to modify a new element that's being added to the root of the tree, for example to add a flag like root=true Move or copy an item from one parent item to another. Used in drag &amp; drop Called when item added to root of tree; user must override to modify the item so that it matches the query for top level items example store.setValue(item, &quot;root&quot;, true); Called when item removed from root of tree; user must override to modify the item so it doesn't match the query for top level items example store.unsetAttribute(item, &quot;root&quot;); handler for when new items appear in the store. handler for delete notifications from underlying store A simple GUI for choosing a date in the context of a monthly calendar. var calendar = new dijit._Calendar({}, dojo.byId("calendarNode")); the currently selected Date How to represent the days of the week in the calendar header. See dojo.date.locale Hook to make attr(&quot;value&quot;, ...) work. a date cell was selected. It may be the same as the previous value. called only when the selected date has changed May be overridden to disable certain dates in the calendar e.g. `isDisabledDate=dojo.date.locale.isWeekend` May be overridden to return CSS classes to associate with the date entry for the given dateObject, for example to indicate a holiday in specified locale. summary Mixin for widgets that are children of a container widget // make a basic custom widget that knows about it's parents dojo.declare("my.customClass",[dijit._Widget,dijit._Contained],{}); Returns the parent widget of this widget, assuming the parent implements dijit._Container Returns null if this is the first child of the parent, otherwise returns the next element sibling to the &quot;left&quot;. Returns null if this is the last child of the parent, otherwise returns the next element sibling to the &quot;right&quot;. Returns the index of this widget within its container parent. It returns -1 if the parent does not exist, or if the parent is not a dijit._Container Mixin for widgets that contain a set of widget children. Makes the given widget a child of this widget. Removes the passed widget instance from this widget but does not destroy it. You can also pass in an integer indicating the index within the container to remove Returns array of children widgets. Returns true if widget has children, i.e. if this.containerNode contains something. Get the next or previous widget sibling of child if 1, get the next sibling if -1, get the previous sibling Gets the index of the child in this container or -1 if not found Call in postCreate() to attach the keyboard handlers to the container. preKeyCodes: Array Key codes for navigating to the previous child. Key codes for navigating to the next child. Call in startup() to set child tabindexes to -1 Add a child to our _Container Default focus() implementation: focus the first child. Focus the first focusable child in the container. Focus the next widget or focal node (for widgets with multiple focal nodes) within this container. Focus the previous widget or focal node (for widgets with multiple focal nodes) within this container. Focus widget. Optionally focus 'node' within widget. Set tabindex=&quot;-1&quot; on focusable widgets so that we can focus them programmatically and by clicking. Connect focus and blur handlers. Called when focus leaves a child widget to go to a sibling widget. Mixin for widgets that are instantiated from a template a node that represents the widget template. Pre-empts both templateString and templatePath. a string that represents the widget template. Pre-empts the templatePath. In builds that have their strings &quot;interned&quot;, the templatePath is converted to an inline templateString, thereby preventing a synchronous network call. Path to template (HTML file) for this widget relative to dojo.baseUrl should we parse the template to find widgets that might be declared in markup inside it? false by default. Construct the UI for this widget from a template, setting this.domNode. relocate source contents to templated container node this.containerNode must be able to receive children, or exceptions will be thrown Iterate through the template and attach functions and nodes accordingly. the node to search for properties. All children will be searched. a function which will be used to obtain property for a given DomNode/Widget Static method to get a template based on the templatePath or templateString key The URL to get the template from. dojo.uri.Uri is often passed as well. a string to use in lieu of fetching the template from a URL. Takes precedence over templatePath Returns: Mixed Either string (if there are ${} variables that need to be replaced) or just a DOM tree (if the node can be cloned directly) Strips &lt;?xml ...?&gt; declarations so that external SVG and XML documents can be added to a document without worry. Also, if the string is an HTML document, only the part inside the body tag is returned. Attempts to create a set of nodes based on the structure of the passed text. The foundation of dijit widgets. 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. 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). 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 &quot;ltr&quot; or right-to-left &quot;rtl&quot;. HTML class attribute HTML style attribute HTML title attribute This is our visible representation of the widget! Other DOM Nodes may by assigned to other properties, usually through the template system's dojoAttachPoint syntax, but the domNode property is the canonical &quot;top level&quot; node in widget UI. Designates where children of the source dom node will be placed. &quot;Children&quot; in this case refers to both dom nodes and widgets. For example, for myWidget: &lt;div dojoType=myWidget&gt; &lt;b&gt; here's a plain dom node &lt;span dojoType=subWidget&gt;and a widget&lt;/span&gt; &lt;i&gt; and another plain dom node &lt;/i&gt; &lt;/div&gt; containerNode would point to: &lt;b&gt; here's a plain dom node &lt;span dojoType=subWidget&gt;and a widget&lt;/span&gt; &lt;i&gt; and another plain dom node &lt;/i&gt; In templated widgets, &quot;containerNode&quot; is set via a dojoAttachPoint assignment. containerNode must be defined for any widget that accepts innerHTML (like ContentPane or BorderContainer or even Button), and conversely is null for widgets that don't, like TextBox. Connect to this function to receive notifications of mouse click events. Event Connect to this function to receive notifications of mouse double click events. Event Connect to this function to receive notifications of keys being pressed down. Event Connect to this function to receive notifications of printable keys being typed. Event Connect to this function to receive notifications of keys being released. Event Connect to this function to receive notifications of when the mouse button is pressed down. Event Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. Event Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. Event Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. Event Connect to this function to receive notifications of when the mouse moves off of this widget. Event Connect to this function to receive notifications of when the mouse moves onto this widget. Event Connect to this function to receive notifications of when the mouse button is released. Event kicks off widget instantiation, see create() for details. Kick off the life-cycle of a widget Hash of initialization parameters for widget, including scalar values (like title, duration etc.) and functions, typically callbacks like onClick. If a srcNodeRef (dom node) is specified: - use srcNodeRef.innerHTML as my contents - if this is a behavioral widget then apply behavior to that srcNodeRef - otherwise, replace srcNodeRef with my generated DOM tree Step during widget creation to copy all widget attributes to the DOM as per attributeMap and _setXXXAttr functions. 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. Construct the UI for this widget, setting this.domNode. Most widgets will mixin dijit._Templated, which implements this method. Called after a widget's dom has been setup Called after a widget's children, and other widgets on the page, have been created. Provides an opportunity to manipulate any children before they are displayed. This is useful for composite widgets that need to control or layout sub-widgets. Many layout widgets can use this as a wiring phase. Destroy this widget and it's descendants. This is the generic &quot;destructor&quot; 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. If true, this method will leave the original Dom structure alone of descendant Widgets. Note: This will NOT work with dijit._Templated widgets. Destroy this widget, but not its descendants. Will, however, destroy internal widgets such as those used within a template. If true, this method will leave the original Dom structure alone. Note: This will not yet work with _Templated widgets Destroys the DOM nodes associated with this widget If true, this method will leave the original Dom structure alone during tear-down. Note: this will not work with _Templated widgets yet. Recursively destroy the children of this widget and their descendants. If true, the preserveDom attribute is passed to all descendant widget's .destroy() method. Not for use with _Templated widgets. TODO: should I destroy in the reverse order, to go bottom up? stub function. Override to implement custom widget tear-down behavior. stub function. Override or connect to this method to receive notifications for when the widget moves into focus. stub function. Override or connect to this method to receive notifications for when the widget moves out of focus. Called when someone connects to one of my handlers. &quot;Turn on&quot; that handler if it isn't active yet. Reflect a widget attribute (title, tabIndex, duration etc.) to the widget DOM, as specified in attributeMap. Set or get properties on a widget instance. The property to get or set. If an object is passed here and not a string, its keys are used as names of attributes to be set and the value of the object as values to set in the widget. Optional. If provided, attr() operates as a setter. If omitted, the current value of the named property is returned. helper function for Widget.attr() cache attribute name values so we don't do the string ops every time returns a string that represents the widget. When a widget is cast to a string, this method will be used to generate the output. Currently, it does not implement any sort of reversable serialization. Returns all the widgets that contained by this, i.e., all widgets underneath this.containerNode. Connects specified obj/event to specified method of this object and registers for disconnect() on widget destroy. var btn = new dijit.form.Button(); // when foo.bar() is called, call the listener we're going to // provide in the scope of btn btn.connect(foo, "bar", function(){ console.debug(this.toString()); }); Disconnects handle created by this.connect. Also removes handle from this widget's list of connects Checks the page for text direction Return true if this widget can currently be focused and false if not Place this widget's domNode reference somewhere in the DOM based on standard dojo.place conventions, or passing a Widget reference that contains and addChild member. The String id of a domNode, a domNode reference, or a reference to a Widget posessing an addChild method. If passed a string or domNode reference, the position argument accepts a string just as dojo.place does, one of: &quot;first&quot;, &quot;last&quot;, &quot;before&quot;, or &quot;after&quot;. If passed a _Widget reference, and that widget reference has an &quot;.addChild&quot; method, it will be called passing this widget instance into that method, supplying the optional position index passed. // create a Button with no srcNodeRef, and place it in the body: var button = new dijit.form.Button({ label:"click" }).placeAt(dojo.body()); // now, 'button' is still the widget reference to the newly created button dojo.connect(button, "onClick", function(e){ console.log('click'); }); A graphical time picker. This widget is used internally by other widgets and is not accessible as a standalone widget. ISO-8601 string representing the amount by which every clickable element in the time picker increases. Set in local time, without a time zone. Example: `T00:15:00` creates 15 minute increments Must divide dijit._TimePicker.visibleIncrement evenly ISO-8601 string representing the amount by which every element with a visible time in the time picker increases. Set in local time, without a time zone. Example: `T01:00:00` creates text in every 1 hour increment ISO-8601 string representing the range of this TimePicker. The TimePicker will only display times in this range. Example: `T05:00:00` displays 5 hours of options Date to display. Defaults to current time and date. Can be a Date object or an ISO-8601 string. If you specify the GMT time zone (`-01:00`), the time will be converted to the local time in the local time zone. Otherwise, the time is considered to be in the local time zone. If you specify the date and isDate is true, the date is used. Example: if your local time zone is `GMT -05:00`, `T10:00:00` becomes `T10:00:00-05:00` (considered to be local time), `T10:00:00-01:00` becomes `T06:00:00-05:00` (4 hour difference), `T10:00:00Z` becomes `T05:00:00-05:00` (5 hour difference between Zulu and local time) `yyyy-mm-ddThh:mm:ss` is the format to set the date and time Example: `2007-06-01T09:00:00` see dijit._TimePicker.clickableIncrement see dijit._TimePicker.visibleIncrement see dijit._TimePicker.visibleRange attributeMap sets up a &quot;binding&quot; between attributes (aka properties) of the widget and the widget's DOM. Changes to widget attributes listed in attributeMap will be reflected into the DOM. For example, calling attr('title', 'hello') on a TitlePane will automatically cause the TitlePane's DOM to update with the new title. attributeMap is a hash where the key is an attribute of the widget, and the value reflects a binding to a: - DOM node attribute focus: {node: &quot;focusNode&quot;, type: &quot;attribute&quot;} Maps this.focus to this.focusNode.focus - DOM node innerHTML title: { node: &quot;titleNode&quot;, type: &quot;innerHTML&quot; } Maps this.title to this.titleNode.innerHTML - DOM node CSS class myClass: { node: &quot;domNode&quot;, type: &quot;class&quot; } Maps this.myClass to this.domNode.className If the value is an array, then each element in the array matches one of the formats of the above list. There are also some shorthands for backwards compatibility: - string --&gt; { node: string, type: &quot;attribute&quot; }, for example: &quot;focusNode&quot; ---&gt; { node: &quot;focusNode&quot;, type: &quot;attribute&quot; } - &quot;&quot; --&gt; { node: &quot;domNode&quot;, type: &quot;attribute&quot; } attributeMap addendum for event handlers that should be connected only on first use pointer to original dom node A set of widgets indexed by id Integer horizontal coordinate in pixels, relative to document body Integer vertical coordinate in pixels, relative to document body Integer horizontal offset in pixels, relative to document body Integer vertical offset in pixels, relative to document body width: Integer width in pixels height in pixels This class is used to show/hide widgets as popups. Prepares a node to be used as a popup Popup the widget at the specified position popup: Widget widget to display, parent: Widget the button etc. that is displaying this popup around: DomNode DOM node (typically a button); place popup relative to this node orient: Object structure specifying possible positions of popup relative to &quot;around&quot; node onCancel: Function callback when user has canceled the popup by 1. hitting ESC or 2. by using the popup widget's proprietary cancel mechanism (like a cancel button in a dialog); ie: whenever popupWidget.onCancel() is called, args.onCancel is called onClose: Function callback whenever this popup is closed onExecute: Function callback when user &quot;executed&quot; on the popup/sub-popup by selecting a menu choice, etc. (top menu only) examples: 1. opening at the mouse position dijit.popup.open({popup: menuWidget, x: evt.pageX, y: evt.pageY}); 2. opening the widget as a dropdown dijit.popup.open({parent: this, popup: menuWidget, around: this.domNode, onClose: function(){...} }); Note that whatever widget called dijit.popup.open() should also listen to it's own _onBlur callback (fired from _base/focus.js) to know that focus has moved somewhere else and thus the popup should be closed. Close specified popup and any popups that it parented cache of iframes For IE z-index schenanigans. id attribute is required. destroy the iframe These functions are used to repetitively call a user specified callback method when a specific key or mouse click over a specific DOM node is held down for a specific amount of time. Only 1 such event is allowed to occur on the browser page at 1 time. Start a timed, repeating callback sequence. If already started, the function call is ignored. This method is not normally called by the user but can be when the normal listener code is insufficient. Parameters: key or mouse event object pointer to the user's widget space. the DOM node object passed in function to call until the sequence is stopped called with 3 parameters: count: integer representing number of repeated calls (0..n) with -1 indicating the iteration has stopped user space object used to uniquely identify each typematic sequence if &gt; 1, the number of milliseconds until the 3-&gt;n events occur or else the fractional time multiplier for the next event's delay, default=0.9 the number of milliseconds until the 2nd event occurs, default=500ms Stop an ongoing timed, repeating callback sequence. Start listening for a specific typematic key. an object defining the key to listen for. charOrCode: the printable character (string) or keyCode (number) to listen for. keyCode: (deprecated - use charOrCode) the keyCode (number) to listen for (implies charCode = 0). charCode: (deprecated - use charOrCode) the charCode (number) to listen for. ctrlKey: desired ctrl key state to initiate the calback sequence: pressed (true) released (false) either (unspecified) altKey: same as ctrlKey but for the alt key shiftKey: same as ctrlKey but for the shift key See the trigger method for other parameters. Returns an array of dojo.connect handles Start listening for a typematic mouse click. See the trigger method for other parameters. Returns an array of dojo.connect handles Start listening for a specific typematic key and mouseclick. This is a thin wrapper to addKeyListener and addMouseListener. the DOM node object to listen on for mouse events. the DOM node object to listen on for key events. See the addMouseListener and addKeyListener methods for other parameters. Returns an array of dojo.connect handles Detects if we are in high-contrast mode or not Adds escape sequences for special characters in XML: &amp;&lt;&gt;&quot;' Optionally skips escapes for single quotes Returns the html content of a DomNode and children dijit._editor.RichText is the core of dijit.Editor, which provides basic WYSIWYG editing features. whether to inherit the parent's width or simply use 100% whether focusing into this instance of richtext when page onload If a save name is specified the content is saved and restored when the user leave this page can come back, or if the editor is not properly closed after editing has started. semicolon (&quot;;&quot;) separated list of css files for the editing area temporary content storage set height to fix the editor at a specific height, with scrolling. By default, this is 300px. If you want to have the editor always resizes to accommodate the content, use AlwaysShowToolbar plugin and set height=&quot;&quot;. If this editor is used within a layout widget, set height=&quot;100%&quot;. The minimum height that the editor should have used to concat contents from multiple textareas into a single string deferred which is fired when the editor finishes loading used to allow tab key and shift-tab to indent and outdent rather than navigate events which should be connected to the underlying editing area, events in this array will be addListener with capture=true pre content filter function register array. these filters will be executed before the actual editing area get the html content add some default key handlers Transforms the node referenced in this.domNode into a rich text editing node. Draws an iFrame using the existing one if one exists. Used by Mozilla, Safari, and Opera apply the specified css files in styleSheets add an external stylesheet for the editing area a dojo.uri.Uri pointing to the url of the external css file remove an external stylesheet for the editing area Fired on keydown Fired on keyup registers that attr(&quot;value&quot;, foo) should call setValue(foo) add a handler for a keyboard shortcut Fired on focus remove focus from this instance move focus to this instance This event will be fired everytime the display context changes and the result needs to be reflected in the UI. This event is fired every updateInterval ms or more this is fired if and only if the editor loses focus and the content is changed Used as the advice function by dojo.connect to map our normalized set of commands to those supported by the target browser Tests whether a command is supported by the host. Clients SHOULD check whether a command is supported before attempting to use it, behaviour for unsupported commands is undefined. The command to test for Executes a command in the Rich Text area The command to execute optional argument to the command check whether a command is enabled or not check the state of a given command and returns true or false check the value of a given command. This matters most for custom selections and complex values like font value setting run the named method of dijit._editor.selection over the current editor instance's window, with the passed args place the cursor at the start of the editing area place the cursor at the end of the editing area return the current content of the editing area (post filters are applied) defaults to false. Should the post-filtering be run over a copy of the live DOM? Most users should pass &quot;true&quot; here unless they *really* know that none of the installed filters are going to mess up the editing session. hook to make attr(&quot;value&quot;) work This function sets the content. No undo history is preserved. this function set the content while trying to maintain the undo stack (now only works fine with Moz, this is identical to setValue in all other browsers) filter the input before setting the content of the editing area. DOM pre-filtering may happen after this string-based filtering takes place but as of 1.2, this is not gauranteed for operations such as the inserthtml command. filter the input's live DOM. All filter operations should be considered to be &quot;live&quot; and operating on the DOM that the user will be interacting with in their editing session. filter the output after getting the content of the editing area a node, set of nodes, which to filter using each of the current members of the contentDomPostFilters and contentPostFilters arrays. defaults to &quot;false&quot;. If true, ensures that filtering happens on a clone of the passed-in content and not the actual node itself. Saves the content in an onunload event if the editor has not been closed Adds escape sequences for special characters in XML: &amp;&lt;&gt;&quot;' Optionally skips escapes for single quotes Kills the editor and optionally writes back the modified contents to the element from which it originated. Whether or not to save the changes. If false, the changes are discarded. stub Moz can not handle strong/em tags correctly, convert them to b/i handler after the content of the document finishes loading For auto-expanding editors, this plugin will keep the editor's toolbar visible even when the top of the editor has scrolled off the top of the viewport (usually when editing a long document). <div dojoType="dijit.Editor" height="" extraPlugins="['dijit._editor.plugins.AlwaysShowToolbar']"> Updates the height of the editor area to fit the contents. This plugin tries to make all browsers have identical behavior when the user presses the ENTER key. Specifically, it fixes the double-spaced line problem on IE. Manually handle enter key event to make the behavior consistant across all supported browsers. See property blockNodeForEnter for available options let browser handle this TODO: delete. this code will never fire because onKeyPress --&gt; handleEnterKey is only called when blockNodeForEnter != null Insert CSS so &lt;p&gt; nodes don't have spacing around them, thus hiding the fact that ENTER key on IE is creating new paragraphs Converts a &lt;p&gt; node containing &lt;br&gt;'s into multiple &lt;p&gt; nodes. Called as post-filter. Apparently collapses adjacent &lt;p&gt; nodes into a single &lt;p&gt; nodes with &lt;br&gt; separating each line. Given this input: <p>line 1</p> <p>line 2</p> <ol> <li>item 1 <li>item 2 </ol> <p>line 3</p> <p>line 4</p> Will convert to: <p>line 1<br>line 2</p> <ol> <li>item 1 <li>item 2 </ol> <p>line 3<br>line 4</p> Not sure why this situation would even come up after the pre-filter and the enter-key-handling code. This plugin provides three dropdowns for setting font information in the editor This plugin provides dialogs for inserting links and images into the editor callback from the dialog when user hits &quot;set&quot; button TODO: prevent closing popup if the text is empty This plugin is used to allow the use of the tab and shift-tab keys to indent/outdent list items. This overrides the default behavior of moving focus from/to the toolbar This plugin provides dropdown color pickers for setting text color and background color This plugin is used to toggle direction of the edited document only, no matter what direction the whole page is. Get the selection type (like dojo.doc.select.type in IE). Return the text (no html tags) included in the current selection or null if no text is selected Return the html of the current selection or null if unavailable Retrieves the selected element (if any), just in the case that a single element (object like and image or a table) is selected. Get the parent element of the current selection Check whether current selection has a parent element which is of type tagName (or one of the other specified tagName) Return the parent element of the current selection which is of type tagName (or one of the other specified tagName) clear current selection delete current selection clear previous selection and select the content of the node (excluding the node itself) clear previous selection and select element (including all its children) a constructor of the Container node or node's id to build the container on returns a data item by its key (id) console.log(&quot;Container getItem()&quot;, arguments,this.map, this.map[key], this.selection[key]); prepares the object to be garbage-collected event processor for onmouseover mouse event event processor for onmouseout mouse event changes a named state to new state value a name of the state to change new state gets a child, which is under the mouse at the moment, or null a mouse event adds a class with prefix &quot;dojoDndItem&quot; a node a variable suffix for a class name removes a class with prefix &quot;dojoDndItem&quot; a node a variable suffix for a class name this function is called once, when mouse is over our container this function is called once, when mouse is out of our container unselects all items inserts new data items (see Container's insertNodes method for details) we actually need to add things to the store here instead of adding nodes directly to the tree prepares the object to be garbage-collected event processor for onmousedown mouse event event processor for onmouseup mouse event unselects all items a constructor of the Source can be used as a DnD source, if true; assumed to be &quot;true&quot; if omitted list of accepted types (text strings) for a target; assumed to be [&quot;text&quot;] if omitted horizontal: Boolean: a horizontal container, if true, vertical otherwise or when omitted copyOnly: Boolean: always copy items, if true, use a state of Ctrl key otherwise skipForm: Boolean: don't start the drag operation, if clicked on form elements the rest of parameters are passed to the selector checks, if the target can accept nodes from this source the source which provides items the list of transferred items Returns true, if we need to copy items, false to move. It is separated to be overwritten dynamically, if needed. the &quot;copy&quot; was pressed prepares the object to be garbage-collected event processor for onmousemove mouse event event processor for onmousedown mouse event event processor for onmouseup mouse event event processor for onmouseover mouse event stub funciton to be overridden if one wants to check for the ability to drop at the node/item level topic event processor for /dnd/source/over, called when detected a current source the source which has the mouse over it topic event processor for /dnd/start, called to initiate the DnD operation the source which provides items the list of transferred items copy items, if true, move items otherwise Topic event processor for /dnd/drop, called to finish the DnD operation.. Updates data store items according to where node was dragged from and dropped to. The tree will then respond to those data store updates and redraw itself. the source which provides items the list of transferred items copy items, if true, move items otherwise topic event processor for /dnd/cancel, called to cancel the DnD operation this function is called once, when mouse is over our container this function is called once, when mouse is out of our container assigns a class to the current target anchor based on &quot;before&quot; status insert before, if true, after otherwise removes a class of the current target anchor based on &quot;before&quot; status changes source's state based on &quot;copy&quot; status a constructor of the Target --- see the Source constructor for details destroys this object, releasing connections to the store Calls onItem with the root item for the tree, possibly a fabricated item. Throws exception on error. returns identity for an item get the label for an item Basically the same thing as a normal HTML button, but with special styling. <button dojoType="dijit.form.Button" onClick="...">Hello world</button> Set this to true to hide the label text and display only the icon. (If showLabel=false then iconClass must be specified.) Especially useful for toolbars. If showLabel=true, the label will become the title (a.k.a. tooltip/hint) of the icon. The exception case is for computers in high-contrast mode, where the label will still be displayed, since the icon doesn't appear. Class to apply to div in button to make it display an icon internal function to handle click actions callback when the user activates the button portion if is activated via a keystroke, stop the event If button label is specified as srcNodeRef.innerHTML rather than this.params.label, handle it here. user callback for when button is clicked if type=&quot;submit&quot;, return true to perform submit internal replaceable function for when the button is clicked Hook for attr('label', ...) to work. A button with a popup <button dojoType="dijit.form.DropDownButton" label="Hello world"> <div dojotype="dijit.Menu">...</div> </button> callback when the user mouse clicks on menu popup node callback when the user presses a key on menu popup node called magically when focus has shifted away from this widget and it's dropdown toggle the drop-down widget; if it is up, close it, if not, open it A Normal Button with a DropDown <button dojoType="dijit.form.ComboButton" onClick="..."> <span>Hello world</span> <div dojoType="dijit.Menu">...</div> </button> text that describes the options menu (accessibility) Focus the focal node node. Returns true if this widget has no node currently focused or if there is a node following the focused one. False is returned if the last node has focus. Focus the focal node following the current node with focus or the first one if no node currently has focus. Returns true if this widget has no node currently focused or if there is a node before the focused one. False is returned if the first node has focus. Focus the focal node before the current node with focus or the last one if no node currently has focus. Returns an array of focal nodes for this widget. A button that can be in two states (checked or not). Can be base class for things like tabs or checkbox or radio buttons Corresponds to the native HTML &lt;input&gt; element's attribute. In markup, specified as &quot;checked='checked'&quot; or just &quot;checked&quot;. True if the button is depressed, or the checkbox is checked, or the radio button is selected, etc. Programatically deselect the button Same as an HTML checkbox, but with fancy styling. As an initialization parameter, equivalent to value field on normal checkbox (if checked, the value is passed as the value when form is submitted). However, attr('value') will return either the string or false depending on whether or not the checkbox is checked. attr('value', string) will check the checkbox and change the value to the specified string attr('value', boolean) will change the checked state. Handler for value= attribute to constructor, and also calls to attr('value', val). Hook so attr('value') works. Same as an HTML radio, but with fancy styling. Implements the base functionality for ComboBox/FilteringSelect Argument to data provider. Specifies number of search results per page (before hitting &quot;next&quot; button) Reference to data provider object used by this ComboBox Mixin to the dojo.data store's fetch. For example, to set the sort order of the ComboBox menu, pass: {sort:{attribute:&quot;name&quot;,descending:true}} Focus-less div based menu for internal use in ComboBox Returns the highlighted option. Auto-completing text box, and base class for dijit.form.FilteringSelect. Hook so attr('value', value) works. Inefficient but small data store specialized for inlined ComboBox data See dojo.data.util.simpleFetch.fetch() Given the identity of an item, this method returns the item that has that identity through the onItem callback. Refer to dojo.data.api.Identity.fetchItemByIdentity() for more details. Get the option marked as selected, like `&lt;option selected&gt;`. Not part of dojo.data API. A validating currency textbox the [ISO4217](http://en.wikipedia.org/wiki/ISO_4217) currency code, a three letter sequence like &quot;USD&quot; parses the value as a Currency, according to constraints A validating, serializable, range-bound date text box with a popup calendar Callback function that dynamically sets the label of the ComboBox Hook for attr('value') to work. Hook so attr('value', value) works. Set the displayed valued in the input box, based on a selected item. Event handler called when the label changes return: the label that the ComboBox should display ComboBox's menu callback function Hook so attr('displayedValue', label) works. Widget corresponding to HTML form tag, for validation and serialization <form dojoType="dijit.form.Form" id="myForm"> Name: <input type="text" name="name" /> </form> myObj = {name: "John Doe"}; dijit.byId('myForm').attr('value', myObj); myObj=dijit.byId('myForm').attr('value'); returns if the form is valid - same as isValid - but provides a few additional (ui-specific) features. 1 - it will highlight any sub-widgets that are not valid 2 - it will call focus() on the first invalid sub-widget Fill in form values from according to an Object (in the format returned by attr('value')) Returns Object representing form values. { name: "John Smith", interests: ["sports", "movies"] } make sure that every widget that has a validator function returns true stub function to connect to if you want to do something (like disable/enable a submit button) when the valid state changes on the form as a whole. connected to a widgets onChange function - update our valid state, if needed. connects to the onChange function of all children to track valid state changes. You can call this function directly, ie. in the event that you programmatically add a widget to the form *after* the form has been initialized Adds conveniences to regular HTML form Deprecated: use submit() Deprecated: use onSubmit() Callback when user resets the form. This method is intended to be over-ridden. When the `reset` method is called programmatically, the return value from `onReset` is used to compute whether or not resetting should proceed Callback when user submits the form. This method is intended to be over-ridden, but by default it checks and returns the validity of form elements. When the `submit` method is called programmatically, the return value from `onSubmit` is used to compute whether or not submission should proceed programmatically submit form if and only if the `onSubmit` returns true Wrapper for a native select multiple=&quot;true&quot; element to interact with dijit.form.Form Move the selected nodes af an passed Select widget instance to this Select widget. // move all the selected values from "bar" to "foo" dijit.byId("foo").addSelected(dijit.byId("bar")); Access the NodeList of the selected options directly Hook so attr('value') works. Hook so attr('value', values) works. Invert the selection If null, onChange is not fired. extends NumberTextBox to add up/down arrows and pageup/pagedown for incremental change to the value change Number val by the given amount A validating, serializable, range-bound text box. A mixin for all number textboxes formats the value as a Number, according to constraints parses the value as a Number, according to constraints Hook so attr('value') works. properties to mix into constraints when the value is being edited A simple textarea that degrades, and responds to minimal LayoutContainer usage, and works with dijit.form.Form. Doesn't automatically size according to input, like Textarea. <textarea dojoType="dijit.form.SimpleTextarea" name="foo" value="bar" rows=30 cols=40/> The number of characters per line. Show increment/decrement buttons at the ends of the slider? The minimum value allowed. The maximum allowed value. The maximum allowed values dispersed evenly between minimum and maximum (inclusive). The amount of change via pageup/down If clicking the progress bar changes the value or not The time in ms to take to animate the slider handle from 0% to 100% Hook so attr('value', value) works. Event handler for mousewheel where supported Specifies if the slider values go from high-on-top (true), or low-on-top (false) TODO: expose this in 1.2 - the css progress/remaining bar classes need to be reversed Rectify children nodes for left/right decoration in rtl case. Simply switch the rule and label child for each decoration node. Number of hash marks to generate If this is a child widget, connect it to this parent node CSS style to apply to individual hash marks CSS style to apply to individual text labels Array of text labels to render - evenly spaced from left-to-right or bottom-to-top Number of generated numeric labels that should be rendered as '' on the ends when labels[] are not specified user replaceable function to return the labels array pattern, places, lang, et al (see dojo.number) for generated numeric labels when labels[] are not specified A base class for textbox form inputs Converts all characters to uppercase if true. Default is false. Converts all characters to lowercase if true. Default is false. Converts the first character of each word to uppercase if true. HTML INPUT tag maxLength declaration. For subclasses like ComboBox where the displayed value (ex: Kentucky) and the serialized value (ex: KY) are different, this represents the displayed value. Setting 'displayedValue' through attr('displayedValue', ...) updates 'value', and vice-versa. Othewise 'value' is updated from 'displayedValue' periodically, like onBlur etc. TODO: move declaration to MappedTextBox? Problem is that ComboBox references displayedValue, for benefit of FilteringSelect. Hook so attr('value') works as we like. Hook so attr('value', ...) works. visual element value is also set to a corresponding, but not necessarily the same, value. If true, an onChange event is fired immediately instead of waiting for the next blur event. If specified, used to set the visual element value, otherwise a computed visual value is used. Hook so attr('displayedValue') works. Hook so attr('displayedValue', ...) works. Replacable function to convert a value to a properly formatted string Replacable function to convert a formatted string to a value Auto-corrections (such as trimming) that are applied to textbox value on blur or form submit A resizing textarea widget <textarea dojoType="dijit.form.TextArea">...</textarea> set whether user can write into textbox, based on this.disabled and this.readOnly Received focus, needed for the InlineEditBox widget Hook so attr('value', ...) works. Hook so attr('value') works. event handler for when a change is imminent event handler for when a change has already happened A validating, serializable, range-bound time text box with a popup time picker A TextBox subclass with the ability to validate content of various types and provide user feedback. values for new subclass properties Boolean Can be true or false, default is false. Hint string The message to display if value is invalid. regular expression string used to validate the input Do not specify both regExp and regExpGen Shows current state (ie, validation result) of input (Normal, Warning, or Error) See description of dijit.Tooltip.defaultPosition for details on this parameter. user replaceable function used to generate regExp when dependent on constraints Do not specify both regExp and regExpGen Hook so attr('value', ...) works. user replaceable function used to validate the text input against the regular expression. Returns true if the value is either already valid or could be made valid by appending characters. Need to over-ride with your own validation code in subclasses Checks for whitespace return an error message to show if appropriate return a hint to show if appropriate Called by oninit, onblur, and onkeypress. User overridable method to display validation errors/hints. By default uses a tooltip. user-defined object needed to pass parameters to the validator functions A dijit.form.ValidationTextBox subclass which provides a visible formatted display and a serializable value in a hidden input field which is actually sent to the server. The visible display may be locale-dependent and interactive. The value sent to the server is stored in a hidden input field which uses the `name` attribute declared by the original widget. That value sent to the serveris defined by the dijit.form.MappedTextBox.serialize method and is typically locale-neutral. user replaceable function used to convert the attr('value') result to a String display the widget as a printable string using the widget's value TODO: seems like the filter() call here is unnecessary as attr('value') should do that A dijit.form.MappedTextBox subclass which defines a range of valid values The message to display if value is out-of-range user replaceable function used to validate the range of the numeric input value Need to over-ride with your own validation code in subclasses Returns true if the value is out of range and will remain out of range even if the user types more characters Hook so attr('value', ...) works. locale used for validation, picks up value from this widget's lang attribute various flags passed to regExpGen function Minimum signed value. Default is -Infinity Maximum signed value. Default is +Infinity A validating, serializable, range-bound date or time text box. The value of this widget as a JavaScript Date object. Use attr(&quot;value&quot;) / attr(&quot;value&quot;, val) to manipulate. When passed to the parser in markup, must be specified according to `dojo.date.stamp.fromISOString` Name of the popup widget class used to select a date/time formats the value as a Date, according to constraints parses the value as a Date, according to constraints open the TimePicker popup Sets the date on this textbox. Note that `value` must be a Javascript Date object. opens the TimePicker, and sets the onValueSelected value called magically when focus has shifted away from this widget and it's dropdown _FormWidget's correspond to native HTML elements such as &lt;checkbox&gt; or &lt;button&gt;. Root CSS class of the widget (ex: dijitTextBox), used to add CSS classes of widget (ex: &quot;dijitTextBox dijitTextBoxInvalid dijitTextBoxFocused dijitTextBoxInvalidFocused&quot;) See _setStateClass(). Name used when submitting form; same as &quot;name&quot; attribute or plain HTML elements Corresponds to the native HTML &lt;input&gt; element's attribute. Corresponds to the native HTML &lt;input&gt; element's attribute. Corresponds to the native HTML &lt;input&gt; element's attribute. Order fields are traversed when user hits the tab key Should this widget respond to user input? In markup, this is specified as &quot;disabled='disabled'&quot;, or just &quot;disabled&quot;. Should this widget respond to user input? In markup, this is specified as &quot;readOnly&quot;. Similar to disabled except readOnly form values are submitted Fires onChange for each value change or only on demand Set disabled state of widget (Deprecated). Sets _hovering, _active, and stateModifier properties depending on mouse state, then calls setStateClass() to set appropriate CSS classes for this.domNode. To get a different CSS class for hover, send onmouseover and onmouseout events to this method. To get a different CSS class while mouse button is depressed, send onmousedown to this method. compare 2 values callback when value is changed set the value of the widget. work around table sizing bugs on FF2 by forcing redraw Hook so attr('value', value) works. Hook so attr('value') works. restore the value to the last value passed to onChange fraction of time used to change the typematic timer between events 1.0 means that each typematic event fires at defaultTimeout intervals &lt; 1.0 means that each typematic event fires at an increasing faster rate adjust the value by this much when spinning using the arrow keys/buttons adjust the value by this much when spinning using the PgUp/Dn keys user replaceable function used to adjust a primitive value(Number/Date/...) by the delta amount specified the val is adjusted in a way that makes sense to the object type Mouse wheel listener where supported Holds a set of panes where every pane's title is visible, but only one pane's content is visible at a time, and switching between panes is visualized by sliding the other panes up/down. <div dojoType="dijit.layout.AccordionContainer"> <div dojoType="dijit.layout.AccordionPane" title="pane 1"> <div dojoType="dijit.layout.ContentPane">...</div> </div> <div dojoType="dijit.layout.AccordionPane" title="pane 2"> <p>This is some text</p> | ... </div> Amount of time (in ms) it takes to slide panes For the given node, returns the height that should be set to achieve our vertical space (subtract any padding we may have) Set the height of the open pane based on what room remains AccordionPane is a ContentPane with a title that may contain another widget. Nested layout widgets, such as SplitContainer, are not supported at this time. see dijit.layout.AccordionContainer returns the height of the title dom node callback when someone clicks my title callback when someone hovers over my title callback when someone stops hovering over my title handle the blur and focus state of this widget change the selected state on this pane called when this pane is selected Provides layout in 5 regions, a center and borders along its 4 sides. <style> html, body { height: 100%; width: 100%; } </style> <div dojoType="BorderContainer" design="sidebar" style="width: 100%; height: 100%"> <div dojoType="ContentPane" region="top">header text</div> <div dojoType="ContentPane" region="right" style="width: 200px;">table of contents</div> <div dojoType="ContentPane" region="center">client area</div> </div> Give each pane a border and margin. Margin determined by domNode.paddingLeft. When false, only resizable panes have a gutter (i.e. draggable splitter) for resizing. specifies whether splitters resize as you drag (true) or only upon mouseup (false) Save splitter positions in a cookie. Optional hook to override the default Splitter widget used by BorderContainer returns the widget responsible for rendering the splitter associated with region A draggable spacer between two items in a BorderContainer If true, the child's size changes and the child widget is redrawn as you drag the splitter; otherwise, the size doesn't change until you drop the splitter (by mouse-up) Just a spacer div to separate side pane from center pane. Basically a trick to lookup the gutter/splitter width from the theme. A widget that acts as a Container for other widgets, and includes a ajax interface Some quick samples: To change the innerHTML use .attr('content', '<b>new content</b>') Or you can send it a NodeList, .attr('content', dojo.query('div [class=selected]', userSelection)) please note that the nodes in NodeList will copied, not moved To do a ajax update use .attr('href', url) The innerHTML of the ContentPane. Note that the initialization parameter / argument to attr(&quot;content&quot;, ...) can be a String, DomNode, Nodelist, or widget. Extract visible content from inside of &lt;body&gt; .... &lt;/body&gt; parse content and create the widgets, if any Cache content retreived externally Force load of data even if pane is hidden. Refresh (re-download) content when pane goes from hidden to shown Message that shows while downloading Message that shows if an error occurs Tells loading status see onLoad|onUnload for event hooks - false - don't adjust size of children - true - if there is a single visible child widget, set it's size to however big the ContentPane is Test if we have exactly one visible widget as a child, and if so assume that we are a container for that widget, and should propogate startup() and resize() calls to it. Skips over things like data stores since they aren't visible. Force a refresh (re-download) of content, be sure to turn off cache Hook so attr(&quot;href&quot;, ...) works. url to the page you want to get, must be within the same domain as your mainpage Hook to make attr(&quot;content&quot;, ...) work. Replaces old content with data content, include style classes from old content the new Content may be String, DomNode or NodeList if data is a NodeList (or an array of nodes) nodes are copied so you can import nodes from another document implicitly hook to make attr(&quot;content&quot;) work Cancels a inflight download of content Destroy the ContentPane and it's contents returns true if the content is currently shown This is called whenever new content is being loaded This is called whenever the content is being unloaded Destroy all the widgets inside the ContentPane and empty containerNode Insert the content into the container node scan my contents and create subwidgets Event hook, is called after everything is loaded and widgetified Event hook, is called before old content is cleared called before download starts the string returned by this function will be the html that tells the user we are loading something override with your own function if you want to change text called on DOM faults, require fault etc in content default is to display errormessage inside pane Called when download error occurs, default is to display errormessage inside pane. Overide function to change that. The string returned by this function will be the html that tells the user a error happend called when download is finished Alias for the global scope (e.g. the window object in a browser). the locale as defined by Dojo (read-only) True if the client is a web-browser | undefined Version as a Number if client is FireFox. undefined otherwise. Corresponds to major detected FireFox version (1.5, 2, 3, etc.) | undefined Version as a Number if client is MSIE(PC). undefined otherwise. Corresponds to major detected IE version (6, 7, 8, etc.) | undefined Version as a Number if client is Safari or iPhone. undefined otherwise. | undefined Version as a Number if client is a KTHML-derived browser (Konqueror, Safari, etc.). undefined otherwise. Corresponds to major detected version. | undefined Version as a Number if client is a Mozilla-based browser (Firefox, SeaMonkey). undefined otherwise. Corresponds to major detected version. | undefined Version as a Number if client is Opera. undefined otherwise. Corresponds to major detected version. The root relative path to dojo.js (as a string) Alias for the current document. 'dojo.doc' can be modified for temporary context shifting. Also see dojo.withDoc(). Detect spidermonkey D.O.H. Test files for Dojo unit testing. blend colors end and start with weight from 0 to 1, 0.5 being a 50/50 blend, can reuse a previously allocated dojo.Color object for the result get rgb(a) array from css-style color declarations converts a hex string with a '#' prefix to a color object. Supports 12-bit #rgb shorthand. builds a color from 1, 2, 3, or 4 element array parses str for a color value. a dojo.Color object. If obj is passed, it will be the return value. Log a debug message to indicate that a behavior has been deprecated. The API or behavior being deprecated. Usually in the form of &quot;myApp.someFunction()&quot;. Text to append to the message. Text to indicate when in the future the behavior will be removed. dojo.deprecated("myApp.getTemp()", "use myApp.getLocaleTemp() instead", "1.0"); Adds all properties and methods of props to obj. This addition is &quot;prototype extension safe&quot;, so that instances of objects will not pass along prototype defaults. Adds all properties and methods of props to obj and returns the (now modified) obj. The object to mix properties into. Also the return value. One or more objects whose values are successively copied into obj. If more than one of these objects contain the same value, the one specified last in the function call will &quot;win&quot;. make a shallow copy of an object var copy = dojo.mixin({}, source); Set a property from a dot-separated string, such as &quot;A.B.C&quot; Path to a property, in the form &quot;A.B.C&quot;. Optional. Object to use as root of path. Defaults to `dojo.global`. set the value of `foo.bar.baz`, regardless of whether intermediate objects already exist: dojo.setObject("foo.bar.baz", value); Get a property from a dot-separated string, such as &quot;A.B.C&quot; Path to an property, in the form &quot;A.B.C&quot;. Optional. Defaults to `false`. If `true`, Objects will be created at any point along the 'path' that is undefined. Optional. Object to use as root of path. Defaults to 'dojo.global'. Null may be passed. determine if an object supports a given method Path to an object, in the form &quot;A.B.C&quot;. to use as root of path. Defaults to 'dojo.global'. Null may be passed. // define an object var foo = { bar: { } }; // search the global scope dojo.exists("foo.bar"); // true dojo.exists("foo.bar.baz"); // false // search from a particular scope dojo.exists("bar", foo); // true dojo.exists("bar.baz", foo); // false Perform an evaluation in the global scope. Use this rather than calling 'eval()' directly. The result of the evaluation. Often `undefined` Marks code as experimental. The name of a module, or the name of a module file or a specific function some additional message for the user dojo.experimental("dojo.data.Result"); does the work of portably generating a new XMLHTTPRequest object. Read the contents of the specified uri and return those contents. The response text. null is returned when there is a failure and failure is okay (an exception otherwise) A relative or absolute uri. If absolute, it still must be in the same &quot;domain&quot; as we are. Default false. If fail_ok and loading fails, return null instead of throwing. signal fired by impending window destruction. You may use dojo.addOnWIndowUnload() or dojo.connect() to this method to perform page/application cleanup methods. See dojo.addOnWindowUnload for more info. registers a function to be triggered when window.onunload fires. Be careful trying to modify the DOM or access JavaScript properties during this phase of page unloading: they may not always be available. Consider dojo.addOnUnload() if you need to modify the DOM or do heavy JavaScript work. dojo.addOnWindowUnload(functionPointer) dojo.addOnWindowUnload(object, "functionName") dojo.addOnWindowUnload(object, function(){ /* ... */}); Returns DOM node with matching `id` attribute or `null` if not found, similar to &quot;$&quot; function in another library. If `id` is a DomNode, this function is a no-op. A string to match an HTML id attribute or a reference to a DOM Node Document to work in. Defaults to the current value of dojo.doc. Can be used to retrieve node references from other documents. Internal xd loader function. Overrides loadUri() from loader.js. xd loading requires slightly different behavior from loadPath(). a uri which points at the script to be loaded a callback function to process the result of evaluating the script as an expression, typically used by the resource bundle loader to load JSON-style resources Return the body element of the document return the body object associated with dojo.doc dojo.body().appendChild(dojo.doc.createElement('div')); Internal xd loader function. Overrides loadPath() from loader.js. xd loading requires slightly different behavior from loadPath(). A relative path to a script (no leading '/', and typically ending in '.js'). A module whose existance to check for after loading a path. Can be used to determine success or failure of the load. a callback function to pass the result of evaluating the script calls loadUri then findModule and returns true if both succeed signal fired when initial environment and package loading is complete. You may use dojo.addOnLoad() or dojo.connect() to this method in order to handle initialization tasks that require the environment to be initialized. In a browser host, declarative widgets will be constructed when this function finishes runing. signal fired by impending environment destruction. You may use dojo.addOnUnload() or dojo.connect() to this method to perform page/application cleanup methods. See dojo.addOnUnload for more info. Registers a function to be triggered after the DOM has finished loading and widgets declared in markup have been instantiated. Images and CSS files may or may not have finished downloading when the specified function is called. (Note that widgets' CSS and HTML code is guaranteed to be downloaded before said widgets are instantiated.) dojo.addOnLoad(functionPointer); dojo.addOnLoad(object, "functionName"); dojo.addOnLoad(object, function(){ /* ... */}); registers a function to be triggered when the page unloads. In a browser enviroment, the functions will be triggered during the window.onbeforeunload event. Be careful doing work during window.onbeforeunload. onbeforeunload can be triggered if a link to download a file is clicked, or if the link is a javascript: link. In these cases, the onbeforeunload event fires, but the document is not actually destroyed. So be careful about doing destructive operations in a dojo.addOnUnload callback. dojo.addOnUnload(functionPointer) dojo.addOnUnload(object, "functionName") dojo.addOnUnload(object, function(){ /* ... */}); Converts a module name in dotted JS notation to an array representing the path in the source tree Executes a function that needs to be executed for the loader's dojo.requireIf resolutions to work. This is needed mostly for the xdomain loader case where a function needs to be executed to set up the possible values for a dojo.requireIf call. a function reference. Executed immediately. loads a Javascript module from the appropriate URI the required namespace object module name to load, using periods for separators, e.g. &quot;dojo.date.locale&quot;. Module paths are de-referenced by dojo's internal mapping of locations to names and are disambiguated by longest prefix. See `dojo.registerModulePath()` for details on registering new modules. if `true`, omitModuleCheck skips the step of ensuring that the loaded file actually defines the symbol it is referenced by. For example if it called as `dojo.require(&quot;a.b.c&quot;)` and the file located at `a/b/c.js` does not define an object `a.b.c`, and exception will be throws whereas no exception is raised when called as `dojo.require(&quot;a.b.c&quot;, true)` Each javascript source file must have at least one `dojo.provide()` call at the top of the file, corresponding to the file name. For example, `js/dojo/foo.js` must have `dojo.provide(&quot;dojo.foo&quot;);` before any calls to `dojo.require()` are made. require one or more modules based on which host environment Dojo is currently operating in dojo.platformRequire({ browser: [ "foo.sample", // simple module "foo.test", ["foo.bar.baz", true] // skip object check in _loadModule (dojo.require) ], default: [ "foo.sample._base" ], common: [ "important.module.common" ] }); If the condition is true then call dojo.require() for the specified resource maps a module name to a path If your dojo.js is located at this location in the web root: /myapp/js/dojo/dojo/dojo.js and your modules are located at: /myapp/js/foo/bar.js /myapp/js/foo/baz.js /myapp/js/foo/thud/xyzzy.js Your application can tell Dojo to locate the "foo" namespace by calling: dojo.registerModulePath("foo", "../../foo"); At which point you can then use dojo.require() to load the modules (assuming they provide() the same things which are required). The full code might be: <script type="text/javascript" src="/myapp/js/dojo/dojo/dojo.js"></script> <script type="text/javascript"> dojo.registerModulePath("foo", "../../foo"); dojo.require("foo.bar"); dojo.require("foo.baz"); dojo.require("foo.thud.xyzzy"); </script> loads a bundle intelligently based on whether the module is local or xd. Overrides the local-case implementation. name of the package containing the &quot;nls&quot; directory in which the bundle is found bundle name, i.e. the filename without the '.js' suffix the locale to load (optional) By default, the browser's user locale as defined by dojo.locale A comma-separated list of the available, flattened locales for this bundle. This argument should only be set by the build process. A particular widget may define one or more resource bundles, structured in a program as follows, where moduleName is mycode.mywidget and bundleNames available include bundleone and bundletwo: ... mycode/ mywidget/ nls/ bundleone.js (the fallback translation, English in this example) bundletwo.js (also a fallback translation) de/ bundleone.js bundletwo.js de-at/ bundleone.js en/ (empty; use the fallback translation) en-us/ bundleone.js en-gb/ bundleone.js es/ bundleone.js bundletwo.js ...etc ... Returns a `dojo._Url` object relative to a module. var pngPath = dojo.moduleUrl("acme","images/small.png"); console.dir(pngPath); // list the object properties // create an image and set it's source to pngPath's value: var img = document.createElement("img"); // NOTE: we assign the string representation of the url object img.src = pngPath.toString(); // add our image to the document dojo.body().appendChild(img); Internal xd loader function. Resets the xd state. Internal xd loader function. Creates an xd module source given an non-xd module contents. Figure out whether the path is local or x-domain If there is a colon before the first / then, we have a URL with a protocol. Internal xd loader function. Called by an xd module resource when it has been loaded via a script tag. Evaluate the function with scopeArgs for multiversion support. Internal xd loader function. Used when loading a flattened localized bundle via a script tag. Internal xd loader function. The xd version of dojo.requireLocalization. Internal xd loader function. Determines what to do with a dependency that was listed in an xd version of a module contents. Internal xd loader function. Walks the requires and evaluates module resource contents in the right order. Internal xd loader function. Does a depth first, breadth second search and eval of required modules. Internal xd loader function. Clears the interval timer used to check on the status of in-flight xd module resource requests. Internal xd loader function. Monitors in-flight requests for xd module resources. locates the first index of the provided value in the passed array. If the value is not found, -1 is returned. locates the last index of the provided value in the passed array. If the value is not found, -1 is returned. for every item in arr, callback is invoked. Return values are ignored. the array to iterate over. If a string, operates on individual characters. a function is invoked with three arguments: item, index, and array may be used to scope the call to callback // log out all members of the array: dojo.forEach( [ "thinger", "blah", "howdy", 10 ], function(item){ console.debug(item); } ); Determines whether or not every item in arr satisfies the condition implemented by callback. the array to iterate on. If a string, operates on individual characters. a function is invoked with three arguments: item, index, and array and returns true if the condition is met. may be used to scope the call to callback // returns false dojo.every([1, 2, 3, 4], function(item){ return item>1; }); Determines whether or not any item in arr satisfies the condition implemented by callback. the array to iterate over. If a string, operates on individual characters. a function is invoked with three arguments: item, index, and array and returns true if the condition is met. may be used to scope the call to callback // is true dojo.some([1, 2, 3, 4], function(item){ return item>1; }); applies callback to each element of arr and returns an Array with the results the array to iterate on. If a string, operates on individual characters. a function is invoked with three arguments, (item, index, array), and returns a value may be used to scope the call to callback // returns [2, 3, 4, 5] dojo.map([1, 2, 3, 4], function(item){ return item+1 }); Returns a new Array with those items from arr that match the condition implemented by callback. the array to iterate over. a function that is invoked with three arguments (item, index, array). The return of this function is expected to be a boolean which determines whether the passed-in item will be included in the returned array. may be used to scope the call to callback // returns [2, 3, 4] dojo.filter([1, 2, 3, 4], function(item){ return item>1; }); Create a link that calls one function when another executes. The source object for the event function. Defaults to dojo.global if null. If obj is a DOM node, the connection is delegated to the DOM event manager (unless dontFix is true). name of the event function in obj. I.e. identifies a property obj[event]. The object that method will receive as &quot;this&quot;. If context is null and method is a function, then method inherits the context of event. If method is a string then context must be the source object object for method (context[method]). If context is null, dojo.global is used. A function reference, or name of a function in context. The function identified by method fires after event does. method receives the same arguments as the event. See context argument comments for information on method's scope. If obj is a DOM node, set dontFix to true to prevent delegation of this connection to the DOM event manager. When obj.onchange(), do ui.update(): dojo.connect(obj, "onchange", ui, "update"); dojo.connect(obj, "onchange", ui, ui.update); // same Remove a link created by dojo.connect. the return value of the dojo.connect call that created the connection. Ensure that everytime obj.event() is called, a message is published on the topic. Returns a handle which can be passed to dojo.disconnect() to disable subsequent automatic publication on the topic. The name of the topic to publish. The source object for the event function. Defaults to dojo.global if null. The name of the event function in obj. I.e. identifies a property obj[event]. dojo.connectPublisher("/ajax/start", dojo, "xhrGet"); normalizes properties on the event object including event bubbling methods, keystroke normalization, and x/y positions native event object node to treat as &quot;currentTarget&quot; prevents propagation and clobbers the default action of the passed event The event object. If omitted, window.event is used on IE. Returns an animation that will fade the node defined by args.node from the start to end values passed (args.start args.end) (end is mandatory, start is optional) Returns an animation that will fade node defined in 'args' from its current opacity to fully opaque. Returns an animation that will fade node defined in 'args' from its current opacity to fully transparent. The default easing function for dojo._Animation(s) A simpler interface to `dojo.animateProperty()`, also returns an instance of `dojo._Animation` but begins the animation immediately, unlike nearly every other Dojo animation API. a DOM node or the id of a node to animate CSS properties on The number of milliseconds over which the animation should run. Defaults to the global animation default duration (350ms). An easing function over which to calculate acceleration and deceleration of the animation through its duration. A default easing algorithm is provided, but you may plug in any you wish. A large selection of easing algorithms are available in `dojo.fx.easing`. A function to be called when the animation finishes running. The number of milliseconds to delay beginning the animation by. The default is 0. Fade out a node dojo.anim("id", { opacity: 0 }); Returns a &quot;computed style&quot; object. A reference to a DOM node. Does NOT support taking an ID string for speed reasons. dojo.getComputedStyle(dojo.byId('foo')).borderWidth; Returns the current opacity of the passed node as a floating-point value between 0 and 1. Number between 0 and 1 a reference to a DOM node. Does NOT support taking an ID string for speed reasons. set the opacity of the passed node portably. Returns the new opacity of the node. Number between 0 and 1 a reference to a DOM node. Does NOT support taking an ID string for performance reasons. A Number between 0 and 1. 0 specifies transparent. removes node from its parent, clobbers it and all of its children. the element to be destroyed, either as an ID or a reference Returns true if node is a descendant of ancestor id or node reference to test id or node reference of potential parent to test against enable or disable selection on a node id or reference to node Attempt to insert node into the DOM, choosing from various positioning options. Returns true if successful, false otherwise. id or node reference to place relative to refNode id or node reference to use as basis for placement string noting the position of node relative to refNode or a number indicating the location in the childNodes collection of refNode. Accepted string values are: * before * after * first * last &quot;first&quot; and &quot;last&quot; indicate positions as children of refNode. position defaults to &quot;last&quot; if not specified Accesses styles on a node. If 2 arguments are passed, acts as a getter. If 3 arguments are passed, acts as a setter. id or reference to node to get/set style for the style property to set in DOM-accessor format (&quot;borderWidth&quot;, not &quot;border-width&quot;) or an object with key/value pairs suitable for setting each property. If passed, sets value on the node for style, handling cross-browser concerns. Passing only an ID or node returns the computed style object of the node: dojo.style("thinger"); Returns object with special values specifically useful for node fitting. * l/t = left/top padding (respectively) * w = the total of the left and right padding * h = the total of the top and bottom padding If 'node' has position, l/t forms the origin for child nodes. The w/h are used for calculating boxes. Normally application code will not need to invoke this directly, and will use the ...box... functions instead. returns an object with properties useful for noting the border dimensions. * l/t = the sum of left/top border (respectively) * w = the sum of the left and right border * h = the sum of the top and bottom border The w/h are used for calculating boxes. Normally application code will not need to invoke this directly, and will use the ...box... functions instead. returns object with properties useful for box fitting with regards to padding. * l/t = the sum of left/top padding and left/top border (respectively) * w = the sum of the left and right padding and border * h = the sum of the top and bottom padding and border The w/h are used for calculating boxes. Normally application code will not need to invoke this directly, and will use the ...box... functions instead. returns object with properties useful for box fitting with regards to box margins (i.e., the outer-box). * l/t = marginLeft, marginTop, respectively * w = total width, margin inclusive * h = total height, margin inclusive The w/h are used for calculating boxes. Normally application code will not need to invoke this directly, and will use the ...box... functions instead. returns an object that encodes the width, height, left and top positions of the node's margin box. Returns an object that encodes the width, height, left and top positions of the node's content box, irrespective of the current box model. sets width/height/left/top in the current (native) box-model dimentions. Uses the unit passed in u. DOM Node reference. Id string not supported for performance reasons. optional. left offset from parent. optional. top offset from parent. optional. width in current box model. optional. width in current box model. optional. unit measure to use for other measures. Defaults to &quot;px&quot;. True if the node is BUTTON or INPUT.type=&quot;button&quot;. True if the node uses border-box layout. Sets the size of the node's contents, irrespective of margins, padding, or borders. sets the size of the node's margin box and placement (left/top), irrespective of box model. Think of it as a passthrough to dojo._setBox that handles box-model vagaries for you. Getter/setter for the margin-box of node. id or reference to DOM Node to get/set box for If passed, denotes that dojo.marginBox() should update/set the margin box for node. Box is an object in the above format. All properties are optional if passed. Getter/setter for the content-box of node. id or reference to DOM Node to get/set box for If passed, denotes that dojo.contentBox() should update/set the content box for node. Box is an object in the above format. All properties are optional if passed. Gets the position of the passed element relative to the viewport (if includeScroll==false), or relative to the document root (if includeScroll==true). Returns an object of the form: { x: 100, y: 300 } if includeScroll is passed, the x and y values will include any document offsets that may affect the position relative to the viewport. Returns an object that measures margin box width/height and absolute positioning data from dojo._abs(). Returns true if the requested attribute is specified on the given element, and false otherwise. true if the requested attribute is specified on the given element, and false otherwise id or reference to the element to check the name of the attribute Gets or sets an attribute on an HTML element. when used as a getter, the value of the requested attribute or null if that attribute does not have a specified or default value; when user as a setter, undefined id or reference to the element to get or set the attribute on the name of the attribute to get or set. The value to set for the attribute // get the current value of the "foo" attribute on a node dojo.attr(dojo.byId("nodeId"), "foo"); // or we can just pass the id: dojo.attr("nodeId", "foo"); Removes an attribute from an HTML element. id or reference to the element to remove the attribute from the name of the attribute to remove Returns whether or not the specified classes are a portion of the class list currently applied to the node. Adds the specified classes to the end of the class list on the passed node. Removes the specified classes from node. Adds a class to node if not present, or removes if present. Pass a boolean condition if you want to explicitly add or remove. If passed, true means to add the class, false means to remove. Parses a [JSON](http://json.org) string to return a JavaScript object. Throws for invalid JSON strings. a string literal of a JSON item, for instance: `'{ &quot;foo&quot;: [ &quot;bar&quot;, 1, { &quot;baz&quot;: &quot;thud&quot; } ] }'` Adds escape sequences for non-visual characters, double quote and backslash and surrounds with double quotes to form a valid string literal. Returns a [JSON](http://json.org) serialization of an object. an object to be serialized. Objects may define their own serialization via a special &quot;__json__&quot; or &quot;json&quot; function property. If a specialized serializer has been defined, it will be used as a fallback. if true, we indent objects and arrays to make the output prettier. The variable dojo.toJsonIndentStr is used as the indent string -- to use something other than the default (tab), change that variable before calling dojo.toJson(). private variable for recursive calls when pretty printing, do not use. Return true if it is a String Return true if it is an Array Return true if it is a Function Returns true if it is a JavaScript object (or an Array, a Function or null) similar to dojo.isArray() but more permissive If it walks like a duck and quicks like a duck, return `true` Returns true if it is a built-in function or some other kind of oddball that *should* report as a function but doesn't Adds all properties and methods of props to constructor's prototype, making them available to all instances created with constructor. Returns a function that will only ever execute in the a given scope. This allows for easy use of object member functions in callbacks and other places in which the &quot;this&quot; keyword may otherwise not reference the expected scope. Any number of default positional arguments may be passed as parameters beyond &quot;method&quot;. Each of these values will be used to &quot;placehold&quot; (similar to curry) for the hitched function. The scope to use when method executes. If method is a string, scope is also the object containing method. A function to be hitched to scope, or the name of the method in scope to be hitched. dojo.hitch(foo, "bar")(); runs foo.bar() in the scope of foo returns a new object which &quot;looks&quot; to obj for properties which it does not have a value for. Optionally takes a bag of properties to seed the returned object with initially. an Object of anonymous type object to delegate to for properties not found directly on the return object or in props. object containing properties to assign to the returned object var foo = { bar: "baz" }; var thinger = dojo.delegate(foo, { thud: "xyzzy"}); thinger.bar == "baz"; // delegated to foo foo.thud == undefined; // by definition thinger.thud == "xyzzy"; // mixed in from props foo.bar = "thonk"; thinger.bar == "thonk"; // still delegated to foo's bar Converts an array-like object (i.e. arguments, DOMCollection) to an array. Returns a new Array with the elements of obj. the object to &quot;arrayify&quot;. We expect the object to have, at a minimum, a length property which corresponds to integer-indexed properties. the location in obj to start iterating from. Defaults to 0. Optional. An array to pack with the properties of obj. If provided, properties in obj are appended at the end of startWith and startWith is the returned array. similar to hitch() except that the scope object is left to be whatever the execution context eventually becomes. Clones objects (including DOM nodes) and all children. Warning: do not clone cyclic structures. trims whitespaces from both sides of the string Returns nodes which match the given CSS3 selector, searching the entire document by default but optionally taking a node to scope the search by. Returns an instance of dojo.NodeList. dojo.NodeList An instance of `dojo.NodeList`. Many methods are available on NodeLists for searching, iterating, manipulating, and handling events on the matched nodes in the returned list. The CSS3 expression to match against. For details on the syntax of CSS3 selectors, see &lt;http://www.w3.org/TR/css3-selectors/#selectors&gt; A DOMNode (or node id) to scope the search from. Optional. search the entire document for elements with the class "foo": dojo.query(".foo"); these elements will match: <span class="foo"></span> <span class="foo bar"></span> <p class="thud foo"></p> changes the behavior of many core Dojo functions that deal with namespace and DOM lookup, changing them to work in a new global context (e.g., an iframe). The varibles dojo.global and dojo.doc are modified as a result of calling this function and the result of `dojo.body()` likewise differs. Call callback with globalObject as dojo.global and globalObject.document as dojo.doc. If provided, globalObject will be executed in the context of object thisObject Call callback with documentObject as dojo.doc. If provided, callback will be executed in the context of object thisObject dojo.formToObject returns the values encoded in an HTML form as string properties in an object which it then returns. Disabled form elements, buttons, and other non-value form elements are skipped. Multi-select elements are returned as an array of string values. takes a name/value mapping object and returns a string representing a URL-encoded version of that object. this object: { blah: "blah", multi: [ "thud", "thonk" ] }; yields the following query string: "blah=blah&multi=thud&multi=thonk" Returns a URL-encoded string representing the form passed as either a node or string ID identifying the form to serialize return a serialized JSON string from a form node or string ID identifying the form to serialize returns an object representing a de-serialized query section of a URL. Query keys with multiple values are returned in an array. sets up the Deferred and ioArgs property on the Deferred so it can be used in an io call. The args object passed into the public io call. Recognized properties on the args object are: The canceller function used for the Deferred object. The function will receive one argument, the Deferred object that is related to the canceller. The first OK callback to be registered with Deferred. It has the opportunity to transform the OK response. It will receive one argument -- the Deferred object returned from this function. The first error callback to be registered with Deferred. It has the opportunity to do cleanup on an error. It will receive two arguments: error (the Error object) and dfd, the Deferred object returned from this function. Cancels all pending IO requests, regardless of IO type (xhr, script, iframe). watches the io request represented by dfd to see if it completes. The Deferred object to watch. used to check if the IO request is still valid. Gets the dfd object as its only argument. used to check if basic IO call worked. Gets the dfd object as its only argument. used to process response. Gets the dfd object as its only argument. Adds query params discovered by the io deferred construction to the URL. Only use this for operations which are fundamentally GET-type operations. Sends an HTTP request with the given method. HTTP method to be used, such as GET, POST, PUT, DELETE. Should be uppercase. If the request has an HTTP body, then pass true for hasBody. Sends an HTTP GET request to the server. Sends an HTTP POST request to the server. In addtion to the properties listed for the dojo.__XhrArgs type, the following property is allowed: postData: String. Send raw data in the body of the POST request. Sends an HTTP PUT request to the server. In addtion to the properties listed for the dojo.__XhrArgs type, the following property is allowed: putData: String. Send raw data in the body of the PUT request. Sends an HTTP DELETE request to the server. A registry to make contextual calling/searching easier. // create a new registry var reg = new dojo.AdapterRegistry(); reg.register("handleString", dojo.isString, function(str){ // do something with the string here } ); reg.register("handleArr", dojo.isArray, function(arr){ // do something with the array here } ); // now we can pass reg.match() *either* an array or a string and // the value we pass will get handled by the right function reg.match("someValue"); // will call the first function reg.match(["someValue"]); // will call the second register a check function to determine if the wrap function or object gets selected a way to identify this matcher. a function that arguments are passed to from the adapter's match() function. The check function should return true if the given arguments are appropriate for the wrap function. If directReturn is true, the value passed in for wrap will be returned instead of being called. Alternately, the AdapterRegistry can be set globally to &quot;return not call&quot; using the returnWrappers property. Either way, this behavior allows the registry to act as a &quot;search&quot; function instead of a function interception library. If override is given and true, the check function will be given highest priority. Otherwise, it will be the lowest priority adapter. Find an adapter for the given arguments. If no suitable adapter is found, throws an exception. match() accepts any number of arguments, all of which are passed to all matching functions from the registered pairs. Remove a named adapter from the registry Provides event handling for a group of Deferred objects. deferred canceller function, see dojo.Deferred cause the DeferredLists callback to be fired as soon as any of the deferreds in its list have been fired instead of waiting until the entire list has finished fireonOneErrback: Will cause the errback to fire upon any of the deferreds errback The DeferredLists' callback handler Gathers the results of the deferreds for packaging as the parameters to the Deferred Lists' callback list of deferreds to be synchronizied with this DeferredList dojo.NodeList is as subclass of Array which adds syntactic sugar for chaining, common iteration operations, animation, and node manipulation. NodeLists are most often returned as the result of dojo.query() calls. create a node list from a node new dojo.NodeList(dojo.byId("foo")); wipe in all elements of this NodeList. Returns an instance of dojo._Animation Fade in all tables with class "blah": dojo.query("table.blah").wipeIn().play(); wipe out all elements of this NodeList. Returns an instance of dojo._Animation Wipe out all tables with class "blah": dojo.query("table.blah").wipeOut().play(); slide all elements of the node list to the specified place. Returns an instance of dojo._Animation Move all tables with class "blah" to 300/300: dojo.query("table.blah").slideTo({ left: 40, top: 50 }).play(); fade in all elements of this NodeList. Returns an instance of dojo._Animation Fade in all tables with class "blah": dojo.query("table.blah").fadeIn().play(); fade out all elements of this NodeList. Returns an instance of dojo._Animation Fade out all elements with class "zork": dojo.query(".zork").fadeOut().play(); see dojo.animateProperty(). Animate all elements of this NodeList across the properties specified. dojo.query(".zork").animateProperty({ duration: 500, properties: { color: { start: "black", end: "white" }, left: { end: 300 } } }).play(); Animate one or more CSS properties for all nodes in this list. The returned animation object will already be playing when it is returned. See the docs for `dojo.anim` for full details. the properties to animate Optional. The time to run the animations for Optional. The easing function to use. A function to be called when the animation ends how long to delay playing the returned animation Another way to fade out: dojo.query(".thinger").anim({ opacity: 0 }); see `dojo.html.set()`. Set the content of all elements of this NodeList dojo.query(".thingList").html("<li dojoType='dojo.dnd.Moveable'>1</li><li dojoType='dojo.dnd.Moveable'>2</li><li dojoType='dojo.dnd.Moveable'>3</li>", { parseContent: true, onBegin: function(){ this.content = this.content.replace(/([0-9])/g, this.id + ": $1"); this.inherited("onBegin", arguments); } }).removeClass("notdone").addClass("done"); Returns a new NodeList, maintaining this one in place Can be a positive or negative integer, with positive integers noting the offset to begin at, and negative integers denoting an offset from the end (i.e., to the left of the end) Optional parameter to describe what position relative to the NodeList's zero index to end the slice at. Like begin, can be positive or negative. Returns a new NodeList, manipulating this NodeList based on the arguments passed, potentially splicing in new elements at an offset, optionally deleting elements dojo.NodeList begin can be a positive or negative integer, with positive integers noting the offset to begin at, and negative integers denoting an offset from the end (i.e., to the left of the end) Optional parameter to describe what position relative to the NodeList's zero index to end the slice at. Like begin, can be positive or negative. Any number of optional parameters may be passed in to be spliced into the NodeList Returns a new NodeList comprised of items in this NodeList as well as items passed in as parameters dojo.NodeList Any number of optional parameters may be passed in to be spliced into the NodeList see dojo.indexOf(). The primary difference is that the acted-on array is implicitly this NodeList Positive Integer or 0 for a match, -1 of not found. The value to search for. The loction to start searching from. Optional. Defaults to 0. see dojo.lastIndexOf(). The primary difference is that the acted-on array is implicitly this NodeList Positive Integer or 0 for a match, -1 of not found. The value to search for. The loction to start searching from. Optional. Defaults to 0. see `dojo.every()` and: &lt;http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array:every&gt; Takes the same structure of arguments and returns as dojo.every() with the caveat that the passed array is implicitly this NodeList see dojo.some() and: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array:some Takes the same structure of arguments and returns as dojo.some() with the caveat that the passed array is implicitly this NodeList see dojo.map(). The primary difference is that the acted-on array is implicitly this NodeList and the return is a dojo.NodeList (a subclass of Array) see dojo.forEach(). The primary difference is that the acted-on array is implicitly this NodeList Returns the box objects all elements in a node list as an Array (*not* a NodeList) gets or sets the DOM attribute for every element in the NodeList if no value is passed, the result is an array of attribute values If a value is passed, the return is this NodeList the attribute to get/set optional. The value to set the property to gets or sets the CSS property for every element in the NodeList if no value is passed, the result is an array of strings. If a value is passed, the return is this NodeList the CSS property to get/set, in JavaScript notation (&quot;lineHieght&quot; instead of &quot;line-height&quot;) optional. The value to set the property to adds the specified class to every node in the list the CSS class to add removes the specified class from every node in the list dojo.NodeList, this list the CSS class to add Adds a class to node if not present, or removes if present. Pass a boolean condition if you want to explicitly add or remove. the CSS class to add If passed, true means to add the class, false means to remove. attach event handlers to every item of the NodeList. Uses dojo.connect() so event properties are normalized the name of the method to attach to. For DOM events, this should be the lower-case name of the event if 2 arguments are passed (methodName, objOrFunc), objOrFunc should reference a function or be the name of the function in the global namespace to attach. If 3 arguments are provided (methodName, objOrFunc, funcName), objOrFunc must be the scope to locate the bound function in optional. A string naming the function in objOrFunc to bind to the event. May also be a function reference. add an onclick handler to every button on the page dojo.query("div:nth-child(odd)").connect("onclick", function(e){ console.debug("clicked!"); }); places elements of this node list relative to the first element matched by queryOrNode. Returns the original NodeList. may be a string representing any valid CSS3 selector or a DOM node. In the selector case, only the first matching element will be used for relative positioning. can be one of: * &quot;last&quot;||&quot;end&quot; (default) * &quot;first||&quot;start&quot; * &quot;before&quot; * &quot;after&quot; or an offset in the childNodes property removes elements in this list that match the simple filter from their parents and returns them as a new NodeList. `dojo.NodeList` containing the orpahned elements single-expression CSS filter places any/all elements in queryOrListOrNode at a position relative to the first element in this list. Returns a dojo.NodeList of the adopted elements. a DOM node or a query string or a query result. Represents the nodes to be adopted relative to the first element of this NodeList. can be one of: * &quot;last&quot;||&quot;end&quot; (default) * &quot;first||&quot;start&quot; * &quot;before&quot; * &quot;after&quot; or an offset in the childNodes property Returns a new, flattened NodeList. Elements of the new list satisfy the passed query but use elements of the current NodeList as query roots. &quot;masks&quot; the built-in javascript filter() method to support passing a simple string filter in addition to supporting filtering function objects. "regular" JS filter syntax as exposed in dojo.filter: dojo.query("*").filter(function(item){ // highlight every paragraph return (item.nodeName == "p"); }).styles("backgroundColor", "yellow"); add a node or some HTML as a string to every item in the list. Returns the original list. the HTML in string format to add at position to every item can be one of: * &quot;last&quot;||&quot;end&quot; (default) * &quot;first||&quot;start&quot; * &quot;before&quot; * &quot;after&quot; or an offset in the childNodes property appends content to the end if the position is ommitted dojo.query("h3 > p").addContent("hey there!"); clears all content from each node in the list Create a new instance of a specified class, using the specified properties and each node in the nodeList as a srcNodeRef Returns a new NodeList comprised of items in this NodeList at the given index or indices. dojo.NodeList One or more 0-based indices of items in the current NodeList. The template string or location The context object or location size all elements of this NodeList. Returns an instance of dojo._Animation // size all divs with class "blah" dojo.query("div.blah").sizeTo({ width:50, height:50 }).play(); slide all elements of this NodeList. Returns an instance of dojo._Animation // slide all tables with class "blah" 10 px dojo.query("table.blah").slideBy({ top:10, left:10 }).play(); highlight all elements of the node list. Returns an instance of dojo._Animation // highlight all links with class "foo" dojo.query("a.foo").hightlight().play(); fade all elements of the node list to a specified opacity // fade all elements with class "bar" to to 50% opacity dojo.query(".bar").fadeTo({ end: 0.5 }).play(); Wipe all elements of the NodeList to a specified width: or height: dojo.query(".box").wipeTo({ width: 300px }).play(); the OpenAjax hub takes a named string, hex string, array of rgb or rgba values, an object with r, g, b, and a properties, or another dojo.Color object takes a named string, hex string, array of rgb or rgba values, an object with r, g, b, and a properties, or another dojo.Color object makes sure that the object has correct attributes returns 3 component array of rgb values returns a 4 component array of rgba values returns a css color string in hexadecimal representation returns a css color string in rgb(a) representation returns a visual representation of the color Encapsulates a sequence of callbacks in response to a value that may not yet be available. This is modeled after the Deferred class from Twisted &lt;http://twistedmatrix.com&gt;. var deferred = new dojo.Deferred(); setTimeout(function(){ deferred.callback({success: true}); }, 1000); return deferred; Cancels a Deferred that has not yet received a value, or is waiting on another Deferred as its value. The private primitive that means either callback or errback Begin the callback sequence with a non-error value. Begin the callback sequence with an error result. Add the same function as both a callback and an errback as the next element on the callback sequence.This is useful for code that you want to guarantee to run, e.g. a finalizer. Add a single callback to the end of the callback sequence. Add a single callback to the end of the callback sequence. Add separate callback and errback to the end of the callback sequence. Used internally to exhaust the callback sequence when a result is available. Application code can set the global 'djConfig' prior to loading the library to override certain global settings for how dojo works. Defaults to `false`. If set to `true`, ensures that Dojo provides extended debugging feedback via Firebug. If Firebug is not available on your platform, setting `isDebug` to `true` will force Dojo to pull in (and display) the version of Firebug Lite which is integrated into the Dojo distribution, thereby always providing a debugging/logging console when `isDebug` is enabled. Note that Firebug's `console.*` methods are ALWAYS defined by Dojo. If `isDebug` is false and you are on a platform without Firebug, these methods will be defined as no-ops. Defaults to `false`. If set to `true`, this triggers an alternate mode of the package system in which dependencies are detected and only then are resources evaluated in dependency order via `&lt;script&gt;` tag inclusion. This may double-request resources and cause problems with scripts which expect `dojo.require()` to preform synchronously. `debugAtAllCosts` can be an invaluable debugging aid, but when using it, ensure that all code which depends on Dojo modules is wrapped in `dojo.addOnLoad()` handlers. Due to the somewhat unpredictable side-effects of using `debugAtAllCosts`, it is strongly recommended that you enable this flag as a last resort. `debugAtAllCosts` has no effect when loading resources across domains. For usage information, see the [Dojo Book](http://dojotoolkit.org/book/book-dojo/part-4-meta-dojo-making-your-dojo-code-run-faster-and-better/debugging-facilities/deb) The locale to assume for loading localized resources in this page, specified according to [RFC 3066](http://www.ietf.org/rfc/rfc3066.txt). Must be specified entirely in lowercase, e.g. `en-us` and `zh-cn`. See the documentation for `dojo.i18n` and `dojo.requireLocalization` for details on loading localized resources. If no locale is specified, Dojo assumes the locale of the user agent, according to `navigator.userLanguage` or `navigator.language` properties. No default value. Specifies additional locales whose resources should also be loaded alongside the default locale when calls to `dojo.requireLocalization()` are processed. The directory in which `dojo.js` is located. Under normal conditions, Dojo auto-detects the correct location from which it was loaded. You may need to manually configure `baseUrl` in cases where you have renamed `dojo.js` or in which `&lt;base&gt;` tags confuse some browsers (e.g. IE 6). The variable `dojo.baseUrl` is assigned either the value of `djConfig.baseUrl` if one is provided or the auto-detected root if not. Other modules are located relative to this path. Indicates Dojo was added to the page after the page load. In this case Dojo will not wait for the page DOMContentLoad/load events and fire its dojo.addOnLoad callbacks after making sure all outstanding dojo.required modules have loaded. An array of module names to be loaded immediately after dojo.js has been included in a page. or Array Adds a callback via dojo.addOnLoad. Useful when Dojo is added after the page loads and djConfig.afterOnLoad is true. Supports the same arguments as dojo.addOnLoad. When using a function reference, use `djConfig.addOnLoad = function(){};`. For object with function name use `djConfig.addOnLoad = [myObject, &quot;functionName&quot;];` and for object with function reference use `djConfig.addOnLoad = [myObject, function(){}];` version number of dojo Major version. If total version is &quot;1.2.0beta1&quot;, will be 1 minor: Integer Minor version. If total version is &quot;1.2.0beta1&quot;, will be 2 patch: Integer Patch version. If total version is &quot;1.2.0beta1&quot;, will be 0 flag: String Descriptor flag. If total version is &quot;1.2.0beta1&quot;, will be &quot;beta1&quot; The SVN rev from which dojo was pulled provides timed callbacks using Java threads Sends arguments to console. Missing finctionality to show script line of trace. Sends arguments to console. Sends arguments to console, highlighted with (I) icon. Sends warning arguments to console, highlighted with (!) icon and blue style. Sends error arguments (object) to console, highlighted with (X) icon and yellow style NEW: error object now displays in object inspector Tests for true. Throws exception if false. collects log messages into a group, starting with this call and ending with groupEnd(). Missing collapse functionality Closes group. See above Starts timers assigned to name given in argument. Timer stops and displays on timeEnd(title); console.time("load"); console.time("myFunction"); console.timeEnd("load"); console.timeEnd("myFunction"); See above. Not supported Not supported Not supported Clears message console. Do not call this directly Opens message console. Do not call this directly Closes message console. Do not call this directly Constructor to create an object representing a URL. It is marked as private, since we might consider removing or simplifying it. Create a feature-rich constructor from compact notation dojo.declare("my.classes.bar", my.classes.foo, { // properties to be added to the class prototype someValue: 2, // initialization function constructor: function(){ this.myComplicatedObject = new ReallyComplicatedObject(); }, // other functions someMethod: function(){ doStuff(); } ); clobbers the listener from the node DOM node to attach the event to the name of the handler to remove the function from the handle returned from add definitions for common key values The time in milliseonds the animation will take to run A two element array of start and end values, or a dojo._Line instance to be used in the Animation. The number of times to loop the animation the time in milliseconds to wait before advancing to next frame (used as a fps timer: rate/1000 = fps) The time in milliseconds to wait before starting animation after it has been .play()'ed Event Synthetic event fired before a dojo._Animation begins playing (synchronous) Synthetic event fired as a dojo._Animation begins playing (useful?) Synthetic event fired at each interval of a dojo._Animation Synthetic event fired after the final frame of a dojo._Animation Synthetic event fired any time a dojo._Animation is play()'ed Synthetic event fired when a dojo._Animation is paused Synthetic event fires when a dojo._Animation is stopped A Function to adjust the acceleration (or deceleration) of the progress across a dojo._Line Convenience function. Fire event &quot;evt&quot; and pass it the arguments specified in &quot;args&quot;. The event to fire. The arguments to pass to the event. Start the animation. How many milliseconds to delay before starting. If true, starts the animation from the beginning; otherwise, starts it from its current position. Pauses a running animation. Sets the progress of the animation. A percentage in decimal notation (between and including 0.0 and 1.0). If true, play the animation after setting the progress. Stops a running animation. If true, the animation will end. Returns a string token representation of the status of the animation, one of: &quot;paused&quot;, &quot;playing&quot;, &quot;stopped&quot; dojo._Line is the object used to generate values from a start value to an end value Beginning value for range Ending value for range returns the point on the line a floating point number greater than 0 and less than 1 The node referenced in the animation Duration of the animation in milliseconds. An easing function. Returns an animation that will transition the properties of node defined in 'args' depending how they are defined in 'args.properties' A simple animation that changes the width of the specified node. dojo.animateProperty({ node: "nodeId", properties: { width: 400 }, }).play(); Dojo figures out the start value for the width and converts the integer specified for the width to the more expressive but verbose form `{ width: { end: '400', units: 'px' } }` which you can also specify directly In addition to the properties listed for the dojo._IoArgs type, the following properties are allowed for dojo.xhr* methods. Acceptable values are: text (default), json, json-comment-optional, json-comment-filtered, javascript, xml false is default. Indicates whether the request should be a synchronous (blocking) request. Additional HTTP headers to send in the request. URL to server endpoint. Contains properties with string values. These properties will be serialized as name1=value2 and passed in the request. Milliseconds to wait for the response. If this time passes, the then error callbacks are called. DOM node for a form. Used to extract the form values and send to the server. Default is false. If true, then a &quot;dojo.preventCache&quot; parameter is sent in the request with a value that changes with each request (timestamp). Useful only with GET-type requests. Acceptable values depend on the type of IO transport (see specific IO calls for more information). function(response, ioArgs){} response is of type Object, ioArgs is of type dojo.__IoCallbackArgs. This function will be called on a successful HTTP response code. function(response, ioArgs){} response is of type Object, ioArgs is of type dojo.__IoCallbackArgs. This function will be called when the request fails due to a network or server error, the url is invalid, etc. It will also be called if the load or handle callback throws an exception, unless djConfig.isDebug is true. This allows deployed applications to continue to run even when a logic error happens in the callback, while making it easier to troubleshoot while in debug mode. function(response, ioArgs){} response is of type Object, ioArgs is of type dojo.__IoCallbackArgs. This function will be called at the end of every request, whether or not an error occurs. the original object argument to the IO call. For XMLHttpRequest calls only, the XMLHttpRequest object that was used for the request. The final URL used for the call. Many times it will be different than the original args.url value. For non-GET requests, the name1=value1&amp;name2=value2 parameters sent up in the request. The final indicator on how the response will be handled. For dojo.io.script calls only, the internal script ID used for the request. For dojo.io.script calls only, indicates whether the script tag that represents the request can be deleted after callbacks have been called. Used internally to know when cleanup can happen on JSONP-type requests. For dojo.io.script calls only: holds the JSON response for JSONP-type requests. Used internally to hold on to the JSON responses. You should not need to access it directly -- the same object should be passed to the success callbacks directly. Browser history management resources Initializes the undo stack. This must be called from a &lt;script&gt; block that lives inside the &lt;body&gt; tag to prevent bugs on IE. Sets the state object and back callback for the very first page that is loaded. See the addToHistory() function for the list of valid args properties. adds a state object (args) to the history list. dojo.back.addToHistory({ back: function(){ console.debug('back pressed'); }, forward: function(){ console.debug('forward pressed'); }, changeUrl: true }); private method. Do not call this directly. Utility for unobtrusive/progressive event binding, DOM traversal, and manipulation. Add the specified behavior to the list of behaviors, ignoring existing matches. Simple list of properties. "found" is special. "Found" is assumed if no property object for a given selector, and property is a function. dojo.behavior.add({ "#id": { "found": function(element){ // node match found }, "onclick": function(evt){ // register onclick handler for found node } }, "#otherid": function(element){ // assumes "found" with this syntax } }); Applies all currently registered behaviors to the document. A mapping of currency code to currency-specific formatting information. Returns a unique object with properties: places, round. an [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code transformation of relevant pieces of the Unicode.org Common Locale Data Repository (see http://unicode.org/cldr) to JSON from the original XML with associated utility classes Returns a zero-based index for first day of the week Returns a hash containing the start and end days of the weekend Color utilities creates a greyscale color with an optional alpha Get or set a cookie. set a cookie with the JSON-serialized contents of an object which will expire 5 days from now: dojo.cookie("configObj", dojo.toJson(config), { expires: 5 }); Use to determine if the current browser supports cookies or not. Returns true if user allows cookies. Returns false if user doesn't allow cookies. localized formatting and parsing routines for currencies Format a Number as a currency, using locale-specific settings the number to be formatted. Builds the regular needed to parse a currency value Convert a properly formatted currency string to a primitive Number, using locale-specific settings. A string representation of a Number currency, set by default. override currency symbol. Normally, will be looked up in table of supported currencies, and ISO currency code will be used if not found. See dojo.i18n.cldr.nls-&gt;currency.js number of decimal places to accept. Default is defined by currency. where places are implied by pattern or explicit 'places' parameter, whether to include the fractional portion. By default for currencies, it the fractional portion is optional. A uniform data access layer constructor This function tests whether the item passed in is indeed an item in the store. The item to test for being contained by the store. This function tests whether the item passed in is indeed a valid 'attribute' like type for the store. The attribute to test for being contained by the store. See dojo.data.api.Read.getValue() See dojo.data.api.Read.getValues() See dojo.data.api.Read.getAttributes() See dojo.data.api.Read.hasAttribute() See dojo.data.api.Read.containsValue() Internal function for looking at the values contained by the item. The data item to examine for attribute values. The attribute to inspect. The value to match. Optional regular expression generated off value if value was of string type to handle wildcarding. If present and attribute values are string, then it can be used for comparison instead of 'value' See dojo.data.api.Read.isItem() See dojo.data.api.Read.isItemLoaded() See dojo.data.api.Read.loadItem() See dojo.data.api.Read.getFeatures() See dojo.data.api.Read.getLabel() See dojo.data.api.Read.getLabelAttributes() See dojo.data.util.simpleFetch.fetch() Internal function to execute delayed request in the store. Execute any deferred fetches now. Internal function to determine which list of items to search over. The query options parameter, if any. See dojo.data.api.Read.close() Function to parse the loaded data into item format and build the internal items array. array Array of items in store item format. First, we define a couple little utility functions... The JS data object containing the raw data to convery into item format. Method to add an reference map entry for an item and attribute. The item that is referenced. The item that holds the new reference to refItem. The attribute on parentItem that contains the new reference. Stub function, does nothing. Real processing is in ItemFileWriteStore. See dojo.data.api.Identity.getIdentity() See dojo.data.api.Identity.fetchItemByIdentity() Internal function to look an item up by its identity map. See dojo.data.api.Identity.getIdentifierAttributes() Internal function to force a load of the store if it hasn't occurred yet. This is required for specific functions to work properly. See dojo.data.api.Write.newItem() See dojo.data.api.Write.deleteItem() See dojo.data.api.Write.set() See dojo.data.api.Write.setValues() See dojo.data.api.Write.unsetAttribute() Method to add an reference map entry for an item and attribute. The item that is referenced. The item that holds the new reference to refItem. The attribute on parentItem that contains the new reference. Method to remove an reference map entry for an item and attribute. The item that is referenced. The item holding a reference to refItem. The attribute on parentItem that contains the reference. Function to dump the reverse reference map of all items in the store for debug purposes. Generate a string that can be saved to a file. The result should look similar to: http://trac.dojotoolkit.org/browser/dojo/trunk/tests/data/countries.json Function to determine if an array or object has no properties or values. array or object to examine. See dojo.data.api.Write.save() See dojo.data.api.Write.revert() See dojo.data.api.Write.isDirty() See dojo.data.api.Notification.onSet() No need to do anything. This method is here just so that the client code can connect observers to it. See dojo.data.api.Notification.onNew() No need to do anything. This method is here just so that the client code can connect observers to it. See dojo.data.api.Notification.onDelete() No need to do anything. This method is here just so that the client code can connect observers to it. Over-ride of base close function of ItemFileReadStore to add in check for store state. This is an abstract API that data provider implementations conform to. This file defines methods signatures and intentionally leaves all the methods unimplemented. See dojo.data.api.Read.getFeatures() Returns a unique identifier for an item. The return value will be either a string or something that has a toString() method (such as, for example, a dojox.uuid.Uuid object). The item from the store from which to obtain its identifier. var itemId = store.getIdentity(kermit); assert(kermit === store.findByIdentity(store.getIdentity(kermit))); Returns an array of attribute names that are used to generate the identity. For most stores, this is a single attribute, but for some complex stores such as RDB backed stores that use compound (multi-attribute) identifiers it can be more than one. If the identity is not composed of attributes on the item, it will return null. This function is intended to identify the attributes that comprise the identity so that so that during a render of all attributes, the UI can hide the the identity information if it chooses. The item from the store from which to obtain the array of public attributes that compose the identifier, if any. var itemId = store.getIdentity(kermit); var identifiers = store.getIdentityAttributes(itemId); assert(typeof identifiers === "array" || identifiers === null); Given the identity of an item, this method returns the item that has that identity through the onItem callback. Conforming implementations should return null if there is no item with the given identity. Implementations of fetchItemByIdentity() may sometimes return an item from a local cache and may sometimes fetch an item from a remote server, An anonymous object that defines the item to locate and callbacks to invoke when the item has been located and load has completed. The format of the object is as follows: { identity: string|object, onItem: Function, onError: Function, scope: object } The *identity* parameter. The identity parameter is the identity of the item you wish to locate and load This attribute is required. It should be a string or an object that toString() can be called on. The *onItem* parameter. Function(item) The onItem parameter is the callback to invoke when the item has been loaded. It takes only one parameter, the item located, or null if none found. The *onError* parameter. Function(error) The onError parameter is the callback to invoke when the item load encountered an error. It takes only one parameter, the error object The *scope* parameter. If a scope object is provided, all of the callback functions (onItem, onError, etc) will be invoked in the context of the scope object. In the body of the callback function, the value of the &quot;this&quot; keyword will be the scope object. If no scope object is provided, the callback functions will be called in the context of dojo.global. For example, onItem.call(scope, item, request) vs. onItem.call(dojo.global, item, request) This is an abstract API that data provider implementations conform to. This file defines functions signatures and intentionally leaves all the functions unimplemented. function onSet(item, attribute, oldValue, newValue) { //Do something with the information... }; var store = new some.newStore(); dojo.connect(store, "onSet", onSet); See dojo.data.api.Read.getFeatures() This function is called any time an item is modified via setValue, setValues, unsetAttribute, etc. Nothing. The item being modified. The attribute being changed represented as a string name. The old value of the attribute. In the case of single value calls, such as setValue, unsetAttribute, etc, this value will be generally be an atomic value of some sort (string, int, etc, object). In the case of multi-valued attributes, it will be an array. The new value of the attribute. In the case of single value calls, such as setValue, this value will be generally be an atomic value of some sort (string, int, etc, object). In the case of multi-valued attributes, it will be an array. In the case of unsetAttribute, the new value will be 'undefined'. This function is called any time a new item is created in the store. It is called immediately after the store newItem processing has completed. Nothing. The item created. An optional javascript object that is passed when the item created was placed in the store hierarchy as a value f another item's attribute, instead of a root level item. Note that if this function is invoked with a value for parentInfo, then onSet is not invoked stating the attribute of the parent item was modified. This is to avoid getting two notification events occurring when a new item with a parent is created. The structure passed in is as follows: { item: someItem, //The parent item attribute: &quot;attribute-name-string&quot;, //The attribute the new item was assigned to. oldValue: something //Whatever was the previous value for the attribute. //If it is a single-value attribute only, then this value will be a single value. //If it was a multi-valued attribute, then this will be an array of all the values minues the new one. newValue: something //The new value of the attribute. In the case of single value calls, such as setValue, this value will be //generally be an atomic value of some sort (string, int, etc, object). In the case of multi-valued attributes, //it will be an array. } This function is called any time an item is deleted from the store. It is called immediately after the store deleteItem processing has completed. Nothing. The item deleted. This is an abstract API that data provider implementations conform to. This file defines methods signatures and intentionally leaves all the methods unimplemented. For more information on the dojo.data APIs, please visit: http://www.dojotoolkit.org/node/98 Returns a single attribute value. Returns defaultValue if and only if *item* does not have a value for *attribute*. Returns null if and only if null was explicitly set as the attribute value. Returns undefined if and only if the item does not have a value for the given attribute (which is the same as saying the item does not have the attribute). The item to access values on. The attribute to access represented as a string. Optional. A default value to use for the getValue return in the attribute does not exist or has no value. var darthVader = store.getValue(lukeSkywalker, "father"); This getValues() method works just like the getValue() method, but getValues() always returns an array rather than a single attribute value. The array may be empty, may contain a single attribute value, or may contain many attribute values. If the item does not have a value for the given attribute, then getValues() will return an empty array: []. (So, if store.hasAttribute(item, attribute) has a return of false, then store.getValues(item, attribute) will return [].) The item to access values on. The attribute to access represented as a string. var friendsOfLuke = store.getValues(lukeSkywalker, "friends"); Returns an array with all the attributes that this item has. This method will always return an array; if the item has no attributes at all, getAttributes() will return an empty array: []. The item to access attributes on. var array = store.getAttributes(kermit); Returns true if the given *item* has a value for the given *attribute*. The item to access attributes on. The attribute to access represented as a string. var trueOrFalse = store.hasAttribute(kermit, "color"); Returns true if the given *value* is one of the values that getValues() would return. The item to access values on. The attribute to access represented as a string. The value to match as a value for the attribute. var trueOrFalse = store.containsValue(kermit, "color", "green"); Returns true if *something* is an item and came from the store instance. Returns false if *something* is a literal, an item from another store instance, or is any object other than an item. Can be anything. var yes = store.isItem(store.newItem()); var no = store.isItem("green"); Returns false if isItem(something) is false. Returns false if if isItem(something) is true but the the item is not yet loaded in local memory (for example, if the item has not yet been read from the server). Can be anything. var yes = store.isItemLoaded(store.newItem()); var no = store.isItemLoaded("green"); Given an item, this method loads the item so that a subsequent call to store.isItemLoaded(item) will return true. If a call to isItemLoaded() returns true before loadItem() is even called, then loadItem() need not do any work at all and will not even invoke the callback handlers. So, before invoking this method, check that the item has not already been loaded. An anonymous object that defines the item to load and callbacks to invoke when the load has completed. The format of the object is as follows: { item: object, onItem: Function, onError: Function, scope: object } The *item* parameter. The item parameter is an object that represents the item in question that should be contained by the store. This attribute is required. The *onItem* parameter. Function(item) The onItem parameter is the callback to invoke when the item has been loaded. It takes only one parameter, the fully loaded item. The *onError* parameter. Function(error) The onError parameter is the callback to invoke when the item load encountered an error. It takes only one parameter, the error object The *scope* parameter. If a scope object is provided, all of the callback functions (onItem, onError, etc) will be invoked in the context of the scope object. In the body of the callback function, the value of the &quot;this&quot; keyword will be the scope object. If no scope object is provided, the callback functions will be called in the context of dojo.global(). For example, onItem.call(scope, item, request) vs. onItem.call(dojo.global(), item, request) Given a query and set of defined options, such as a start and count of items to return, this method executes the query and makes the results available as data items. The format and expectations of stores is that they operate in a generally asynchronous manner, therefore callbacks are always used to return items located by the fetch parameters. The fetch() method will return a javascript object conforming to the API defined in dojo.data.api.Request. In general, it will be the keywordArgs object returned with the required functions in Request.js attached. Its general purpose is to provide a convenient way for a caller to abort an ongoing fetch. The Request object may also have additional properties when it is returned such as request.store property, which is a pointer to the datastore object that fetch() is a method of. The keywordArgs parameter may either be an instance of conforming to dojo.data.api.Request or may be a simple anonymous object that may contain any of the following: { query: query-object or query-string, queryOptions: object, onBegin: Function, onItem: Function, onComplete: Function, onError: Function, scope: object, start: int count: int sort: array } All implementations should accept keywordArgs objects with any of the 9 standard properties: query, onBegin, onItem, onComplete, onError scope, sort, start, and count. Some implementations may accept additional properties in the keywordArgs object as valid parameters, such as {includeOutliers:true}. The *query* parameter. The query may be optional in some data store implementations. The dojo.data.api.Read API does not specify the syntax or semantics of the query itself -- each different data store implementation may have its own notion of what a query should look like. However, as of dojo 0.9, 1.0, and 1.1, all the provided datastores in dojo.data and dojox.data support an object structure query, where the object is a set of name/value parameters such as { attrFoo: valueBar, attrFoo1: valueBar1}. Most of the dijit widgets, such as ComboBox assume this to be the case when working with a datastore when they dynamically update the query. Therefore, for maximum compatibility with dijit widgets the recommended query parameter is a key/value object. That does not mean that the the datastore may not take alternative query forms, such as a simple string, a Date, a number, or a mix of such. Ultimately, The dojo.data.api.Read API is agnostic about what the query format. Further note: In general for query objects that accept strings as attribute value matches, the store should also support basic filtering capability, such as * (match any character) and ? (match single character). An example query that is a query object would be like: { attrFoo: &quot;value*&quot;}. Which generally means match all items where they have an attribute named attrFoo, with a value that starts with 'value'. The *queryOptions* parameter The queryOptions parameter is an optional parameter used to specify optiosn that may modify the query in some fashion, such as doing a case insensitive search, or doing a deep search where all items in a hierarchical representation of data are scanned instead of just the root items. It currently defines two options that all datastores should attempt to honor if possible: { ignoreCase: boolean, //Whether or not the query should match case sensitively or not. Default behaviour is false. deep: boolean //Whether or not a fetch should do a deep search of items and all child //items instead of just root-level items in a datastore. Default is false. } The *onBegin* parameter. function(size, request); If an onBegin callback function is provided, the callback function will be called just once, before the first onItem callback is called. The onBegin callback function will be passed two arguments, the the total number of items identified and the Request object. If the total number is unknown, then size will be -1. Note that size is not necessarily the size of the collection of items returned from the query, as the request may have specified to return only a subset of the total set of items through the use of the start and count parameters. The *onItem* parameter. function(item, request); If an onItem callback function is provided, the callback function will be called as each item in the result is received. The callback function will be passed two arguments: the item itself, and the Request object. The *onComplete* parameter. function(items, request); If an onComplete callback function is provided, the callback function will be called just once, after the last onItem callback is called. Note that if the onItem callback is not present, then onComplete will be passed an array containing all items which matched the query and the request object. If the onItem callback is present, then onComplete is called as: onComplete(null, request). The *onError* parameter. function(errorData, request); If an onError callback function is provided, the callback function will be called if there is any sort of error while attempting to execute the query. The onError callback function will be passed two arguments: an Error object and the Request object. The *scope* parameter. If a scope object is provided, all of the callback functions (onItem, onComplete, onError, etc) will be invoked in the context of the scope object. In the body of the callback function, the value of the &quot;this&quot; keyword will be the scope object. If no scope object is provided, the callback functions will be called in the context of dojo.global(). For example, onItem.call(scope, item, request) vs. onItem.call(dojo.global(), item, request) The *start* parameter. If a start parameter is specified, this is a indication to the datastore to only start returning items once the start number of items have been located and skipped. When this parameter is paired withh 'count', the store should be able to page across queries with millions of hits by only returning subsets of the hits for each query The *count* parameter. If a count parameter is specified, this is a indication to the datastore to only return up to that many items. This allows a fetch call that may have millions of item matches to be paired down to something reasonable. The *sort* parameter. If a sort parameter is specified, this is a indication to the datastore to sort the items in some manner before returning the items. The array is an array of javascript objects that must conform to the following format to be applied to the fetching of items: { attribute: attribute || attribute-name-string, descending: true|false; // Optional. Default is false. } Note that when comparing attributes, if an item contains no value for the attribute (undefined), then it the default ascending sort logic should push it to the bottom of the list. In the descending order case, it such items should appear at the top of the list. Fetch all books identified by the query and call 'showBooks' when complete var request = store.fetch({query:"all books", onComplete: showBooks}); The getFeatures() method returns an simple keyword values object that specifies what interface features the datastore implements. A simple CsvStore may be read-only, and the only feature it implements will be the 'dojo.data.api.Read' interface, so the getFeatures() method will return an object like this one: {'dojo.data.api.Read': true}. A more sophisticated datastore might implement a variety of interface features, like 'dojo.data.api.Read', 'dojo.data.api.Write', 'dojo.data.api.Identity', and 'dojo.data.api.Attribution'. The close() method is intended for instructing the store to 'close' out any information associated with a particular request. An instance of a request for the store to use to identify what to close out. If no request is passed, then the store should clear all internal caches (if any) and close out all 'open' connections. It does not render the store unusable from there on, it merely cleans out any current data and resets the store to initial state. var request = store.fetch({onComplete: doSomething}); ... store.close(request); Method to inspect the item and return a user-readable 'label' for the item that provides a general/adequate description of what the item is. A user-readable string representing the item or undefined if no user-readable label can be generated. The item to return the label for. Method to inspect the item and return an array of what attributes of the item were used to generate its label, if any. An array of attribute names that were used to generate the label, or null if public attributes were not used to generate the label. The item to return the list of label attributes for. This class defines out the semantics of what a 'Request' object looks like when returned from a fetch() method. In general, a request object is nothing more than the original keywordArgs from fetch with an abort function attached to it to allow users to abort a particular request if they so choose. No other functions are required on a general Request object return. That does not inhibit other store implementations from adding extentions to it, of course. This is an abstract API that data provider implementations conform to. This file defines methods signatures and intentionally leaves all the methods unimplemented. For more details on fetch, see dojo.data.api.Read.fetch(). This function is a hook point for stores to provide as a way for a fetch to be halted mid-processing. This is an abstract API that data provider implementations conform to. This file defines function signatures and intentionally leaves all the functionss unimplemented. See dojo.data.api.Read.getFeatures() Returns a newly created item. Sets the attributes of the new item based on the *keywordArgs* provided. In general, the attribute names in the keywords become the attributes in the new item and as for the attribute values in keywordArgs, they become the values of the attributes in the new item. In addition, for stores that support hierarchical item creation, an optional second parameter is accepted that defines what item is the parent of the new item and what attribute of that item should the new item be assigned to. In general, this will assume that the attribute targetted is multi-valued and a new item is appended onto the list of values for that attribute. A javascript object defining the initial content of the item as a set of JavaScript 'property name: value' pairs. An optional javascript object defining what item is the parent of this item (in a hierarchical store. Not all stores do hierarchical items), and what attribute of that parent to assign the new item to. If this is present, and the attribute specified is a multi-valued attribute, it will append this item into the array of values for that attribute. The structure of the object is as follows: { parent: someItem, attribute: &quot;attribute-name-string&quot; } var kermit = store.newItem({name: "Kermit", color:[blue, green]}); Deletes an item from the store. The item to delete. var success = store.deleteItem(kermit); Sets the value of an attribute on an item. Replaces any previous value or values. The item to modify. The attribute of the item to change represented as a string name. The value to assign to the item. var success = store.set(kermit, "color", "green"); Adds each value in the *values* array as a value of the given attribute on the given item. Replaces any previous value or values. Calling store.setValues(x, y, []) (with *values* as an empty array) has the same effect as calling store.unsetAttribute(x, y). The item to modify. The attribute of the item to change represented as a string name. An array of values to assign to the attribute.. var success = store.setValues(kermit, "color", ["green", "aqua"]); success = store.setValues(kermit, "color", []); if (success) {assert(!store.hasAttribute(kermit, "color"));} Deletes all the values of an attribute on an item. The item to modify. The attribute of the item to unset represented as a string. var success = store.unsetAttribute(kermit, "color"); if (success) {assert(!store.hasAttribute(kermit, "color"));} Saves to the server all the changes that have been made locally. The save operation may take some time and is generally performed in an asynchronous fashion. The outcome of the save action is is passed into the set of supported callbacks for the save. Nothing. Since the saves are generally asynchronous, there is no need to return anything. All results are passed via callbacks. onComplete: function onError: function scope: object } The *onComplete* parameter. function(); If an onComplete callback function is provided, the callback function will be called just once, after the save has completed. No parameters are generally passed to the onComplete. The *onError* parameter. function(errorData); If an onError callback function is provided, the callback function will be called if there is any sort of error while attempting to execute the save. The onError function will be based one parameter, the error. The *scope* parameter. If a scope object is provided, all of the callback function ( onComplete, onError, etc) will be invoked in the context of the scope object. In the body of the callback function, the value of the &quot;this&quot; keyword will be the scope object. If no scope object is provided, the callback functions will be called in the context of dojo.global. For example, onComplete.call(scope) vs. onComplete.call(dojo.global) store.save({onComplete: onSave}); store.save({scope: fooObj, onComplete: onSave, onError: saveFailed}); Discards any unsaved changes. var success = store.revert(); Given an item, isDirty() returns true if the item has been modified since the last save(). If isDirty() is called with no *item* argument, then this function returns true if any item has been modified since the last save(). The item to check. var trueOrFalse = store.isDirty(kermit); // true if kermit is dirty var trueOrFalse = store.isDirty(); // true if any item is dirty Helper function to convert a simple pattern to a regular expression for matching. string A simple matching pattern to convert that follows basic rules: * Means match anything, so ca* means match anything starting with ca ? Means match single character. So, b?b will match to bob and bab, and so on. \ is an escape character. So for example, \* means do not treat * as a match, but literal character *. To use a \ as a character in the string, it must be escaped. So in the pattern it should be represented by \\ to be treated as an ordinary \ character instead of an escape. An optional flag to indicate if the pattern matching should be treated as case-sensitive or not when comparing By default, it is assumed case sensitive. The simpleFetch mixin is designed to serve as a set of function(s) that can be mixed into other datastore implementations to accelerate their development. The simpleFetch mixin should work well for any datastore that can respond to a _fetchItems() call by returning an array of all the found items that matched the query. The simpleFetch mixin is not designed to work for datastores that respond to a fetch() call by incrementally loading items, or sequentially loading partial batches of the result set. For datastores that mixin simpleFetch, simpleFetch implements a fetch method that automatically handles eight of the fetch() arguments -- onBegin, onItem, onComplete, onError, start, count, sort and scope The class mixing in simpleFetch should not implement fetch(), but should instead implement a _fetchItems() method. The _fetchItems() method takes three arguments, the keywordArgs object that was passed to fetch(), a callback function to be called when the result array is available, and an error callback to be called if something goes wrong. The _fetchItems() method should ignore any keywordArgs parameters for start, count, onBegin, onItem, onComplete, onError, sort, and scope. The _fetchItems() method needs to correctly handle any other keywordArgs parameters, including the query parameter and any optional parameters (such as includeChildren). The _fetchItems() method should create an array of result items and pass it to the fetchHandler along with the original request object -- or, the _fetchItems() method may, if it wants to, create an new request object with other specifics about the request that are specific to the datastore and pass that as the request object to the handler. For more information on this specific function, see dojo.data.api.Read.fetch() Basic comparision function that compares if an item is greater or less than another item Helper function to generate the sorting function based off the list of sort attributes. array A JS object that array that defines out what attribute names to sort on and whether it should be descenting or asending. The objects should be formatted as follows: { attribute: &quot;attributeName-string&quot; || attribute, descending: true|false; // Default is false. } object The datastore object to look up item values from. Used to get localized strings from dojo.cldr for day or month names. months || 'days' wide || 'narrow' || 'abbr' (e.g. &quot;Monday&quot;, &quot;Mon&quot;, or &quot;M&quot; respectively, in English) standAlone || 'format' (default) override locale used to find the names Determines if the date falls on a weekend, according to local custom. gets the day of the year as represented by dateObject Format a Date object as a String, using locale-specific settings. the date and/or time to be formatted. If a time only is formatted, the values in the year, month, and day fields are irrelevant. The opposite is true when formatting only dates. Builds the regular needed to parse a localized date Convert a properly formatted string to a primitive Date object, using locale-specific settings. A string representation of a date Add a reference to a bundle containing localized custom formats to be used by date/time formatting and parsing routines. choice of 'time','date' (default: date and time) choice of long, short, medium or full (plus any custom additions). Defaults to 'short' override pattern with this string override pattern with this string override strings for am in times override strings for pm in times override the locale used to determine formatting rules (format only) use 4 digit years whenever 2 digit years are called for (parse only) strict parsing, off by default Date manipulation utilities Returns the number of days in the month used by dateObject Determines if the year of the dateObject is a leap year Get the user's time zone as provided by the browser Needed because the timezone may vary with time (daylight savings) Compare two date objects by date, time, or both. object object. If not specified, the current Date is used. A string indicating the &quot;date&quot; or &quot;time&quot; portion of a Date object. Compares both &quot;date&quot; and &quot;time&quot; by default. One of the following: &quot;date&quot;, &quot;time&quot;, &quot;datetime&quot; Add to a Date in intervals of different size, from milliseconds to years object to start with A string representing the interval. One of the following: &quot;year&quot;, &quot;month&quot;, &quot;day&quot;, &quot;hour&quot;, &quot;minute&quot;, &quot;second&quot;, &quot;millisecond&quot;, &quot;quarter&quot;, &quot;week&quot;, &quot;weekday&quot; How much to add to the date. Get the difference in a specific unit of time (e.g., number of months, weeks, days, etc.) between two dates, rounded to the nearest integer. object object. If not specified, the current Date is used. A string representing the interval. One of the following: &quot;year&quot;, &quot;month&quot;, &quot;day&quot;, &quot;hour&quot;, &quot;minute&quot;, &quot;second&quot;, &quot;millisecond&quot;, &quot;quarter&quot;, &quot;week&quot;, &quot;weekday&quot; Defaults to &quot;day&quot;. Returns a Date object given a string formatted according to a subset of the ISO-8601 standard. A string such as 2005-06-30T08:05:00-07:00 or 2005-06-30 or T08:05:00 Used for defaults for fields omitted in the formattedString. Uses 1970-01-01T00:00:00.0Z by default. Format a Date object as a string according a subset of the ISO-8601 standard A Date object &quot;date&quot; or &quot;time&quot; for partial formatting of the Date object. Both date and time will be formatted by default. if true, UTC/GMT is used for a timezone if true, output milliseconds Drag and Drop resources returns a function, which creates an element of given tag (SPAN by default) and sets its innerHTML to given text a tag name or empty for SPAN creates a TR/TD structure with given text as an innerHTML of TD a text for TD creates a SPAN element with given text as its innerHTML a text for SPAN takes a parent node, and returns an appropriate creator function a container node returns the current DnD manager, creates one if it is not created yet returns a viewport size (visible part of the window) a handler for onmousemove event, which scrolls the window, if necesary onmousemove event a handler for onmousemove event, which scrolls the first avaialble Dom element, it falls back to dojo.dnd.autoScroll() onmousemove event abstracts away the difference between selection on Mac and PC, and returns the state of the &quot;copy&quot; key to be pressed. mouse event returns a unique string for use with any DOM element returns true, if user clicked on a form element an object, which represents transferred DnD items visually manager: Object: a DnD manager object a constructor function; it is separate so it can be (dynamically) overwritten in case of need a desctructor for the avatar, called to remove all references so it can be garbage-collected updates the avatar to reflect the current DnD state generates a proper text to reflect copying or moving of items a constructor of the Container don't start the drag operation, if clicked on form elements dropParent: Node: node or node's id to use as the parent node for dropped items (must be underneath the 'node' parameter in the DOM) _skipStartup: Boolean: skip startup(), which collects children, for deferred initialization (this is used in the markup mode) node or node's id to build the container on a creator function, which takes a data item, and returns an object like that: {node: newNode, data: usedData, type: arrayOfStrings} returns a data item by its key (id) associates a data item with its key (id) removes a data item from the map by its key (id) iterates over a data map skipping members, which are present in the empty object (IE and/or 3rd-party libraries). removes all data items from the map returns a list (an array) of all valid child nodes synch up the node list with the data map inserts an array of new nodes before/after an anchor node a list of data items, which should be processed by the creator function insert before the anchor, if true, and after the anchor otherwise the anchor node to be used as a point of insertion prepares the object to be garbage-collected collects valid child items and populate the map set up the real parent node event processor for onmouseover mouse event event processor for onmouseout mouse event event processor for onselectevent and ondragevent mouse event this function is called once, when mouse is over our container this function is called once, when mouse is out of our container changes a named state to new state value a name of the state to change new state adds a class with prefix &quot;dojoDndItem&quot; a node a variable suffix for a class name removes a class with prefix &quot;dojoDndItem&quot; a node a variable suffix for a class name gets a child, which is under the mouse at the moment, or null a mouse event adds all necessary data to the output of the user-supplied creator function the manager of DnD operations (usually a singleton) called when a source detected a mouse-over conditiion the reporter called when a source detected a mouse-out conditiion the reporter called to initiate the DnD operation the source which provides items the list of transferred items copy items, if true, move items otherwise called to notify if the current target can accept items stop the DnD in progress makes the avatar, it is separate to be overwritten dynamically, if needed updates the avatar, it is separate to be overwritten dynamically, if needed event processor for onmousemove mouse event event processor for onmouseup mouse event event processor for onkeydown: watching for CTRL for copy/move status, watching for ESCAPE to cancel the drag keyboard event event processor for onkeyup, watching for CTRL for copy/move status keyboard event changes the copy status the copy status an object, which makes a node moveable a node (or node's id), which is used as a mouse handle if omitted, the node itself is used as a handle delay move by this number of pixels skip move of form elements a node (or node's id) to be moved a constructor of custom Mover stops watching for possible move, deletes all references, so the object can be garbage-collected event processor for onmousedown, creates a Mover for the node mouse event event processor for onmousemove, used only for delayed drags mouse event event processor for onmouseup, used only for delayed drags mouse event event processor for onselectevent and ondragevent mouse event called when the drag is detected, responsible for creation of the mover called before every move operation called after every move operation called during the very first move notification, can be used to initialize coordinates, can be overwritten. default implementation does nothing called during every move notification, should actually move the node, can be overwritten. called before every incremental move, can be overwritten. default implementation does nothing called after every incremental move, can be overwritten. default implementation does nothing schedule the data pushing routines to happen in interval ms add data to the queue. Will be pusshed to the server on the next data push A Google-analytics helper, for post-onLoad inclusion of the tracker // create the tracker programatically: var tracker = new dojox.analytics.Urchin({ acct:"UA-123456-7" }); your GA urchin tracker account number. Time (in ms) to wait before checking for a ready Analytics API load the ga.js file and begin initialization process sniff the global _gat variable Google defines and either check again or fire onLoad if ready. initialize the tracker A public API attached to this widget instance, allowing you Ajax-like notification of updates. String A location to tell the tracker to track, eg: &quot;/my-ajaxy-endpoint&quot; Stub function to fire when urchin is complete DojoX: the home for Dojo eXtensions objects to support Dojo Offline (dojox.off) Cryptography in JS. DEPRECATED: use dojox.encoding instead. plugin to have analyitcs return the base info dojo collects plugin to have analyitcs return the base info dojo collects Inserts a Flash FLV video into the HTML page and provides methods and events for controlling the video. Also plays the H264/M4V codec with a little trickery: change the '.M4V' extension to '.flv'. markup: <div id="vid" initialVolume=".7", mediaUrl="../resources/Grog.flv" dojoType="dojox.av.FLVideo"></div> programmatic: new dojox.av.FLVideo({ initialVolume:.7, mediaUrl:"../resources/Grog.flv" }, "vid"); mediaUrl: String REQUIRED: The Url of the video file that will be played. NOTE: Must be either an absolute URL or relative to the HTML file. Relative paths will be converted to abslute paths The path to the video player SWF resource Initialize the media. Plays the video. If an url is passed in, plays the new link. Pauses the video Goes to the time passed in the argument Sets the volume of the video to the time in the argument - between 0 - 1. Checks that there is a proper buffer time between current playhead time and the amount of data loaded. Works only on FLVs with a duration (not older). Pauses the video while continuing download. Helper function to fire onPosition, check download progress, and check buffer. Checks that path is relative to HTML file or convertes it to an absolute path. Ensures volume is less than one helper for subscribing to topics destroys flash Used as a mixin for dojox and AIR media The initial volume setting of the player. Acccepts between 0 and 1. Whether the video automatically plays on load or not. Time in milliseconds that the video should be loaded before it will play. May pause and resume to build up buffer. Prevents stuttering. Note: Older FLVs, without a duration, cannot be buffered. Time in milliseconds bwteen the playhead time and loaded time that will trigger the buffer. When buffer is triggered, video will pause until the bufferTime amount is buffered. Note: Should be a small number, greater than zero. How often, in milliseconds to get an update of the video position. The id of this widget and the id of the SWF movie. Setting to true tells the SWF to output log messages to Firebug. The percentage the media has downloaded; from 0-100 The dojox.embed object The SWF object. Methods are passed to this. Connect mediaStatus to the media. Returns the current time of the video Note: Consider the onPosition event, which returns the time at a set interval. Too many trips to the SWF could impact performance. Fired when the SWF player has loaded NOT when the video has loaded Fires the amount of that the media has been downloaded. Number, 0-100 TODO: Return x/y of click Fires when the player is clicked Could be used to toggle play/pause, or do an external activity, like opening a new window. Fired on SWF resize, or when its toggled between fullscreen. The video properties. Width, height, duration, etc. NOTE: if data is empty, this is an older FLV with no meta data. Duration cannot be determined. In original FLVs, duration could only be obtained with Flash Media Server. NOTE: Older FLVs can still return width and height and will do so on a second event call The position of the playhead in seconds Fires when video starts Good for setting the play button to pause during an autoPlay for example Fires when video starts and resumes Fires when teh pause button is clicked Fires when video ends Could be used to change pause button to play or show a post video graphic, like YouTube Fire when the Stop button is clicked TODO: This is not hooked up yet and shouldn't fire. Fires a boolean to tell if media is paused for buffering or if buffering has finished Fired when the player encounters an error console.warn("ERROR-"+data.type.toUpperCase()+":", data.info.code, " - URL:", url); Simple status The status of the video from the SWF playing, stopped, bufering, etc. Calculate media status, based on playhead movement, and onStop and onStart events TODO: Figure in real status from the media for more accurate results. Creates a generic event object. A Play/Pause button widget to use with dojox.av.widget.Player Intialize button. A common method to set the media in all Player widgets. May do connections and initializations. Fired on play or pause click. Fired on play click. Fired on pause click. Toggles the pause button invisible and the play button visible.. Toggles the play button invisible and the pause button visible. A Media Player UI widget for all types of dojox.av and AIR media. <div dojoType="dojox.av.widget.Player" playerWidth="100%"> <div controlType="video" initialVolume=".1" mediaUrl="video/Grog.flv" autoPlay="true" isDebug="false" dojoType="dojox.av.FLVideo"></div> <div controlType="play" dojoType="dojox.av.widget.PlayButton"></div> <div controlType="volume" dojoType="dojox.av.widget.VolumeButton"></div> <div controlType="progress" dojoType="dojox.av.widget.ProgressSlider"></div> <div controlType="status" dojoType="dojox.av.widget.Status"></div> </div> or String */ Sets the width of the player (not the video size) Number will be converted to pixels String will be used literally. EX: &quot;320px&quot; or &quot;100%&quot; Do player styling, and place child widgets in the proper location. Fired when all children are ready. Set the media in all children with setMedia() If a player size is a percentage, this will fire an onResize event for all children, passing the size of the player. A custom slider widget to use with dojox.av.widget.Player. Initialize slider. A common method to set the media in all Player widgets. May do connections and initializations. Fired when the mouse is moved. Sets the slider. Fired onmousedown of the slider handle. Fired on document.onmouseup. Sets the slider handle (when it is not being dragged) Sets the download progress bar to the percentage of how much the media has been downloaded. Highlights the slider handle on mouseover, and stays highlighted during drag. Unhighlights handle onmouseover, or on endDrag. Handles player resize. Need to recalculate the width of position an download bars. A Status widget to use with dojox.av.widget.Player A common method to set the media in all Player widgets. May do connections and initializations. A volume widget to use with dojox.av.widget.Player Initialize the widget. A common method to set the media in all Player widgets. May do connections and initializations. Changes the icon on the button according to volume level. Shows the volume slider. Fired on document.onmousedown. Checks if clicked inside of this widget or not. Hides volume slider. Fired on mousemove. Updates volume and position of slider handle. Fired on mousedown of the slider handle. Fired on mouseup of the slider handle. Highlights the slider handle on mouseover, and stays highlighted during drag. Unhighlights handle onmouseover, or on endDrag. Gets dimensions of slider background node. Only uses dojo.coords once, unless the page or player is resized. Gets dimensions of slider handle. Only uses dojo.marginBox once. Fired on player resize. Zeros dimensions so that it can be calculated again. Vector graphic, data-driven graphs and charts Generate a set of colors for the theme based on keyword arguments Return a clone of this theme, with the position vars reset to 0. get either the next color or the next marker, depending on what was passed. If type is not passed, it assumes color. Optional. One of either &quot;color&quot; or &quot;marker&quot;. Defaults to &quot;color&quot;. var color = myTheme.next(); var color = myTheme.next("color"); var marker = myTheme.next("marker"); resets both marker and color counters back to the start. Subsequent calls to `next` will retrievie the first value of each depending on the passed type. properly destroy the widget resize the widget A legend for a chart. A legend contains summary labels for each series of data contained in the chart. Set the boolean horizontal attribute to false to layout legend labels vertically. (Line or Scatter charts (colored lines with shape symbols) ) -o- Series1 -X- Series2 -v- Series3 (Area/Bar/Pie charts (letters represent colors)) [a] Series1 [b] Series2 [c] Series3 regenerates the legend to reflect changes to the chart A set of lists and hashes for easy use within your applications. Advanced color methods, including HSV, HSL, and CMYK conversion, a color generator and advanced colorspace calculations. | dojox.Color The base color from which to derive all other colors. The number of lines to generate The number of colors to generate The high hue angle of difference from the base color, subtracted The low hue angle of difference from the base color, added The high part of the range to generate tints and shades The low part of the range to generate tints and shades | dojox.Color The base color from which to derive all other colors. The number of colors to generate The high part of the range to generate tints and shades The low part of the range to generate tints and shades | dojox.Color The base color from which to derive all other colors. The number of colors to generate The angle of hue difference from the base color to use The high part of the range to generate tints and shades The low part of the range to generate tints and shades An object that represents a palette of colors. description A Palette is a representation of a set of colors. While the standard number of colors contained in a palette is 5, it can really handle any number of colors. A palette is useful for the ability to transform all the colors in it using a simple object-based approach. In addition, you can generate palettes using dojox.color.Palette.generate; these generated palettes are based on the palette generators at http://kuler.adobe.com. dojox.color.Color[] The actual color references in this palette. A cometd client written in Dojo Initiates the REST Channels protocol Startup the transport (connect to the &quot;channels&quot; resource to receive updates from the server). Subscribes to a channel/uri, and returns a dojo.Deferred object for the response from the subscription request the uri for the resource you want to monitor See dojo.xhr headers: These are the headers to be applied to the channel subscription request callback: This will be called when a event occurs for the channel The callback will be called with a single argument: callback(message) where message is an object that follows the XHR API: status : Http status statusText : Http status text getAllResponseHeaders() : The response headers getResponseHeaders(headerName) : Retrieve a header by name responseText : The response body as text with the following additional Bayeux properties data : The response body as JSON channel : The channel/url of the response Publish an event. path to publish to to publish GET the initial value of the resource and subscribe to it See subscribe for parameter values Called when a message is received from the server cometd/XHR message called when our channel gets disconnected unsubscribes from the resource See subscribe for parameter values disconnect from the server return: dojo.Deferred Initialize the cometd implementation of the Bayeux protocol The URL of the cometd server. If the root is absolute, the host is examined to determine if xd transport is needed. Otherwise the same domain is assumed. An optional object that is used as the basis of the handshake message An optional object of bind args mixed in with the send of the handshake dojox.cometd.init("/cometd"); dojox.cometd.init("http://xdHost/cometd",{ext:{user:"fred",pwd:"secret"}}); FIXME: if the root isn't from the same host, we should automatically try to select an XD-capable transport publishes the passed message to the cometd server for delivery on the specified topic the destination channel for the message a JSON object containing the message &quot;payload&quot; properties: Optional. Other meta-data to be mixed into the top-level of the message return: dojo.Deferred inform the server of this client's interest in channel name of the cometd channel to subscribe to an object scope for funcName or the name or reference to a function to be called when messages are delivered to the channel the second half of the objOrFunc/funcName pair for identifying a callback function to notifiy upon channel message delivery Simple subscribe use-case dojox.cometd.init("http://myserver.com:8080/cometd"); // log out all incoming messages on /foo/bar dojox.cometd.subscribe("/foo/bar", console, "debug"); inform the server of this client's disinterest in channel name of the cometd channel to unsubscribe from an object scope for funcName or the name or reference to a function to be called when messages are delivered to the channel. If null then all subscribers to the channel are unsubscribed. the second half of the objOrFunc/funcName pair for identifying a callback function to notifiy upon channel message delivery Disconnect from the server. dojox.cometd.disconnect(); Handle the handshake return from the server and initialize connection if all is OK Handle extensions for inbound messages Handle extensions for inbound messages Return the connect timeout in ms, calculated as the minimum of the advised timeout and the configured timeout. Else 0 to indicate no client side timeout Summary Set a timeout function relative to server time the function to call when the timeout occurs atTimeOrTime: a long timestamp or a Date representing the server time at which the timeout should occur. The incoming bayeux message outgoing bayeux message Additional dojo.data data stores and demos this function can be used to receive REST notifications, from Comet or from another frame constructor This function tests whether the item passed in is indeed an item in the store. The item to test for being contained by the store. This function tests whether the item passed in is indeed a valid 'attribute' like type for the store. The attribute to test for being contained by the store. See dojo.data.api.Read.getValue() See dojo.data.api.Read.getValues() See dojo.data.api.Read.getAttributes() See dojo.data.api.Read.hasAttribute() See dojo.data.api.Read.containsValue() Internal function for looking at the values contained by the item. The data item to examine for attribute values. The attribute to inspect. The value to match. Optional regular expression generated off value if value was of string type to handle wildcarding. If present and attribute values are string, then it can be used for comparison instead of 'value' See dojo.data.api.Read.isItem() See dojo.data.api.Read.isItemLoaded() See dojo.data.api.Read.loadItem() See dojo.data.api.Read.getFeatures() See dojo.data.api.Read.getLabel() See dojo.data.api.Read.getLabelAttributes() See dojo.data.util.simpleFetch.fetch() filter modified to permit complex queries where logical operators are case insensitive: , NOT AND OR ( ) ! &amp;&amp; || Note: &quot;,&quot; included for quoted/string legacy queries. Internal function to execute delayed request in the store. Execute any deferred fetches now. Internal function to determine which list of items to search over. The query options parameter, if any. See dojo.data.api.Read.close() Function to parse the loaded data into item format and build the internal items array. array Array of items in store item format. First, we define a couple little utility functions... The JS data object containing the raw data to convery into item format. Method to add an reference map entry for an item and attribute. The item that is referenced. The item that holds the new reference to refItem. The attribute on parentItem that contains the new reference. Stub function, does nothing. Real processing is in ItemFileWriteStore. See dojo.data.api.Identity.getIdentity() See dojo.data.api.Identity.fetchItemByIdentity() Internal function to look an item up by its identity map. See dojo.data.api.Identity.getIdentifierAttributes() Internal function to force a load of the store if it hasn't occurred yet. This is required for specific functions to work properly. See dojo.data.api.Write.newItem() See dojo.data.api.Write.deleteItem() See dojo.data.api.Write.set() See dojo.data.api.Write.setValues() See dojo.data.api.Write.unsetAttribute() Method to add an reference map entry for an item and attribute. The item that is referenced. The item that holds the new reference to refItem. The attribute on parentItem that contains the new reference. Method to remove an reference map entry for an item and attribute. The item that is referenced. The item holding a reference to refItem. The attribute on parentItem that contains the reference. Function to dump the reverse reference map of all items in the store for debug purposes. Generate a string that can be saved to a file. The result should look similar to: http://trac.dojotoolkit.org/browser/dojo/trunk/tests/data/countries.json Function to determine if an array or object has no properties or values. array or object to examine. See dojo.data.api.Write.save() See dojo.data.api.Write.revert() See dojo.data.api.Write.isDirty() See dojo.data.api.Notification.onSet() No need to do anything. This method is here just so that the client code can connect observers to it. See dojo.data.api.Notification.onNew() No need to do anything. This method is here just so that the client code can connect observers to it. See dojo.data.api.Notification.onDelete() No need to do anything. This method is here just so that the client code can connect observers to it. Over-ride of base close function of ItemFileReadStore to add in check for store state. Constructor for the AtomRead store. url to a service or an XML document that represents the store boolean indicate to add a query string to the service URL boolean to specify whether or not to unescape HTML text Return an attribute value An attribute value found, otherwise 'defaultValue' An item returned by a call to the 'fetch' method. A attribute of the Atom Entry A default value Return an attribute value An array of values for the attribute value found, otherwise 'defaultValue' An item returned by a call to the 'fetch' method. A attribute of the Atom Entry Return an array of attribute names An array of attributes found An XML element Check whether an element has the attribute True if the element has the attribute, otherwise false must be created by the AtomReadStore instance. An attribute of an Atom Entry item. Check whether the attribute values contain the value True if the attribute values contain the value, otherwise false must be an instance of a dojox.data.XmlItem from the store instance. A tag name of a child element, An XML attribute name or one of special names Check whether the object is an item (XML element) item: An object to check True if the object is an XML element, otherwise false Check whether the object is an item (XML element) and loaded item: An object to check True if the object is an XML element, otherwise false Load an item (XML element) containing the args for loadItem. See dojo.data.api.Read.loadItem() Return supported data APIs "dojo.data.api.Read" and "dojo.data.api.Write" See dojo.data.api.Read.getLabel() See dojo.data.api.Read.getLabelAttributes() Non-API method for retrieving values regarding the Atom feed, rather than the Atom entries. Non-API method for retrieving values regarding the Atom feed, rather than the Atom entries. Initializes an item before it can be parsed. Retrieves the items from the Atom XML document. Parses the document in a first pass See dojo.data.api.Read.close() This function tests whether the item passed in is indeed an item in the store. The item to test for being contained by the store. This function tests whether the item passed in is indeed a valid 'attribute' like type for the store. The attribute to test for being contained by the store. This is an abstract class that data stores can extend to add updateable result set functionality as well as client side querying capabilities. This enables widgets to be aware of how active results change in response to the modifications/notifications. to make a live-result-set data store from an existing data store: dojo.declare("dojox.data.MyLiveDataStore", dojox.data.MyDataStore,dojox.data.LiveResultSets], // subclass LiveResultSets if available {} ); Attempts to update the given result set based on previous notifications The result set array that should be updated This object follows the same meaning as the keywordArgs passed to a dojo.data.api.Read.fetch. Determines whether the provided arguments are super/sub sets of each other Data Fetch arguments Data Fetch arguments Returns whether the provide fetch arguments can be used to update an existing list See dojo.data.api.Read.fetch request Performs a query on the client side and returns the results as an array See dojo.data.api.Read.fetch request This provides the result set to start with for client side querying returns a comparator function for the given sort order array dojox.data.api.Read.fetch This only differs from JsonRestStore in that it, will put the query string the query part of the URL and it handles start and count Basic store to display CSS information. See dojo.data.api.Read.getFeatures() See dojo.data.api.Read.getAttributes() See dojo.data.api.Read.getValue() See dojo.data.api.Read.getValues() Handles the creation of an item based on the passed rule. In this store, this implies parsing out all available class names. Handles the return from a fetching action. Delegates requests to act on the resulting item set to eitehr the _handleFetchReturn or _handleFetchByIdentityReturn depending on where the request originated. Handles a fetchByIdentity request by finding the correct item. See dojo.data.api.Identity.getIdentity() See dojo.data.api.Identity.getIdentityAttributes() See dojo.data.api.Identity.fetchItemByIdentity() Basic store to display CSS information. Sets the context in which queries are executed Array - Array of CSS string paths to execute queries within See dojo.data.api.Read.getFeatures() See dojo.data.api.Read.isItem() See dojo.data.api.Read.hasAttribute() See dojo.data.api.Read.getAttributes() See dojo.data.api.Read.getValue() See dojo.data.api.Read.getValues() See dojo.data.api.Read.getLabel() See dojo.data.api.Read.getLabelAttributes() See dojo.data.api.Read.containsValue() See dojo.data.api.Read.isItemLoaded() See dojo.data.api.Read.loadItem() See dojo.data.api.Read.fetch() Populates the _allItems object with unique class names Handles the creation of an item based on the passed rule. In this store, this implies parsing out all available class names. Handles the return from a fetching action. Delegates requests to act on the resulting item set to eitehr the _handleFetchReturn or _handleFetchByIdentityReturn depending on where the request originated. Handles a fetchByIdentity request by finding the correct items. See dojo.data.api.Read.close() Clears out the cache and allItems objects, meaning all future fetches will requery the stylesheets. This function tests whether the item passed in is indeed an item in the store. The item to test for being contained by the store. This function tests whether the item passed in is indeed a valid 'attribute' like type for the store. The attribute to test for being contained by the store. Internal function for looking at the values contained by the item. The data item to examine for attribute values. The attribute to inspect. The value to match. Optional regular expression generated off value if value was of string type to handle wildcarding. If present and attribute values are string, then it can be used for comparison instead of 'value' initializer This function tests whether the item passed in is indeed an item in the store. The item to test for being contained by the store. This function tests whether the item passed in is indeed a valid 'attribute' like type for the store. The attribute to test for being contained by the store. See dojo.data.api.Read.getValue() Note that for the CsvStore, an empty string value is the same as no value, so the defaultValue would be returned instead of an empty string. See dojo.data.api.Read.getValues() CSV syntax does not support multi-valued attributes, so this is just a wrapper function for getValue(). See dojo.data.api.Read.getAttributes() See dojo.data.api.Read.hasAttribute() The hasAttribute test is true if attribute has an index number within the item's array length AND if the item has a value for that attribute. Note that for the CsvStore, an empty string value is the same as no value. See dojo.data.api.Read.containsValue() Internal function for looking at the values contained by the item. The data item to examine for attribute values. The attribute to inspect. The value to match. Optional regular expression generated off value if value was of string type to handle wildcarding. If present and attribute values are string, then it can be used for comparison instead of 'value' See dojo.data.api.Read.isItem() See dojo.data.api.Read.isItemLoaded() The CsvStore always loads all items, so if it's an item, then it's loaded. See dojo.data.api.Read.loadItem() See dojo.data.api.Read.getFeatures() See dojo.data.api.Read.getLabel() See dojo.data.api.Read.getLabelAttributes() See dojo.data.util.simpleFetch.fetch() See dojo.data.api.Read.close() Function to split the CSV file contents into separate lines. Since line breaks can occur inside quotes, a Regexp didn't work as well. A quick passover parse should be just as efficient. See dojo.data.api.Identity.getIdentity() See dojo.data.api.Identity.fetchItemByIdentity() See dojo.data.api.Identity.getIdentifierAttributes() Identity isn't a public attribute in the item, it's the row position index. So, return null. Internal function to execute delayed request in the store. Execute any deferred fetches now. A simple store that provides a datastore interface to a filesystem. options="expand,dirsOnly,showHiddenFiles" URL of the service which provides the file store serverside implementation. attribute of the file to use as the huma-readable text. Default is 'name'. The purpose of this store is to represent a file as a datastore item. The datastore item by default has the following attributes that can be examined on it. directory: Boolean indicating if the file item represents a directory. name: The filename with no path informatiom. path: The file complete file path including name, relative to the location the file service scans from size: The size of the file, in bytes. parentDir: The parent directory path. children: Any child files contained by a directory file item. Note that the store's server call pattern is RESTlike. The store also supports the passing of configurable options to the back end service, such as expanding all child files (no lazy load), displaying hidden files, displaying only directories, and so on. These are defined through a comma-separated list in declarative, or through setting the options array in programmatic. This function tests whether the item passed in is indeed an item in the store. The item to test for being contained by the store. This function tests whether the item passed in is indeed a valid 'attribute' like type for the store. The attribute to test for being contained by the store. See dojo.data.api.Read.getFeatures() See dojo.data.api.Read.getValue() See dojo.data.api.Read.getAttributes() See dojo.data.api.Read.hasAttributes() See dojo.data.api.Identity.getIdentity() See dojo.data.api.Read.getLabelAttributes() See dojo.data.api.Read.isItemLoaded() See dojo.data.api.Read.loadItem() See dojo.data.api.Read.getLabel() See dojo.data.api.Read.getLabelAttributes() See dojo.data.api.Read.containsValue() See dojo.data.api.Read.getValue() See dojo.data.api.Read.isItem() See dojo.data.api.Read.close() Fetch items that match to a query request object fetchHandler: A function to call for fetched items errorHandler: A function to call on error See dojo.data.api.Read.loadItem() Internal function for processing an array of items for return. Internal function for processing an item returned from the store. It sets up the store ref as well as sets up the attributes necessary to invoke a lazy load on a child, if there are any. Initializer for the FlickrRestStore store. A unique identifier for this store. A counter for the number of requests made. This is used to define the callback function that Flickr will use. The URL to the Flickr REST services. The users API key to be used when accessing Flickr REST services. A key used to mark an data store item as belonging to this store. An Array of all previously downloaded picture info. A HashMap used to record the signature of a request to prevent duplicate request being made. A HashMap used to record the handlers registered for a single remote request. Multiple requests may be made for the same information before the first request has finished. Each element of this Object is an array of handlers to call back when the request finishes. This prevents multiple requests being made for the same information. Fetch flickr items that match to a query A request object A function to call for fetched items A function to call on error See dojo.data.api.Read.getAttributes() See dojo.data.api.Read.getValue() Processes the raw data from Flickr and updates the internal cache. Data returned from Flickr The original dojo.data.Request object passed in by the user. If the data contains an 'item' object, it has not come from the REST services, so process it using the FlickrStore. A quick lookup of valid attribute names in a sort query. Initializer for the FlickrStore store. This function tests whether the item passed in is indeed an item in the store. The item to test for being contained by the store. This function tests whether the item passed in is indeed a valid 'attribute' like type for the store. The attribute to test for being contained by the store. See dojo.data.api.Read.getFeatures() See dojo.data.api.Read.getValue() See dojo.data.api.Read.getAttributes() See dojo.data.api.Read.hasAttributes() See dojo.data.api.Read.isItemLoaded() See dojo.data.api.Read.loadItem() See dojo.data.api.Read.getLabel() See dojo.data.api.Read.getLabelAttributes() See dojo.data.api.Read.containsValue() See dojo.data.api.Read.getValue() See dojo.data.api.Read.isItem() See dojo.data.api.Read.close() Fetch flickr items that match to a query request object function to call for fetched items function to call on error Utility function to un-escape XML special characters in an HTML string. HTML String converted back to the normal text (unescaped) characters (<,>,&, ", etc,). . The string to un-escape A data store for retrieving RSS and Atom feeds from Google. The feeds can come from any source, which is specified in the &quot;url&quot; parameter of the query passed to the &quot;fetch&quot; function. The following attributes are supported on each item: &lt;ul&gt; &lt;li&gt;title - The feed entry title.&lt;/li&gt; &lt;li&gt;link - The URL for the HTML version of the feed entry.&lt;/li&gt; &lt;li&gt;content - The full content of the blog post, in HTML format&lt;/li&gt; &lt;li&gt;summary - A snippet of information about the feed entry, in plain text&lt;/li&gt; &lt;li&gt;published - The string date on which the entry was published. You can parse the date with new Date(store.getValue(item, &quot;published&quot;)&lt;/li&gt; &lt;li&gt;categories - An array of string tags for the entry&lt;/li&gt; &lt;/ul&gt; The query accepts one parameter: url - The URL of the feed to retrieve Initializer for the GoogleSearchStore store. A unique identifier for this store. A counter for the number of requests made. This is used to define the callback function that GoogleSearchStore will use. The URL to Googles search web service. The internal reference added to each item pointing at the store which owns it. The list of attributes that this store supports The default attribute which acts as a label for each item. This function tests whether the item passed in is indeed an item in the store. The item to test for being contained by the store. This function tests whether the item passed in is indeed a valid 'attribute' like type for the store. The attribute to test for being contained by the store. See dojo.data.api.Read.getFeatures() See dojo.data.api.Read.getValue() See dojo.data.api.Read.getAttributes() See dojo.data.api.Read.hasAttributes() See dojo.data.api.Read.isItemLoaded() See dojo.data.api.Read.loadItem() See dojo.data.api.Read.getLabel() See dojo.data.api.Read.getLabelAttributes() See dojo.data.api.Read.containsValue() See dojo.data.api.Read.getValue() See dojo.data.api.Read.isItem() See dojo.data.api.Read.close() Fetch Google search items that match to a query request object fetchHandler: A function to call for fetched items errorHandler: A function to call on error A data store for retrieving search results from Google. The following attributes are supported on each item: &lt;ul&gt; &lt;li&gt;title - The page title in HTML format.&lt;/li&gt; &lt;li&gt;titleNoFormatting - The page title in plain text&lt;/li&gt; &lt;li&gt;content - A snippet of information about the page&lt;/li&gt; &lt;li&gt;url - The URL for the item&lt;/li&gt; &lt;li&gt;unescapedUrl - The URL for the item, with URL escaping. This is often more readable&lt;/li&gt; &lt;li&gt;visibleUrl - The URL with no protocol specified.&lt;/li&gt; &lt;li&gt;cacheUrl - The URL to the copy of the document cached by Google&lt;/li&gt; &lt;/ul&gt; The query accepts one parameter: text - The string to search for A data store for retrieving search results from Google. The following attributes are supported on each item: &lt;ul&gt; &lt;li&gt;title - The blog post title in HTML format.&lt;/li&gt; &lt;li&gt;titleNoFormatting - The blog post title in plain text&lt;/li&gt; &lt;li&gt;content - A snippet of information about the blog post&lt;/li&gt; &lt;li&gt;blogUrl - The URL for the blog&lt;/li&gt; &lt;li&gt;postUrl - The URL for the a single blog post&lt;/li&gt; &lt;li&gt;visibleUrl - The URL with no protocol specified. &lt;li&gt;cacheUrl - The URL to the copy of the document cached by Google &lt;li&gt;author - The author of the blog post&lt;/li&gt; &lt;li&gt;publishedDate - The published date, in RFC-822 format&lt;/li&gt; &lt;/ul&gt; The query accepts one parameter: text - The string to search for A data store for retrieving search results from Google. The following attributes are supported on each item: &lt;ul&gt; &lt;li&gt;title - The blog post title in HTML format.&lt;/li&gt; &lt;li&gt;titleNoFormatting - The blog post title in plain text&lt;/li&gt; &lt;li&gt;content - A snippet of information about the blog post&lt;/li&gt; &lt;li&gt;url - The URL for the item&lt;/li&gt; &lt;li&gt;lat - The latitude.&lt;/li&gt; &lt;li&gt;lng - The longtitude.&lt;/li&gt; &lt;li&gt;streetAddress - The street address&lt;/li&gt; &lt;li&gt;city - The city&lt;/li&gt; &lt;li&gt;region - The region&lt;/li&gt; &lt;li&gt;country - The country&lt;/li&gt; &lt;li&gt;phoneNumbers - Phone numbers associated with this address. Can be one or more.&lt;/li&gt; &lt;li&gt;ddUrl - A URL that can be used to provide driving directions from the center of the search results to this search results&lt;/li&gt; &lt;li&gt;ddUrlToHere - A URL that can be used to provide driving directions from this search result to a user specified location&lt;/li&gt; &lt;li&gt;staticMapUrl - The published date, in RFC-822 format&lt;/li&gt; &lt;/ul&gt; The query accepts one parameter: text - The string to search for A data store for retrieving search results from Google. The following attributes are supported on each item: &lt;ul&gt; &lt;li&gt;title - The blog post title in HTML format.&lt;/li&gt; &lt;li&gt;titleNoFormatting - The blog post title in plain text&lt;/li&gt; &lt;li&gt;content - A snippet of information about the blog post&lt;/li&gt; &lt;li&gt;url - The URL for the item&lt;/li&gt; &lt;li&gt;published - The published date, in RFC-822 format.&lt;/li&gt; &lt;li&gt;publisher - The name of the publisher.&lt;/li&gt; &lt;li&gt;duration - The approximate duration, in seconds, of the video.&lt;/li&gt; &lt;li&gt;tbWidth - The width in pixels of the video.&lt;/li&gt; &lt;li&gt;tbHeight - The height in pixels of the video&lt;/li&gt; &lt;li&gt;tbUrl - The URL to a thumbnail representation of the video.&lt;/li&gt; &lt;li&gt;playUrl - If present, supplies the url of the flash version of the video that can be played inline on your page. To play this video simply create and &lt;embed&gt; element on your page using this value as the src attribute and using application/x-shockwave-flash as the type attribute. If you want the video to play right away, make sure to append &amp;autoPlay=true to the url..&lt;/li&gt; &lt;/ul&gt; The query accepts one parameter: text - The string to search for A data store for retrieving search results from Google. The following attributes are supported on each item: &lt;ul&gt; &lt;li&gt;title - The news story title in HTML format.&lt;/li&gt; &lt;li&gt;titleNoFormatting - The news story title in plain text&lt;/li&gt; &lt;li&gt;content - A snippet of information about the news story&lt;/li&gt; &lt;li&gt;url - The URL for the item&lt;/li&gt; &lt;li&gt;unescapedUrl - The URL for the item, with URL escaping. This is often more readable&lt;/li&gt; &lt;li&gt;publisher - The name of the publisher&lt;/li&gt; &lt;li&gt;clusterUrl - A URL pointing to a page listing related storied.&lt;/li&gt; &lt;li&gt;location - The location of the news story.&lt;/li&gt; &lt;li&gt;publishedDate - The date of publication, in RFC-822 format.&lt;/li&gt; &lt;li&gt;relatedStories - An optional array of objects specifying related stories. Each object has the following subset of properties: &quot;title&quot;, &quot;titleNoFormatting&quot;, &quot;url&quot;, &quot;unescapedUrl&quot;, &quot;publisher&quot;, &quot;location&quot;, &quot;publishedDate&quot;. &lt;/li&gt; &lt;/ul&gt; The query accepts one parameter: text - The string to search for A data store for retrieving search results from Google. The following attributes are supported on each item: &lt;ul&gt; &lt;li&gt;title - The book title in HTML format.&lt;/li&gt; &lt;li&gt;titleNoFormatting - The book title in plain text&lt;/li&gt; &lt;li&gt;authors - An array of authors&lt;/li&gt; &lt;li&gt;url - The URL for the item&lt;/li&gt; &lt;li&gt;unescapedUrl - The URL for the item, with URL escaping. This is often more readable&lt;/li&gt; &lt;li&gt;bookId - An identifier for the book, usually an ISBN.&lt;/li&gt; &lt;li&gt;pageCount - The number of pages in the book.&lt;/li&gt; &lt;li&gt;publishedYear - The year of publication.&lt;/li&gt; &lt;/ul&gt; The query accepts one parameter: text - The string to search for A data store for retrieving search results from Google. The following attributes are supported on each item: &lt;ul&gt; &lt;li&gt;title - The image title in HTML format.&lt;/li&gt; &lt;li&gt;titleNoFormatting - The image title in plain text&lt;/li&gt; &lt;li&gt;url - The URL for the image&lt;/li&gt; &lt;li&gt;unescapedUrl - The URL for the image, with URL escaping. This is often more readable&lt;/li&gt; &lt;li&gt;tbUrl - The URL for the image thumbnail&lt;/li&gt; &lt;li&gt;visibleUrl - A shortened version of the URL associated with the result, stripped of a protocol and path&lt;/li&gt; &lt;li&gt;originalContextUrl - The URL of the page containing the image.&lt;/li&gt; &lt;li&gt;width - The width of the image in pixels.&lt;/li&gt; &lt;li&gt;height - The height of the image in pixels.&lt;/li&gt; &lt;li&gt;tbWidth - The width of the image thumbnail in pixels.&lt;/li&gt; &lt;li&gt;tbHeight - The height of the image thumbnail in pixels.&lt;/li&gt; &lt;li&gt;content - A snippet of information about the image, in HTML format&lt;/li&gt; &lt;li&gt;contentNoFormatting - A snippet of information about the image, in plain text&lt;/li&gt; &lt;/ul&gt; The query accepts one parameter: text - The string to search for Initializer for the HTML table store. url of the remote page to load id of the table element in the remote page Function to load the attribute names from the table header so that the attributes (cells in a row), can have a reasonable name. For list items, returns single implicit heading, [&quot;name&quot;] Function to return all rows in the table as an array of items. This function tests whether the item passed in is indeed an item in the store. The item to test for being contained by the store. This function tests whether the item passed in is indeed a valid 'attribute' like type for the store. Returns the index (column) that the attribute resides in the row. The attribute to test for being contained by the store. See dojo.data.api.Read.getValue() See dojo.data.api.Read.getValues() See dojo.data.api.Read.getAttributes() See dojo.data.api.Read.hasAttribute() See dojo.data.api.Read.containsValue() Internal function for looking at the values contained by the item. The data item to examine for attribute values. The attribute to inspect. The value to match. Optional regular expression generated off value if value was of string type to handle wildcarding. If present and attribute values are string, then it can be used for comparison instead of 'value' See dojo.data.api.Read.isItem() See dojo.data.api.Read.isItemLoaded() See dojo.data.api.Read.loadItem() Fetch items (XML elements) that match to a query request object function to call for fetched items function to call on error Internal function for processing the passed in request and locating the requested items. See dojo.data.api.Read.getFeatures() See dojo.data.api.Read.close() nothing to do here! See dojo.data.api.Read.getLabel() See dojo.data.api.Read.getLabelAttributes() See dojo.data.api.Identity.getIdentity() See dojo.data.api.Identity.getIdentityAttributes() Identity isn't taken from a public attribute. See dojo.data.api.Identity.fetchItemByIdentity() Function to load the attribute names from the table header so that the attributes (cells in a row), can have a reasonable name. Function to return all rows in the table as an array of items. This function tests whether the item passed in is indeed an item in the store. The item to test for being contained by the store. This function tests whether the item passed in is indeed a valid 'attribute' like type for the store. Returns the index (column) that the attribute resides in the row. The attribute to test for being contained by the store. See dojo.data.api.Read.getValue() See dojo.data.api.Read.getValues() See dojo.data.api.Read.getAttributes() See dojo.data.api.Read.hasAttribute() See dojo.data.api.Read.containsValue() Internal function for looking at the values contained by the item. The data item to examine for attribute values. The attribute to inspect. The value to match. Optional regular expression generated off value if value was of string type to handle wildcarding. If present and attribute values are string, then it can be used for comparison instead of 'value' See dojo.data.api.Read.isItem() See dojo.data.api.Read.isItemLoaded() See dojo.data.api.Read.loadItem() Fetch items (XML elements) that match to a query request object function to call for fetched items function to call on error Internal function for processing the passed in request and locating the requested items. See dojo.data.api.Read.getFeatures() See dojo.data.api.Read.close() nothing to do here! See dojo.data.api.Read.getLabel() See dojo.data.api.Read.getLabelAttributes() See dojo.data.api.Identity.getIdentity() See dojo.data.api.Identity.getIdentityAttributes() Identity isn't taken from a public attribute. See dojo.data.api.Identity.fetchItemByIdentity() JsonRestStore is a Dojo Data store interface to JSON HTTP/REST web storage services that support read and write through GET, PUT, POST, and DELETE. A JsonRestStore takes a REST service or a URL and uses it the remote communication for a read/write dojo.data implementation. A JsonRestStore can be created with a simple URL like: new JsonRestStore({target:"/MyData/"}); adds a new item to the store at the specified point. Takes two parameters, data, and options. */ The data to be added in as an item. deletes item any references to that item from the store. to delete adds an item to the list of dirty items. This item contains a reference to the item itself as well as a cloned and trimmed version of old item for use with revert. sets 'attribute' on 'item' to 'value' sets 'attribute' on 'item' to 'value' value must be an array. unsets 'attribute' on 'item' Saves the dirty data using REST Ajax methods. See dojo.data.api.Write for API. kwArgs.global: This will cause the save to commit the dirty data for all JsonRestStores as a single transaction. Checks to see if a passed 'item' is really belongs to this JsonRestStore. */ attribute: /* string */ Gets the constructor for objects from this store return the store feature set constructor This function tests whether the item passed in is indeed an item in the store. The item to test for being contained by the store. This function tests whether the item passed in is indeed a valid 'attribute' like type for the store. The attribute to test for being contained by the store. See dojo.data.api.Read.getValue() See dojo.data.api.Read.getValues() Key/Value syntax does not support multi-valued attributes, so this is just a wrapper function for getValue(). See dojo.data.api.Read.getAttributes() See dojo.data.api.Read.hasAttribute() See dojo.data.api.Read.containsValue() Internal function for looking at the values contained by the item. The data item to examine for attribute values. The attribute to inspect. The value to match. Optional regular expression generated off value if value was of string type to handle wildcarding. If present and attribute values are string, then it can be used for comparison instead of 'value' See dojo.data.api.Read.isItem() See dojo.data.api.Read.isItemLoaded() The KeyValueStore always loads all items, so if it's an item, then it's loaded. See dojo.data.api.Read.loadItem() See dojo.data.api.Read.getFeatures() See dojo.data.api.Read.close() See dojo.data.api.Read.getLabel() See dojo.data.api.Read.getLabelAttributes() See dojo.data.util.simpleFetch.fetch() Internal function to execute delayed request in the store. Execute any deferred fetches now. See dojo.data.api.Identity.getIdentity() See dojo.data.api.Identity.getIdentifierAttributes() See dojo.data.api.Identity.fetchItemByIdentity() constructor This function tests whether the item passed in is indeed a valid 'attribute' like type for the store. The attribute to test for being contained by the store. Internal function to recurse over all child nodes from the store and add them As non-toplevel items The child node to walk. Internal function to determine which list of items to search over. The query options parameter, if any. See dojo.data.api.Read.getValue() See dojo.data.api.Read.getValues() See dojo.data.api.Read.getAttributes() See dojo.data.api.Read.hasAttribute() See dojo.data.api.Read.containsValue() Internal function for looking at the values contained by the item. The data item to examine for attribute values. The attribute to inspect. The value to match. Optional regular expression generated off value if value was of string type to handle wildcarding. If present and attribute values are string, then it can be used for comparison instead of 'value' See dojo.data.api.Read.isItem() See dojo.data.api.Read.isItemLoaded() OpmlStore loads every item, so if it's an item, then it's loaded. See dojo.data.api.Read.loadItem() See dojo.data.api.Read.getLabel() See dojo.data.api.Read.getLabelAttributes() See dojo.data.util.simpleFetch.fetch() See dojo.data.api.Read.getFeatures() See dojo.data.api.Identity.getIdentity() See dojo.data.api.Identity.fetchItemByIdentity() See dojo.data.api.Identity.getIdentifierAttributes() Identity isn't a public attribute in the item, it's the node count. So, return null. Internal function to execute delayed request in the store. Execute any deferred fetches now. See dojo.data.api.Read.close() Creates Dojo data stores for all the table/classes on a Persevere server URL of the Persevere server's root, this normally just &quot;/&quot; which is the default value if the target is not provided callback: Allows the operation to happen asynchronously return: A map/object of datastores. The name of each property is a the name of a store, and the value is the actual data store object. Invokes the XHR proxy plugin. Call this if you will be using x-site data. Indexes and resolves references in the JSON object. The root object of the object graph to be processed with additional arguments: The *index* parameter. This is the index object (map) to use to store an index of all the objects. If you are using inter-message referencing, you must provide the same object for each call. The *defaultId* parameter. This is the default id to use for the root object (if it doesn't define it's own id) The *idPrefix* parameter. This the prefix to use for the ids as they enter the index. This allows multiple tables to use ids (that might otherwise collide) that enter the same global index. idPrefix should be in the form &quot;/Service/&quot;. For example, if the idPrefix is &quot;/Table/&quot;, and object is encountered {id:&quot;4&quot;,...}, this would go in the index as &quot;/Table/4&quot;. The *idAttribute* parameter. This indicates what property is the identity property. This defaults to &quot;id&quot; The *assignAbsoluteIds* parameter. This indicates that the resolveJson should assign absolute ids (__id) as the objects are being parsed. The *schemas* parameter This provides a map of schemas, from which prototypes can be retrieved The *loader* parameter This is a function that is called added to the reference objects that can't be resolved (lazy objects) return: An object, the result of the processing evaluates the passed string-form of a JSON object. a string literal of a JSON item, for instance: '{ &quot;foo&quot;: [ &quot;bar&quot;, 1, { &quot;baz&quot;: &quot;thud&quot; } ] }' See resolveJson return: An object, the result of the evaluation Create a JSON serialization of an object. This has support for referencing, including circular references, duplicate references, and out-of-message references id and path-based referencing is supported as well and is based on http://www.json.com/2007/10/19/json-referencing-proposal-and-library/. an object to be serialized. if true, we indent objects and arrays to make the output prettier. The variable dojo.toJsonIndentStr is used as the indent string -- to use something other than the default (tab), change that variable before calling dojo.toJson(). The prefix that has been used for the absolute ids return: a String representing the serialized version of the passed object. Initializer for the PicasaStore store. This function tests whether the item passed in is indeed an item in the store. The item to test for being contained by the store. This function tests whether the item passed in is indeed a valid 'attribute' like type for the store. The attribute to test for being contained by the store. See dojo.data.api.Read.getFeatures() See dojo.data.api.Read.getValue() See dojo.data.api.Read.getAttributes() See dojo.data.api.Read.hasAttributes() See dojo.data.api.Read.isItemLoaded() See dojo.data.api.Read.loadItem() See dojo.data.api.Read.getLabel() See dojo.data.api.Read.getLabelAttributes() See dojo.data.api.Read.containsValue() See dojo.data.api.Read.getValue() See dojo.data.api.Read.isItem() See dojo.data.api.Read.close() Fetch picasa items that match to a query request object function to call for fetched items function to call on error Utility function to un-escape XML special characters in an HTML string. HTML String converted back to the normal text (unescaped) characters (<,>,&, ", etc,). TODO: Check to see if theres already compatible escape() in dojo.string or dojo.html The string to un-escape This class provides a store that is mainly intended to be used for loading data dynamically from the server, used i.e. for retreiving chunks of data from huge data stores on the server (by server-side filtering!). Upon calling the fetch() method of this store the data are requested from the server if they are not yet loaded for paging (or cached). For example used for a combobox which works on lots of data. It can be used to retreive the data partially upon entering the letters &quot;ac&quot; it returns only items like &quot;action&quot;, &quot;acting&quot;, etc. note: The field name &quot;id&quot; in a query is reserved for looking up data by id. This is necessary as before the first fetch, the store has no way of knowing which field the server will declare as identifier. // The parameter "query" contains the data that are sent to the server. var store = new dojox.data.QueryReadStore({url:'/search.php'}); store.fetch({query:{name:'a'}, queryOptions:{ignoreCase:false}}); // Since "serverQuery" is given, it overrules and those data are // sent to the server. var store = new dojox.data.QueryReadStore({url:'/search.php'}); store.fetch({serverQuery:{name:'a'}, queryOptions:{ignoreCase:false}}); <div dojoType="dojox.data.QueryReadStore" jsId="store2" url="../tests/stores/QueryReadStore.php" requestMethod="post"></div> <div dojoType="dojox.grid.data.DojoData" jsId="model2" store="store2" sortFields="[{attribute: 'name', descending: true}]" rowsPerPage="30"></div> <div dojoType="dojox.Grid" id="grid2" model="model2" structure="gridLayout" style="height:300px; width:800px;"></div> todo: - there is a bug in the paging, when i set start:2, count:5 after an initial fetch() and doClientPaging:true it returns 6 elemetns, though count=5, try it in QueryReadStore.html - add optional caching - when the first query searched for "a" and the next for a subset of the first, i.e. "ab" then we actually dont need a server request, if we have client paging, we just need to filter the items we already have that might also be tooo much logic See dojo.data.api.Read.hasAttribute() See dojo.data.api.Read.getLabel() See dojo.data.api.Read.getLabelAttributes() The request contains the data as defined in the Read-API. Additionally there is following keyword &quot;serverQuery&quot;. The *serverQuery* parameter, optional. This parameter contains the data that will be sent to the server. If this parameter is not given the parameter &quot;query&quot;'s data are sent to the server. This is done for some reasons: - to specify explicitly which data are sent to the server, they might also be a mix of what is contained in &quot;query&quot;, &quot;queryOptions&quot; and the paging parameters &quot;start&quot; and &quot;count&quot; or may be even completely different things. - don't modify the request.query data, so the interface using this store can rely on unmodified data, as the combobox dijit currently does it, it compares if the query has changed - request.query is required by the Read-API I.e. the following examples might be sent via GET: fetch({query:{name:&quot;abc&quot;}, queryOptions:{ignoreCase:true}}) the URL will become: /url.php?name=abc fetch({serverQuery:{q:&quot;abc&quot;, c:true}, query:{name:&quot;abc&quot;}, queryOptions:{ignoreCase:true}}) the URL will become: /url.php?q=abc&amp;c=true // The serverQuery-parameter has overruled the query-parameter // but the query parameter stays untouched, but is not sent to the server! // The serverQuery contains more data than the query, so they might differ! If the data from servers needs to be processed before it can be processed by this store, then this function should be re-implemented in subclass. This default implementation just return the data unchanged. data received from server It throws an error if item is not valid, so you can call it in every method that needs to throw an error when item is invalid. The item to test for being contained by the store. This function tests whether the item passed in is indeed a valid 'attribute' like type for the store. The attribute to test for being contained by the store. See dojo.data.api.Identity.fetchItemByIdentity() See if we have already loaded the item with that id In case there hasn't been a fetch yet, _itemsByIdentity is null and thus a fetch will be triggered below. See dojo.data.api.Identity.getIdentity() See dojo.data.api.Identity.getIdentityAttributes() ServiceStore constructor, instantiate a new ServiceStore A ServiceStore can be configured from a JSON Schema. Queries are just passed through to the underlying services Gets the value of an item's 'property' The item to get the value from property to look up value for the default value Gets the value of an item's 'property' and returns it. If this value is an array it is just returned, if not, the value is added to an array and that is returned. */ */ property to look up value for Gets the available attributes of an item's 'property' and returns it as an array. */ Checks to see if item has attribute */ */ Checks to see if 'item' has 'value' at 'attribute' */ */ */ Checks to see if the argument is an item */ attribute: /* string */ we have no way of determining if it belongs, we just have object returned from service queries Checks to see if the item is loaded. */ Loads an item that has not been loaded yet. If you access a value directly through property access, you can use this to load a lazy (Deferred) value. See dojo.data.api.Read.fetch The *queryOptions.cache* parameter If true, indicates that the query result should be cached for future use. This is only available if dojox.data.ClientFilter has been loaded before the ServiceStore The *syncMode* parameter Indicates that the call should be fetch synchronously if possible (this is not always possible) The *clientFetch* parameter This is a fetch keyword argument for explicitly doing client side filtering, querying, and paging return the store feature set returns an array of attributes that are used to create the label of an item returns the attributes which are used to make up the identity of an item. Basically returns this.idAttribute fetch an item by its identity, by looking in our index of what we have loaded Initialize a SnapLogicStore object. URL to the SnapLogic pipeline's output routed through PipeToHttp. Typically, this will look like &quot;http://&lt;server-host&gt;:&lt;port&gt;/pipe/&lt;pipeline-url&gt;/&lt;pipeline-output-view&gt;&quot;. parameters: An object whose properties define parameters to the pipeline. The values of these properties will be sent to the pipeline as parameters when it run. This function tests whether the item passed in is indeed an item in the store. The item to test for being contained by the store. This function tests whether the item passed in is indeed a valid 'attribute' like type for the store. The attribute to test for being contained by the store. See dojo.data.api.Read.getFeatures() See dojo.data.api.Read.getValue() See dojo.data.api.Read.getAttributes() See dojo.data.api.Read.hasAttributes() See dojo.data.api.Read.isItemLoaded() See dojo.data.api.Read.loadItem() See dojo.data.api.Read.getLabel() See dojo.data.api.Read.getLabelAttributes() See dojo.data.api.Read.containsValue() See dojo.data.api.Read.getValue() See dojo.data.api.Read.isItem() See dojo.data.api.Read.close() Process data retrieved via fetch and send it back to requester. response: The data returend from the I/O transport. In the normal case, it will be an array of result rows from the pipeline. In the special case for record count optimization, response will be an array with a single element containing the total pipeline result row count. See fetch() for details on this optimization. Handle the individual replies for both data and length requests. The request/handle object used with the original fetch() call. A value indicating which request this handler call is for (this.Parts). Response received from the underlying IO transport. See dojo.data.api.Read.close() See dojo.data.api.Read.close() for generic interface. In addition to the standard Read API fetch support, this store supports an optimization for for retrieving the total count of records in the Pipeline without retrieving the data. To use this optimization, simply provide an onBegin handler without an onItem or onComplete handler. Initializer for the Wikipedia data store interface. var store = new dojox.data.WikipediaStore(); store.fetch({ query: {title:"Dojo Toolkit"}, onItem: function(item){ dojo.byId("somediv").innerHTML = item.text["*"]; } }); Fetch a page or some partially-loaded search results from Wikipedia. Note that there isn't a way to sort data coming in from the API, so we just ignore the *sort* parameter. Loading a page: store.fetch({ query: {title:"Dojo Toolkit"}, // define your handlers here }); Constructor for the XML store. url to a service or an XML document that represents the store tag name for root items attribute name for a key or an indentify attributeMap: An anonymous object contains properties for attribute mapping, {&quot;tag_name.item_attribute_name&quot;: &quot;@xml_attribute_name&quot;, ...} boolean indicate to add a query string to the service URL Return an attribute value An attribute value found, otherwise 'defaultValue' An XML element that holds the attribute A tag name of a child element, An XML attribute name or one of special names A default value Return an array of attribute values An array of attribute values found, otherwise an empty array An XML element that holds the attribute A tag name of child elements, An XML attribute name or one of special names Return an array of attribute names An array of attributes found An XML element Check whether an element has the attribute True if the element has the attribute, otherwise false must be an instance of a dojox.data.XmlItem from the store instance. A tag name of a child element, An XML attribute name or one of special names Check whether the attribute values contain the value True if the attribute values contain the value, otherwise false must be an instance of a dojox.data.XmlItem from the store instance. A tag name of a child element, An XML attribute name or one of special names Check whether the object is an item (XML element) item: An object to check True if the object is an XML element, otherwise false Check whether the object is an item (XML element) and loaded item: An object to check True if the object is an XML element, otherwise false Load an item (XML element) containing the args for loadItem. See dojo.data.api.Read.loadItem() Return supported data APIs "dojo.data.api.Read" and "dojo.data.api.Write" See dojo.data.api.Read.getLabel() See dojo.data.api.Read.getLabelAttributes() Fetch items (XML elements) that match to a query request object function to call for fetched items function to call on error Generate a URL for fetch A fetch URL request object Fetch items (XML elements) in an XML document based on a request An array of items XML document request object See dojo.data.api.Read.close() Return a new dojox.data.XmlItem An XML element An object containing initial attributes Delete an dojox.data.XmlItem (wrapper to a XML element). True An XML element to delete Set an attribute value False for "tagName", otherwise true An XML element that holds the attribute A tag name of a child element, An XML attribute name or one of special names A attribute value to set Set attribute values False for "tagName", otherwise true An XML element that holds the attribute A tag name of child elements, an XML attribute name or one of special names value: A attribute value to set Remove an attribute False for "tagName", otherwise true An XML element that holds the attribute A tag name of child elements, an XML attribute name or one of special names Save new and/or modified items (XML elements) An object for callbacks Invalidate changes (new and/or modified elements) True Check whether an item is new, modified or deleted True if an item or items are new, modified or deleted, otherwise false An item (XML element) to check Generate a URL for post A post URL item to save Generate a URL for put A put URL item to save Generate a URL for delete A delete URL item to delete Generate a content to post A post content item to save Generate a content to put A post content item to save Initialize with an XML element XML element containing store, if any. Return a value of the first text child of the element a value of the first text child of the element cross-browser implementation of creating an XML document object. Optional text to create the document from. If not provided, an empty XML document will be created. If str is empty string &quot;&quot;, then a new empty document will be created. Optional mimetype of the text. Typically, this is text/xml. Will be defaulted to text/xml if not provided. Implementation of the DOM Level 3 attribute; scan node for text The node to get the text off of or set the text on. Optional argument of the text to apply to the node. Removes all children of node and appends newChild. All the existing children will be destroyed. The node to modify the children on The children to add to the node. It can either be a single Node or an array of Nodes. removes all children from node and returns the count of children removed. The children nodes are not destroyed. Be sure to call dojo._destroyElement on them after they are not used anymore. The node to remove all the children from. Implementation of MS's innerXML function. The node from which to generate the XML text representation. jsonPathStore constructor, instantiate a new jsonPathStore Takes a single optional parameter in the form of a Javascript object containing one or more of the following properties. data: /*JSON String*/ || /* Javascript Object */, JSON String or Javascript object this store will control JSON is converted into an object, and an object passed to the store will be used directly. If no data and no url is provide, an empty object, {}, will be used as the initial store. url: /* string url */ Load data from this url in JSON format and use the Object created from the data as the data source. indexOnLoad: /* boolean */ Defaults to true, but this may change in the near future. Parse the data object and set individual objects up as appropriate. This will add meta data and assign id's to objects that dont' have them as defined by the idAttribute option. Disabling this option will keep this parsing from happening until a query is performed at which time only the top level of an item has meta info stored. This might work in some situations, but you will almost always want to indexOnLoad or use another option which will create an index. In the future we will support a generated index that maps by jsonPath allowing the server to take some of this load for larger data sets. idAttribute: /* string */ Defaults to '_id'. The name of the attribute that holds an objects id. This can be a preexisting id provided by the server. If an ID isn't already provided when an object is fetched or added to the store, the autoIdentity system will generate an id for it and add it to the index. There are utility routines for exporting data from the store that can clean any generated IDs before exporting and leave preexisting id's in tact. metaLabel: /* string */ Defaults to '_meta' overrides the attribute name that is used by the store for attaching meta information to an object while in the store's control. Defaults to '_meta'. hideMetaAttributes: /* boolean */ Defaults to False. When enabled, calls to getAttributes() will not include the meta attribute. autoIdPrefix: /*string*/ Defaults to &quot;_auto_&quot;. This string is used as the prefix to any objects which have a generated id. A numeric index is appended to this string to complete the ID mode: dojox.data.ASYNC_MODE || dojox.data.SYNC_MODE Defaults to ASYNC_MODE. This option sets the default mode for this store. Sync calls return their data immediately from the calling function instead of calling the callback functions. Functions such as fetchItemByIdentity() and fetch() both accept a string parameter in addtion to the normal keywordArgs parameter. When passed this option, SYNC_MODE will automatically be used even when the default mode of the system is ASYNC_MODE. A normal request to fetch or fetchItemByIdentity (with kwArgs object) can also include a mode property to override this setting for that one request. load data into the store. Index it if appropriate. set the stores' data to the supplied object and then load and/or setup that data with the required meta info parse the object structure, and turn any objects into jsonPathStore items. Basically this just does a recursive series of fetches which itself already examines any items as they are retrieved and setups up the required meta information. */ jsonPath Query for the starting point of this index construction. make sure we have an reference to the item in the store and not a clone. Takes an item, matches it to the corresponding item in the store and if it is the same, returns itself, otherwise it returns the item from the store. Gets the value of an item's 'property' */ */ property to look up value for Gets the value of an item's 'property' and returns it. If this value is an array it is just returned, if not, the value is added to an array and that is returned. */ */ property to look up value for Gets the available attributes of an item's 'property' and returns it as an array. If the store has 'hideMetaAttributes' set to true the attributed identified by 'metaLabel' will not be included. */ Checks to see if item has attribute */ */ Checks to see if 'item' has 'value' at 'attribute' */ */ */ Checks to see if a passed 'item' is really a jsonPathStore item. Currently it only verifies structure. It does not verify that it belongs to this store at this time. */ attribute: /* string */ returns isItem() :) */ returns true. Future implementatins might alter this verifies that 'item' has a meta object attached and if not it creates it by setting it to 'props' if the meta attribute already exists, mix 'props' into it. exports the store data set. Takes an options object with a number of parameters data: /* object */ Defaults to the root of the store. The data to be exported. clone: /* boolean */ clone the data set before returning it or modifying it for export cleanMeta: /* boolean */ clean the meta data off of the data. Note that this will happen to the actual store data if !clone. If you want to continue using the store after this operation, it is probably better to export it as a clone if you want it cleaned. suppressExportMeta: /* boolean */ By default, when data is exported from the store some information, such as as a timestamp, is added to the root of exported data. This prevents that from happening. It is mainly used for making tests easier. type: &quot;raw&quot; || &quot;json&quot; Defaults to 'json'. 'json' will convert the data into json before returning it. 'raw' will just return a reference to the object return the store feature set returns an array of attributes that are used to create the label of an item returns the attributes which are used to make up the identity of an item. Basically returns this.idAttribute fetch an item by its identity. This store also provides a much more finger friendly alias, 'byId' which does the same thing as this function. If provided a string this call will be treated as a SYNC request and will return the identified item immediatly. Alternatively it takes a object as a set of keywordArgs: identity: /* string */ the id of the item you want to retrieve mode: dojox.data.SYNC_MODE || dojox.data.ASYNC_MODE overrides the default store fetch mode onItem: /* function */ Result call back. Passed the fetched item. onError: /* function */ error callback. adds a new item to the store at the specified point. Takes two parameters, data, and options. */ The data to be added in as an item. This could be a new javascript object, or it could be an item that already exists in the store. If it already exists in the store, then this will be added as a reference. */ item: /* item */ reference to an existing store item attribute: /* string */ attribute to add the item at. If this is not provided, the item's id will be used as the attribute name. If specified attribute is an array, the new item will be push()d on to the end of it. oldValue: /* old value of item[attribute] newValue: new value item[attribute] adds an item to the list of dirty items. This item contains a reference to the item itself as well as a cloned and trimmed version of old item for use with revert. sets 'attribute' on 'item' to 'value' sets 'attribute' on 'item' to 'value' value must be an array. unsets 'attribute' on 'item' Takes an optional set of keyword Args with some save options. Currently only format with options being &quot;raw&quot; or &quot;json&quot;. This function goes through the dirty item lists, clones and trims the item down so that the items children are not part of the data (the children are replaced with reference objects). This data is compiled into a single array, the dirty objects are all marked as clean, and the new data is then passed on to the onSave handler. specialized mixin that hooks up objects in the store where references are identified. copy an item recursively stoppying at other items that have id's and replace them with a refrence object; notification of the save event..not part of the notification api, but probably should be. console.log(&quot;onSave() &quot;, items); notification of the revert event..not part of the notification api, but probably should be. Additional date manipulation functions This is the constructor var date1 = new dojox.date.HebrewDate(); var date2 = new dojox.date.HebrewDate("12\2\5768"); var date3 = new dojox.date.HebrewDate(date2); var date4 = new dojox.date.HebrewDate(5768,2,12); This function returns the date value (1 - 30) var date1 = new dojox.date.HebrewDate(); document.writeln(date1.getDate); This function return the month value ( 0 - 11 ) var date1 = new dojox.date.HebrewDate(); document.writeln(date1.getMonth()+1); This function return the Year value var date1 = new dojox.date.HebrewDate(); document.writeln(date1.getFullYear()); returns the Hour value returns the Minuites value returns the seconde value returns the Milliseconds value This function sets the Date var date1 = new dojox.date.HebrewDate(); date1.setDate(2); This function set Year var date1 = new dojox.date.HebrewDate(); date1.setYear(5768); This function set Month var date1 = new dojox.date.HebrewDate(); date1.setMonth(2); set the Hours set the Minutes This returns a string representation of the date in &quot;DDDD MMMM DD YYYY HH:MM:SS&quot; format var date1 = new dojox.date.HebrewDate(); document.writeln(date1.toString()); FIXME: TZ/DST issues? This function parse the date string var dateIslamic = new dojox.date.IslamicDate(); dateIslamic.parse("Heshvan 2 5768"); returns the number of days in the month used This function returns the equivalent Hebrew Date value for the Gregorian Date var dateHebrew = new dojox.date.HebrewDate(); var dateGregorian = new Date(2008,10,12); dateHebrew.fromGregorian(dateGregorian); This returns the equevalent Grogorian date value in Date object var dateHebrew = new dojox.date.HebrewDate(5768,11,20); var dateGregorian = dateHebrew.toGregorian(); This function return Week Day value ( 0 - 6 ) var date1 = new dojox.date.HebrewDate(); document.writeln(date1.getDay()); returns the Julian day of a Gregorian date Used to get localized strings from dojo.cldr for day or month names. months || 'days' wide || 'narrow' || 'abbr' (e.g. &quot;Monday&quot;, &quot;Mon&quot;, or &quot;M&quot; respectively, in English) standAlone || 'format' (default) override locale used to find the names This is the constructor var date1 = new dojox.date.IslamicDate(); var date2 = new dojox.date.IslamicDate("12\2\1429"); var date3 = new dojox.date.IslamicDate(date2); var date4 = new dojox.date.IslamicDate(1429,2,12); This function sets the Date var date1 = new dojox.date.IslamicDate(); date1.setDate(2); Used to get localized strings from dojo.cldr for day or month names. months || 'days' wide || 'narrow' || 'abbr' (e.g. &quot;Monday&quot;, &quot;Mon&quot;, or &quot;M&quot; respectively, in English) standAlone || 'format' (default) override locale used to find the names Get a formatted string for a given date object Format the internal date object Day of the month, 2 digits with leading zeros Day of the month without leading zeros A full textual representation of the day of the week Numeric representation of the day of the week The day of the year (starting from 0) Numeric representation of a month, with leading zeros Numeric representation of a month, without leading zeros Number of days in the given month ISO-8601 year number. This has the same value as Y, except that if the ISO week number (W) belongs to the previous or next year, that year is used instead. (added in PHP 5.1.0) TODO: Figure out what this means A two digit representation of a year Lowercase Ante meridiem and Post meridiem Uppercase Ante meridiem and Post meridiem 12-hour format of an hour without leading zeros 12-hour format of an hour with leading zeros Minutes with leading zeros Seconds, with leading zeros Timezone identifier (added in PHP 5.1.0) ISO 8601 date (added in PHP 5) RFC 2822 formatted date A textual representation of a day, three letters ISO-8601 numeric representation of the day of the week (added in PHP 5.1.0) English ordinal suffix for the day of the month, 2 characters ISO-8601 week number of year, weeks starting on Monday (added in PHP 4.1.0) A full textual representation of a month, such as January or March A short textual representation of a month, three letters Whether it's a leap year A full numeric representation of a year, 4 digits Swatch Internet time A day is 1,000 beats. All time is measured from GMT + 1 24-hour format of an hour without leading zeros 24-hour format of an hour with leading zeros Whether or not the date is in daylight saving time TODO: Can dojo.date do this? Difference to Greenwich time (GMT) in hours Difference to Greenwich time (GMT) with colon between hours and minutes (added in PHP 5.1.3) Timezone abbreviation Timezone offset in seconds. The offset for timezones west of UTC is always negative, and for those east of UTC is always positive. Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) Formats the date object using the specifications of the POSIX strftime function Return a date object representing the first day of the given date's week. Set the ISO8601 week number of the given date. The week containing January 4th is the first week of the year. can be positive or negative: -1 is the year's last week. Get the ISO8601 week number of the given date. The week containing January 4th is the first week of the year. See http://en.wikipedia.org/wiki/ISO_week_date Determine the number of ISO8601 weeks in the year of the given date. Most years have 52 but some have 53. See http://www.phys.uu.nl/~vgent/calendar/isocalendar_text3.htm Django Templating Language implementation Returns a clone of this context object, with the items from the passed objecct mixed in. Returns a clone of this context, only containing the items defined in the filter. Quickly switch between templated by location Layer for dijit._Templated.getCachedTemplate Pass one of these when rendering a template to tell the template what values to use. A node reference or set of nodes The context object or location Uses a string to find (and manipulate) a variable Allows us to render a group of nodes Add a new node to the list Adds all content onto the buffer A node to be processed as a variable Parser used during initialization and for tag groups. Turns tokens into nodes Returns the next token in the list. Escapes a string's HTML Used to find both tags and filters Basic catch-all node Adds content onto the buffer Converts newlines into &lt;p&gt; and &lt;br /&gt;s Converts newlines into &lt;br /&gt;s Removes a space separated list of [X]HTML tags from the output&quot; Strips all [X]HTML tags Given a whole number, returns the 1-based requested digit of it desciprtion: 1 is the right-most digit, 2 is the second-right-most digit, etc. Returns the original value for invalid input (if input or argument is not an integer, or if argument is less than 1). Otherwise, output is always an integer. Takes a list of dicts, returns that list sorted by the property given in the argument. Takes a list of dicts, returns that list sorted in reverse order by the property given in the argument. Returns the first item in a list Joins a list with a string, like Python's ``str.join(list)`` Returns the length of the value - useful for lists Returns a boolean of whether the value's length is the argument Returns a random item from the list Returns a slice of the list. Recursively takes a self-nested list and returns an HTML unordered list -- WITHOUT opening and closing &lt;ul&gt; tags. If value is unavailable, use given default If value is null, use given default Returns true if the value is devisible by the argument&quot; arg being a comma-delimited string, value of true/false/none chooses the appropriate item from the string Format the value like a 'human-readable' file size (i.e. 13 KB, 4.1 MB, 102bytes, etc). Returns a plural suffix if the value is not 1, for '1 vote' vs. '2 votes' Takes a phone number and converts it in to its numerical equivalent A wrapper around toJson unless something better comes along Adds slashes - useful for passing strings to JavaScript, for example. Capitalizes the first character of the value Centers the value in a field of a given width Removes all values of arg from the given string Replaces ampersands with ``&amp;amp;`` entities Format a number according to arg Displays text with line numbers Converts a string into all lowercase Returns the value turned into a list. For an integer, it's a list of digits. For a string, it's a list of characters. Converts to lowercase, removes non-alpha chars and converts spaces to hyphens Formats the variable according to the argument, a string formatting specifier. This specifier uses Python string formating syntax, with the exception that the leading &quot;%&quot; is dropped. Converts a string into titlecase Truncates a string after a certain number of words Number of words to truncate after Use this object for HTML templating Allows the manipulation of DOM Stub called when setParent is used. Stub called before new nodes are added Stub called after new nodes are added Stub called when nodes are removed Stub called when an attribute is changed Stub called when a data in a node is changed Stub called when a node is duplicated Stub to call when you're adding an event Places a node into DOM A list of any HTML-specific node object A really expensive way of checking to see how a rendering will look. Used in the ifchanged tag Used to create an identical copy of a NodeList, useful for things like the for tag. A node to be processed as a variable Changes the parent during render/unrender Works on attributes Adds a straight text node without any processing Turn a simple array into a set of objects Returns the next token in the list. Takes two datetime objects and returns the time between then and now as a nicely formatted string, e.g &quot;10 minutes&quot; Time, in 12-hour hours and minutes, with minutes left off if they're zero. Month abbreviation in Associated Press style. Proprietary extension. Time, in 12-hour hours, minutes and 'a.m.'/'p.m.', with minutes left off if they're zero and the strings 'midnight' and 'noon' if appropriate. A global object that handles common tasks for all the plugins. Since there are several plugins that are all calling common methods, it's preferable that they call a centralized location that either has a set variable or a timeout to only repeat code-heavy calls when necessary. Initialize the global handler upon a plugin's first instance of setEditor All plugins will attempt initialization. We only need to do so once. A collection of Plugins for inserting and modifying tables in the Editor See end of this document for all avaiable plugs and dojox/editorPlugins/tests/editorTablePlugs.html for an example NOT IMPLEMENTED: Not handling cell merge, span or split Adds an icon to the Editor toolbar that when clicked, opens a system dialog Although the toolbar icon is a tiny &quot;image&quot; the uploader could be used for any file type The URL of the movie to embed. A unique key that will be used as the id of the created markup. If you don't provide this, a unique key will be generated. The width of the embedded movie; the default value is 320px. The height of the embedded movie; the default value is 240px Any CSS style information (i.e. style=&quot;background-color:transparent&quot;) you want to define on the markup. A set of key/value pairs that you want to define in the resultant markup. A set of key/value pairs that the Flash movie will interpret as FlashVars. Whether or not to include any kind of expressInstall info. Default is false. A url to redirect the browser to if the current Flash version is not supported. Creates a wrapper object around a Flash movie. Wrapper object will insert the movie reference in node; when the browser first starts grabbing the movie, onReady will be fired; when the movie has finished loading, it will fire onLoad. If your movie uses ExternalInterface, you should use the onLoad event to do any kind of proxy setup (see dojox.embed.Flash.proxy); this seems to be the only consistent time calling EI methods are stable (since the Flash movie will shoot several methods into the window object before EI callbacks can be used properly). Embed a flash movie in a document using the new operator, and get a reference to it. var movie = new dojox.embed.Flash({ path: "path/to/my/movie.swf", width: 400, height: 300 }, myWrapperNode); The ID of the internal embed/object tag. Can be used to get a reference to the movie itself. A reference to the Flash movie itself. Create the set of passed methods on the dojox.embed.Flash object so that you can call that object directly, as opposed to having to delve into the internal movie to do this. Intended to make working with Flash movies that use ExternalInterface much easier to use. Create "setMessage" and "getMessage" methods on foo. var foo = new dojox.embed.Flash(args, someNode); dojo.connect(foo, "onLoad", dojo.hitch(foo, function(){ dojox.embed.Flash.proxy(this, [ "setMessage", "getMessage" ]); this.setMessage("dojox.embed.Flash.proxy is pretty cool..."); console.log(this.getMessage()); })); A widget you can use to embed either a Flash or Quicktime movie. From markup: <div dojoType="dojox.embed.Object" src="path/to/movie.swf"></div> The width of the movie. If not provided, the width of this.domNode is used. The height of the movie. If not provided, the height of this.domNode is used. The URL of the movie to embed. The eventual reference to the movie embedded. If you are looking to script control over the movie, you'd access it this way. A property bag that is created postCreate. Any additional attributes you define on your domNode will be collected and placed into this, which will then be passed to the movie constructor. Expression used on the src property to determine if this is Flash or Quicktime. Expression used on the src property to determine if this is Flash or Quicktime. Expression used on the src property to determine if this is Flash or Quicktime. Returns a reference to the HTMLObject/HTMLEmbed that is created to place the movie in the document. You can use this either with or without the new operator. Note that with any other DOM manipulation, you must wait until the document is finished loading before trying to use this. Embed a QuickTime movie in a document using the new operator, and get a reference to it. var movie = new dojox.embed.QuickTime({ path: "path/to/my/movie.mov", width: 400, height: 300 }, myWrapperNode); A unique key that will be used as the id of the created markup. If you don't provide this, a unique key will be generated. The URL of the movie to embed. The width of the embedded movie; the default value is 320px. The height of the embedded movie; the default value is 240px A set of key/value pairs that you want to define in the resultant markup. A url to redirect the browser to if the current QuickTime version is not supported. Various encoding algorithms, including crypto and digests. encodes input data in ascii85 string an array of numbers (0-255) to encode decodes the input string back to array of numbers the input string to decode encodes input data in easy64 string an array of numbers (0-255) to encode decodes the input string back to array of numbers the input string to decode Utilities to embed and communicate with Flash-based objects Sets the SWF files and versions we are using. The URL to this Flash file. Whether the Flash file is visible or not. If it is not visible we hide it off the screen. This defaults to true (i.e. the Flash file is visible). Adds a listener to know when Flash is finished loading. Useful if you don't want a dependency on dojo.event. A function that will be called when Flash is done loading. Adds a listener to know if Flash is being installed. Useful if you don't want a dependency on dojo.event. A function that will be called if Flash is being installed Called back when the Flash subsystem is finished loading. Called if Flash is being installed. A class that helps us determine whether Flash is available. The full version string, such as &quot;8r22&quot;. Whether this platform has Flash already installed. Set if we are in the middle of a Flash installation session. Boolean Asserts that this environment has the given major, minor, and revision numbers for the Flash player. Returns true if the player is equal or above the given version, false otherwise. make the revision a decimal (i.e. transform revision 14 into 0.14 A class that is used to write out the Flash object into the page. The width of this Flash applet. The default is the minimal width necessary to show the Flash settings dialog. Current value is 215 pixels. The height of this Flash applet. The default is the minimal height necessary to show the Flash settings dialog. Current value is 138 pixels. The id of the Flash object. Current value is 'flashObject'. Writes the Flash into the page. Whether to write out Express Install information. Optional value; defaults to false. figure out the SWF file to get and how to write out the correct HTML for this Flash version Object Gets the Flash object DOM node. console.debug(&quot;setVisible, visible=&quot;+visible); Sets the visibility of this Flash object. Centers the flash applet on the page. A class that is used to communicate between Flash and JavaScript. Helps install Flash plugin if needed. Boolean Determines if installation or revving of the current plugin is needed. do we even have flash? Performs installation or revving of the Flash plugin. stores initial label and timeout for reference sets state from idle to busy if no timeout is set or for other reason the user can put the button back to being idle to reset existing timeout and setting a new timeout reset the label (text) of the button; takes an HTML string on button click the button state gets changed only do something if button is not busy The individual items for a CheckedMultiSelect Whether or not this widget is disabled Set the appropriate _subClass value - based on if we are multi- or single-select Set innerHTML here - since the template gets messed up sometimes with rich text Called to force the select to match the state of the check box (only on click of the checkbox) Radio-based calls _setValueAttr instead. Sets the hover state depending on mouse state (passes through to the check box) Sets the click state (passes through to the check box) Called to force the box to match the state of the select Disables (or enables) all the children as well The option that is associated with this item Extends the core dijit MultiSelect to provide a &quot;checkbox&quot; selector Cancels the mousedown event to prevent others from stealing focus Invert the selection If null, onChange is not fired. Disable (or enable) all the children as well A validating, serializable, range-bound date text box with a popup calendar A validating, serializable, range-bound date text box with a popup calendar that contains just months. The popup widget to use. In this case, a calendar with just a Month view. A validating, serializable, range-bound date text box with a popup calendar that contains just months. The popup widget to use. In this case, a calendar with just a Month view. A validating, serializable, range-bound date text box with a popup calendar that contains only years The popup widget to use. In this case, a calendar with just a Year view. This is a &quot;Styleable&quot; select box - it is basically a DropDownButton which can take as its input a &lt;select&gt;. Add in our style to be applied to the focus node Can be true or false, default is false. Shows current state (ie, validation result) of input (Normal, Warning, or Error) See description of dijit.Tooltip.defaultPosition for details on this parameter. What to display in an &quot;empty&quot; dropdown Whether or not we have been loaded Whether or not our children have been loaded Set the value to be the first, or the selected index For the given option, return the menu item that should be used to display it. This can be overridden as needed For the given option, add a option to our dropdown If the option doesn't have a value, then a separator is added in that place. Resets the menu and the length attribute of the button - and ensures that the label is appropriately set. sets the display for the given value (or values) Called by oninit, onblur, and onkeypress. Whether or not this is a valid value Overridden so that the state will be cleared. set the missing message populates the menu A dropdown-based select stack. A styled input type=&quot;file&quot; the title of the &quot;Cancel&quot; button ugh, this should be pulled from this.domNode listen for changes on our real file input set the content of the upper input based on the semi-hidden file input method to allow use to change button label on click of cancel button, since we can't clear the input because of security reasons, we destroy it, and add a new one in it's place. An extension on dojox.form.FileInput providing background upload progress time in ms before an un-focused widget will wait before uploading the file to the url=&quot;&quot; specified default: 2 seconds The time in ms to use as the generic timing mechanism for the animations set to 1 or 0 for &quot;immediate respose&quot; FIXME: i18n somehow? Event which triggers the upload. Defaults to onblur, sending the file selected 'blurDelay' milliseconds after losing focus. Set to &quot;onchange&quot; with a low blurDelay to send files immediately after uploading. add our extra blur listeners clear the upload timer start the upload timer set the text of the progressbar innerHTML throws errors in IE! so use DOM manipulation instead this.overlay.innerHTML = title; triggers the chain of events needed to upload a file in the background. The callback to toggle the progressbar, and fire the user-defined callback accomodate our extra focusListeners stub function fired when an upload has finished. raw data found in the first [TEXTAREA] tag of the post url dojo.Deferred data being passed from the handle: callback widget pointer, so you can set this.overlay to a completed/error message easily An extended version of dojox.form.FileInputAuto that does not display an input node, but rather only a button and otherwise behaves just like FileInputAuto hide our fileInput input field in this case, set the button under where the visible button is onclick, we need to reposition our newly created input type=&quot;file&quot; A validating text box tied to a file picker popup Delay in milliseconds between when user types something and we start searching based on that value The item, in our store, of the directory relating to our value sets the value of this widget called when the path gets changed in the dropdown called when the focus node gets blurred called when the focus node gets focus called when focus is shifted away from this widget sets the value of the widget once focus has left Function to convert a formatted string to a value - we use it to verify that it *really* is a valid value kicks off a search based off the current text value of the widget callback when the user presses a key on menu popup node */ The Url the file will be uploaded or a domNode */ REQUIRED: The button that when clicked, launches the Flash Upload dialog */ if true, begins upload immediately leave false if you wish to display the text of the selection and present an &quot;upload&quot; button /* String */ The form field attribute. This will be needed by the server to get the value. If using the ReceiveFile.php test, leave this as-is. TODO:fieldName:&quot;uploadedfile&quot;, Boolean */ Option to restrict to single-file upload, or allow multi-file uploader Array[Description, FileTypes], Array[...]...] */ (an array, or an array of arrays) Restrict file selection to certain file types Empty array defaults to &quot;All Files&quot; Usage: fileMask = [&quot;Images&quot;, &quot;*.jpg;*.jpeg;*.gif;*.png&quot;] or fileMask = [ [&quot;Jpeg File&quot;, &quot;*.jpg;*.jpeg&quot;], [&quot;GIF File&quot;, &quot;*.gif&quot;], [&quot;PNG File&quot;, &quot;*.png&quot;], [&quot;All Images&quot;, &quot;*.jpg;*.jpeg;*.gif;*.png&quot;], ] NOTE: MacType is not supported, as it does not work very well. fileMask will work on a Mac, but differently than Windows. The second example above in Windows will mask All but the selected file type, shown in a drop-down at the bottom of the system dialog. In Mac, all types in all arrays will be shown and non-types masked. Handles the basic tasks of a fileInput... Does NOT create a button, it transparently overlays a button passed to it. This can be used for toolbar buttons for example. Handles the file upload. Use an example PHP script included in resources. NOTE: This looks like it is duplicating efforts of the other FileInput files, but its actually seperating the lower-level functionality, and allowing for custom buttons. LIMITATIONS: Because of the nature of this &quot;hack&quot; - floating a zero-opacity fileInput over a &quot;fake&quot; button - this won't work in all circumstances. For instance you couldn't put a fileInput in a scrolling div. Some complicated CSS can mess up the placement - or for that matter, some simple, but not expected CSS can mess up the placement. Being near the botton of a complex document can throw off the positioning. OPERA USERS: Not much love from Opera on FileInput hacks. ALSO: Only works programmatically. Does not work in markup. Use the other other FileInput files for markup solutions. USAGE: this.fileInput = new dojox.form.FileInputOverlay({button:this.button, uploadUrl:this.uploadUrl, uploadOnChange:true}); dojo.connect(this.fileInput, &quot;onChange&quot;, this, &quot;handleChange&quot;); dojo.connect(this.fileInput, &quot;onComplete&quot;, this, &quot;onComplete&quot;); */ the form node (do not set) */ The Url the file will be uploaded */ if true, begins upload immediately leave false if you wish to display the text of the selection and present an &quot;upload&quot; button */ The form field attribute. This will be needed by the server to get the value. If using the ReceiveFile.php test, leave this as-is. */ The attribute of the form field. Also accesses this object. or a domNode */ REQUIRED: The button that will get the FileInput overlay Handles File Uploading to a server (PHP script included for testing) Does *NOT* create a button, it transforms a button into an uploader. This can be used for toolbar buttons for example. FileUploader is a wrapper class. If the correct version of Flash Player is available, FileInputFlash is used. If degradable is true, and Flash Player is not installed or is outdated, FileInputOverlay is used. arguments: */ If true, will check if user has the correct version of the Flash Player installed, and if not, will cancel FileInputFlash and install FileInputOverlay instead. If false and user does not have the correct version of Flash, (or if user has Opera) FileInputFlash will install regardless, hopefully triggering the browser update mechanism. A ComboBox that accpets multiple inputs on a single line? The character to use to separate items in the ComboBox input A class that is shared between all our children - extends ValidationTextBox and provides some shared functionality Our parent (the PasswordValidator) Don't override this - we are all &quot;password&quot; types Force-set to empty string (we don't save passwords EVER)...and since _OldPWBox overrides _setValueAttr to check for empty string, call our parent class directly (not this.inherited()) A class representing our &quot;old password&quot; box. Whether or not the password is valid Updates _isPWValid if this isn't our initial update by calling our PasswordValidator's pwCheck function A class representing our new password textbox Validates our verify box - to make sure that a change to me is reflected there A class representing our verify textbox Validates that we match the &quot;real&quot; password A password validation widget that simplifies the &quot;old/new/verify&quot; style of requesting passwords. You will probably want to override this class and implement your own pwCheck function. Whether or not it is required for form submission The name to send our old password as (when form is posted) we are valid if ALL our children are valid Validating this widget validates all our children Resetting this widget resets all our children Turns the inputs inside this widget into &quot;real&quot; validation widgets - and sets up the needed connections. Overridable function for validation of the old password box. This function is called and passed the old password. Return true if it's OK to continue, and false if it is not. IMPORTANT SECURITY NOTE: Do NOT EVER EVER EVER check this in HTML or JavaScript!!! You will probably want to override this function to callback to a server to verify the password (the callback will need to be syncronous) - and it's probably a good idea to validate it again on form submission before actually doing anything destructive - that's why the &quot;oldName&quot; value is available. And don't just fetch the password from the server either :) Send the test password (probably hashed, for security) and return from the server a status instead. Again - DON'T BE INSECURE!!! Security is left as an exercise for the reader :) Sets up the correct widgets. You *MUST* specify one child text box (a simple HTML &lt;input&gt; element) with pwType=&quot;new&quot; *and* one child text box with pwType=&quot;verify&quot;. You *MAY* specify a third child text box with pwType=&quot;old&quot; in order to prompt the user to enter in their old password before the widget returns that it is valid. places focus on the first invalid input widget - if all input widgets are valid, the first widget is focused. A radio-based select stack. A widget for rating using stars. required: Boolean TODO: Can be true or false, default is false. required: false, The number of stars to show, default is 3. The current value of the Rating Render the stars depending on the value. Connect here, the value is passed to this function as the second parameter! When calling setAttribute(&quot;value&quot;, 4), set the value and render the stars accordingly. Time Spinner Matches the select's &quot;multiple=&quot; value Whether or not we are multi-valued (for form) Returns a given option (or options). The option corresponding with the given value or index. null is returned if any of the following are true: - A string value is passed in which doesn't exist - An index is passed in which is outside the bounds of the array of options - A dojox.form.__SelectOption is passed in which is not a part of the select NOTE: the compare for passing in a dojox.form.__SelectOption checks if the value property matches - NOT if the exact option exists NOTE: if passing in an array, null elements will be placed in the returned array when a value is not found. If passed in as a string, that string is used to look up the option in the array of options - based on the value property. (See dojox.form.__SelectOption). If passed in a number, then the option with the given index (0-based) within this select will be returned. If passed in a dojox.form.__SelectOption, the same option will be returned if and only if it exists within this select. If passed an array, then an array will be returned with each element in the array being looked up. If not passed a value, then all options will be returned Adds an option or options to the end of the select. If value of the option is empty or missing, a separator is created instead. Passing in an array of options will yeild slightly better performance since the children are only loaded once. Removes the given option or options. You can remove by string (in which case the value is removed), number (in which case the index in the options array is removed), or select option (in which case, the select option with a matching value is removed). You can also pass in an array of those values for a slightly better performance since the children are only loaded once. Updates the values of the given option. The option to update is matched based on the value of the entered option. Passing in an array of new options will yeild better performance since the children will only be loaded once. set the value of the widget. If a string is passed, then we set our value from looking it up. get the value of the widget. restore the value to the last value passed to onChange Loads the children represented by this widget's optiosn. reset the menu to make it &quot;populatable on the next click Sets the &quot;selected&quot; class on the item for styling purposes Returns the value of the widget by reading the options for the selected flag Loads our options and sets up our dropdown correctly. We don't want any content, so we don't call any inherit chain function. sets up our event handling that we need for functioning as a select User-overridable function which, for the given option, adds an item to the select. If the option doesn't have a value, then a separator is added in that place. Make sure to store the option in the created option widget. User-overridable function which, for the given option, removes its item from the select. Overridable function which will set the display for the widget. newDisplay is either a string (in the case of single selects) or array of strings (in the case of multi- selects) Overridable function to return the children that this widget contains. hooks into this.attr to provide a mechanism for getting the option items for the current value of the widget. Mixin for widgets that need drop down ability. responds to click events. &quot;dropDownNode&quot; can be set via a dojoAttachPoint assignment. If missing, then either focusNode or domNode (if focusNode is also missing) will be used. the node to set the popupActive class on. If missing, then focusNode or dropDownNode (if focusNode is missing) will be used. the node to display the popup around. If missing, then domNode will be used. the widget to display in the popup. This widget *must* be defined before the startup function is called. Set to true to make the drop down at least as wide as this widget. Set to false if the drop down should just be its default width When set to false, the click events will not be stopped, in case you want to use them in your subwidget called with the mouseup event if the mouseup occurred over the menu. You can try and use this event in order to automatically execute your dropdown (as if it were clicked). You mightwant to close your menu as a part of this function. callback when the user mouse clicks on menu popup node We handle mouse events using onmousedown in order to allow for selecting via a drag. So, our click is already handled, unless we are executed via keypress - in which case, this._seenKeydown will be set to true. callback when the user lifts their mouse - if we are over the menu, we execute it, otherwise, we focus our dropDown node. If the event is missing, then we are not a mouseup event. set up nodes and connect our mouse and keypress events callback when the user presses a key on menu popup node called magically when focus has shifted away from this widget and it's dropdown returns whether or not the dropdown is loaded. This can be overridden in order to force a call to loadDropDown(). loads the data for the dropdown, and at some point, calls the given callback toggle the drop-down widget; if it is up, close it, if not, open it opens the dropdown for this widget - it returns the return value of dijit.popup.open Closes the drop down on this widget Mix this class in to a dojox.form._FormSelectWidget in order to provide support for &quot;selectable&quot; multiforms. The widget is pointed to a dijit.layout.StackContainer and will handle displaying and submitting the values of only the appropriate pane. The options for this widget will be automatically set - based on the panes that are in the stack container. The &quot;title&quot; attribute of the pane will be used for the display of the option. The &quot;id&quot; attribute of the pane will be used as the value of the option. In order to avoid running into unique ID constraint issues, a stackPrefix mechanism is provided. A prefix to remove from our stack pane ids when setting our options. This exists so that we won't run into unique ID constraints. For example, if stackPrefix is set to &quot;foo_&quot;, and there are three panes in our stack with ids of &quot;foo_a&quot;, &quot;foo_b&quot;, and &quot;foo_c&quot;, then the values of the options created for the stack controller widget will be &quot;a&quot;, &quot;b&quot;, and &quot;c&quot;. This allows you to have multiple select stack widgets with the same values - without having to have the panes require the same ids. Gets the pane ID given an option value Gets the option value given a pane ID called when a pane is either shown or hidden (so that we can toggle the widgets on it) Called when the stack container adds a new pane Called when the stack container removes a pane Called when the stack container selects a new pane Called when the stack container is started up Called when form select widget's value has changed Extension animations to the core dojo FX project Module to provide scroll-related FX Module to provide CSS animations Creates an animation that will size a node // size #myNode to 400px x 200px over 1 second dojo.fx.sizeTo({ node:'myNode', duration: 1000, width: 400, height: 200, method: "combine" }).play(); Returns an animation to slide a node by a defined offset. // slide domNode 50px down, and 22px left dojox.fx.slideBy({ node: domNode, duration:400, top: 50, left: -22 }).play(); Returns an animation cross fading two element simultaneously args.nodes Array - two element array of domNodes, or id's all other standard animation args mixins apply. args.node ignored. Highlight a node dojox.fx.highlight({ node:"foo" }).play(); Animate a node wiping to a specific width or height Animate a node flipping following a specific direction var anim = dojox.fx.flip({ node: dojo.byId("nodeId"), dir: "top", darkColor: "#555555", lightColor: "#dddddd", endColor: "#666666", duration:300 }); An extension to `dojox.fx.flip` providing a more 3d-like rotation See `dojox.fx.flip` Returns an animation that will smooth-scroll to a node (specified in etup()) Split a node into rectangular pieces and animate them. args.crop Boolean - If true, pieces will only be visible inside node's boundries args.rows: Integer - The number of horizontal pieces (default is 3) args.columns: Integer - The number of vertical pieces (default is 3) args.pieceAnimation: Function(piece, x, y, coords) - Returns either the dojo._Animation or an array of dojo._Animation objects for the piece at location (x, y) in the node's grid; coords is the result of dojo.coords(args.node, true); Explode a node into rectangular pieces args.rows Integer - The number of horizontal pieces (default is 3) args.columns: Integer - The number of vertical pieces (default is 3) args.random: Float - If set, pieces fly to random distances, for random durations, and in slightly random directions. The value defines how much randomness is introduced. args.distance: Float - Multiplier for the distance the pieces fly (even when random) args.fade: Boolean - If true, pieces fade out while in motion (default is true) args.fadeEasing: Function - If args.fade is true, the fade animations use this easing function args.unhide: Boolean - If true, the animation is reversed args.sync: Boolean - If args.unhide is true, all the pieces converge at the same time (default is true) Split a node into rectangular pieces and let them fall args.rows Integer - The number of horizontal pieces (default is 5) args.columns: Integer - The number of vertical pieces (default is 5) args.interval: Float - The number of milliseconds between each piece's animation args.distance: Float - The number of the node's heights to drop (default is 1.5) args.fade: Boolean - If true, pieces fade out while in motion (default is true) args.random: Float - If set, pieces fall in random order. The value defines how much randomness is introduced. args.reverseOrder: Boolean - If true, pieces animate in reversed order args.unhide: Boolean - If true, the peices fall from above and land in place Split a node into rectangular pieces and slide them in alternating directions args.rows Integer - The number of horizontal pieces (default is 6) args.columns: Integer - The number of vertical pieces (default is 6) args.interval: Float - The number of milliseconds between each piece's animation (default is 0) args.distance: Float - The multiple of the node's dimensions to slide (default is 1) args.fade: Boolean - If true, pieces fade out while in motion (default is true) args.random: Float - If true, pieces have a random delay. The value defines how much randomness is introduced args.reverseOrder: Boolean - If true, pieces animate in reversed order args.unhide: Boolean - If true, the animation is reversed Split a node into rectangular pieces and wipe them in alternating directions args.rows Integer - The number of horizontal pieces (default is 4) args.columns: Integer - The number of vertical pieces (default is 4) args.interval: Float - The number of milliseconds between each piece's animation (default is 0) args.distance: Float - The percentage of the piece's dimensions the piece should wipe args.fade: Boolean - If true, pieces fade out while in motion (default is true) args.random: Float - If true, pieces have a random delay. The value defines how much randomness is introduced. args.unhide: Boolean - If true, the animation is reversed Split a node into rectangular pieces and fade them args.rows Integer - The number of horizontal pieces (default is 5) args.columns: Integer - The number of vertical pieces (default is 5) args.interval: Float - The number of milliseconds between each piece's animation (default is 0) args.random: Float - If true, pieces have a random delay. The value defines how much randomness is introduced args.reverseOrder: Boolean - If true, pieces animate in reversed order args.unhide: Boolean - If true, the animation is reversed Adds a drop-shadow to a node. // add drop shadows to all nodes with class="hasShadow" dojo.query(".hasShadow").forEach(function(n){ var foo = new dojox.fx.Shadow({ node: n }); foo.startup(); }); Base location for drop-shadow images How wide (in px) to make the shadow How deep to make the shadow appear to be Overall opacity of the shadow A toggle to disable animated transitions Initializes the shadow. append a shadow pieces to the node, and position it set the opacity of the underlay note: does not work in IE? FIXME. enable / disable the shadow Resizes the shadow based on width and height. The node and CSS class to use for style manipulations. The node to manipulate The class to use during the manipulation The odd way to document object parameters. the width to set the height to set a custom _Line to accomodate multi-dimensional values see dojox.fx.smoothScroll An Integer (or an Array of integers) to use as a starting point An Integer (or an Array of integers) to use as an ending point Returns the point on the line, or an array of points Mixed a floating point number greater than 0 and less than 1 Split a block of text into words or letters args.crop Boolean - If true, pieces will be positioned relatively rather than absolutely args.text: String - Text to place inside the node (otherwise node.innerHTML is used) args.words: Boolean - If true, the text will be split into words rather than characters args.pieceAnimation: Function(piece, pieceCoords, nodeCoords, number, numPieces) - Returns either the dojo._Animation or an array of dojo._Animation objects for the piece; pieceCoords is the result of dojo.coords(piece, true); nodeCoords is the result of dojo.coords(args.node, true); number is the piece's position in the array of pieces, and numPieces is the array.length Explode a block of text into words or letters args.crop Boolean - If true, pieces will be positioned relatively rather than absolutely args.words: Boolean - If true, text will be split into words rather than characters args.random: Float - If set, pieces fly to random distances, for random durations, and in slightly random directions. The value defines how much randomness is introduced. args.distance: Float - Multiplier for the distance the pieces fly (even when random) args.fade: Boolean - If true, pieces fade out while in motion (default is true) args.fadeEasing: Function - If args.fade is true, the fade animations use this easing function args.unhide: Boolean - If true, the animation is reversed args.sync: Boolean - If args.unhide is true, all the pieces converge at the same time (default is true) Split a block of text into words or letters and let them fall args.crop Boolean - If true, pieces will be positioned relatively rather than absolutely args.words: Boolean - If true, text will be split into words rather than characters args.interval: Float - The number of milliseconds between each piece's animation args.distance: Float - The number of the node's heights to drop (default is 1.5) args.fade: Boolean - If true, pieces fade out while in motion (default is true) args.random: Float - If set, pieces fall in random order. The value defines how much randomness is introduced args.reverseOrder: Boolean - If true, pieces animate in reversed order args.unhide: Boolean - If true, the peices fall from above and land in place Split a block of text into words or letters and fade them args.words Boolean - If true, text will be split into words rather than characters args.interval: Float - The number of milliseconds between each piece's animation (default is 0) args.random: Float - If true, pieces have a random delay. The value defines how much randomness is introduced args.reverseOrder: Boolean - If true, pieces animate in reversed order args.unhide: Boolean - If true, the animation is reversed Split a block of text into words or letters and backspace them in sequence args.interval Float - The number of milliseconds between each piece's animation (default is determined by text length and args.duration); args.wordDelay: Integer - The number of milliseconds between each word (only effective when args.unhide = true) args.fixed: Boolean - If true, only style.opacity changes; otherwise, style.display changes between none and inline, adding realism (default = false) args.random: Float - If true, pieces have a random delay. The value defines how much randomness is introduced (only effective when args.unhide = true) args.unhide: Boolean - If true, the animation is reversed Cross-browser vector graphics API converts any legal color representation to normalized dojo.Color object updates an existing object with properties from an &quot;update&quot; object the &quot;target&quot; object to be updated the &quot;update&quot; object, whose properties will be used to update the existed object copies the original object, and all copied properties from the &quot;update&quot; object the object to be cloned before updating the object, which properties are to be cloned during updating converts a number to a string using a fixed notation number to be converted if it is true, add a space before a positive number converts a font object to a CSS font string font object (see dojox.gfx.defaultFont) converts a CSS font string to a font object a CSS font string returns a number of pixels per point converts points to pixels a value in points converts pixels to points a value in pixels converts any length value to pixels a length, e.g., &quot;12pc&quot; compares event sources, returns true if they are equal creates a shape from a Node an VML node decompose a 2D matrix into translation, scaling, and rotation components a 2D matrix-like object creates a surface (VML) a parent node width of surface, e.g., &quot;100px&quot; height of surface, e.g., &quot;100px&quot; creates a surface from a Node an VML node an object, which makes a shape moveable a shape object to be moved delay move by this number of pixels a constructor of custom Mover stops watching for possible move, deletes all references, so the object can be garbage-collected event processor for onmousedown, creates a Mover for the shape mouse event event processor for onmousemove, used only for delayed drags mouse event event processor for onmouseup, used only for delayed delayed drags mouse event called before every move operation called after every move operation called during the very first move notification, can be used to initialize coordinates, can be overwritten. called during every move notification, should actually move the node, can be overwritten. called before every incremental move, can be overwritten. called after every incremental move, can be overwritten. an object, which makes a shape follow the mouse, used as a default mover, and as a base class for custom movers a shape object to be moved object which implements the functionality of the move, and defines proper events (onMoveStart and onMoveStop) event processor for onmousemove mouse event it is meant to be called only once stops the move, deletes all references, so the object can be garbage-collected Create this font object based on the SVG Font definition at url. Take the loaded SVG Font definition file and convert the info into things we can use. The SVG Font definition must follow the SVG 1.1 Font specification. Clean off all of the given mixin parameters. Load the passed SVG and send it to the parser for parsing. Return if we've loaded a font def, and the parsing was successful. split passed chars into nLines by finding the closest whitespace. Find the scaling factor for the given phrase set. Get the best number of lines to return given w and h. Based on the given scale, do the best line splitting possible. Get the width of the rendered text without actually rendering it. return the height of a single line, sans leading, based on scale. return the y coordinate that is the center of the viewbox. Find the baseline coord for alignment; adjust for scale if passed. based on the passed parameters, draw the given text using paths defined by this font. converts any legal color representation to normalized dojo.Color object updates an existing object with properties from an &quot;update&quot; object the &quot;target&quot; object to be updated the &quot;update&quot; object, whose properties will be used to update the existed object copies the original object, and all copied properties from the &quot;update&quot; object the object to be cloned before updating the object, which properties are to be cloned during updating converts a number to a string using a fixed notation number to be converted if it is true, add a space before a positive number converts a font object to a CSS font string font object (see dojox.gfx.defaultFont) converts a CSS font string to a font object a CSS font string returns a number of pixels per point converts points to pixels a value in points converts pixels to points a value in pixels converts any length value to pixels a length, e.g., &quot;12pc&quot; compares event sources, returns true if they are equal converts any legal color representation to normalized dojo.Color object updates an existing object with properties from an &quot;update&quot; object the &quot;target&quot; object to be updated the &quot;update&quot; object, whose properties will be used to update the existed object copies the original object, and all copied properties from the &quot;update&quot; object the object to be cloned before updating the object, which properties are to be cloned during updating converts a number to a string using a fixed notation number to be converted if it is true, add a space before a positive number converts a font object to a CSS font string font object (see dojox.gfx.defaultFont) converts a CSS font string to a font object a CSS font string returns a number of pixels per point converts points to pixels a value in points converts pixels to points a value in pixels converts any length value to pixels a length, e.g., &quot;12pc&quot; compares event sources, returns true if they are equal converts any legal color representation to normalized dojo.Color object updates an existing object with properties from an &quot;update&quot; object the &quot;target&quot; object to be updated the &quot;update&quot; object, whose properties will be used to update the existed object copies the original object, and all copied properties from the &quot;update&quot; object the object to be cloned before updating the object, which properties are to be cloned during updating converts a number to a string using a fixed notation number to be converted if it is true, add a space before a positive number converts a font object to a CSS font string font object (see dojox.gfx.defaultFont) converts a CSS font string to a font object a CSS font string returns a number of pixels per point converts points to pixels a value in points converts pixels to points a value in pixels converts any length value to pixels a length, e.g., &quot;12pc&quot; compares event sources, returns true if they are equal calculates an arc as a series of Bezier curves given the last point and a standard set of SVG arc parameters, it returns an array of arrays of parameters to form a series of absolute Bezier curves. a point-like object as a start of the arc a horizontal radius for the virtual ellipse a vertical radius for the virtual ellipse a rotation of an x axis of the virtual ellipse in degrees which part of the ellipse will be used (the larger arc if true) direction of the arc (CW if true) the x coordinate of the end point of the arc the y coordinate of the end point of the arc a group shape (VML), which can be used to logically group shapes (e.g, to propagate matricies) render the group sets a raw SVG node to be used by this shape an SVG node applies a transformation matrix to a group a rectangle shape (VML) sets a rectangle shape object (VML) a rectangle shape object returns the adjusted (&quot;real&quot;) transformation matrix an ellipse shape (VML) sets an ellipse shape object (VML) an ellipse shape object returns the adjusted (&quot;real&quot;) transformation matrix a circle shape (VML) sets a circle shape object (VML) a circle shape object returns the adjusted (&quot;real&quot;) transformation matrix a line shape (VML) sets a line shape object (VML) a line shape object a polyline/polygon shape (VML) sets a polyline/polygon shape object (VML) a polyline/polygon shape object if true, close the polyline explicitely an image (VML) sets an image shape object (VML) an image shape object returns the adjusted (&quot;real&quot;) transformation matrix assigns and clears the underlying node that will represent this shape. Once set, transforms, gradients, etc, can be applied. (no fill &amp; stroke by default) returns a Node, which is used as a source of events for this shape an anchored text (VML) sets a text shape object (VML) a text shape object returns the adjusted (&quot;real&quot;) transformation matrix ignore setting a stroke style assigns and clears the underlying node that will represent this shape. Once set, transforms, gradients, etc, can be applied. (no fill &amp; stroke by default) get the text width, in px sets a font object (VML) returns the cumulative (&quot;real&quot;) transformation matrix by combining the shape's matrix with its parent's matrix; it makes a correction for a font size a path shape (VML) forms a path using a shape (VML) an VML path string or a path object (see dojox.gfx.defaultPath) updates the bounding box of path with new segment a segment a textpath shape (VML) updates the bounding box of path with new segment a segment forms a path using a shape (SVG) an SVG path string or a path object (see dojox.gfx.defaultPath) sets a text shape object (VML) sets a text to be drawn along the path sets a font for text sets a font object (VML) a surface object to be used for drawings (VML) sets the width and height of the rawNode width of surface, e.g., &quot;100px&quot; height of surface, e.g., &quot;100px&quot; returns an object with properties &quot;width&quot; and &quot;height&quot; render the all shapes internal method, which is called when we may need to redraw internal method, which starts an image download and renders, when it is ready the image object the url of the image render the shape creates an instance of the passed shapeType class a class constructor to create an instance of properties to be passed in to the classes &quot;setShape&quot; method overrideSize: Boolean: set the size explicitly, if true a 2D matrix object a path constructor a DOM node to be used by this path object sets an absolute or relative mode for path points true/false or &quot;absolute&quot;/&quot;relative&quot; to specify the mode returns a current value of the absolute mode returns the bounding box {x, y, width, height} or null returns the last point in the path, or null updates the bounding box of path with new point an x coordinate a y coordinate updates the bounding box of path with new segment a segment adds a segment valid SVG code for a segment's type a list of parameters for this segment converts an array of arguments to plain numeric values an output argument (array of numbers) an input argument (can be values of Boolean, Number, dojox.gfx.Point, or an embedded array of them) formes a move segment formes a line segment formes a horizontal line segment formes a vertical line segment formes a curve segment formes a smooth curve segment formes a quadratic curve segment formes a quadratic smooth curve segment formes an elliptic arc segment closes a path forms a path using an SVG path string an SVG path string forms a path using a shape an SVG path string or a path object (see dojox.gfx.defaultPath) a TextPath shape constructor returns the current text object or null sets a text to be drawn along the path returns the current font object or null sets a font for text a Shape object, which knows how to apply graphical attributes and transformations returns the current DOM Node or null returns the current shape object or null (see dojox.gfx.defaultPath, dojox.gfx.defaultPolyline, dojox.gfx.defaultRect, dojox.gfx.defaultEllipse, dojox.gfx.defaultCircle, dojox.gfx.defaultLine, or dojox.gfx.defaultImage) returns the current transformation matrix or null returns the current fill object or null (see dojox.gfx.defaultLinearGradient, dojox.gfx.defaultRadialGradient, dojox.gfx.defaultPattern, or dojo.Color) returns the current stroke object or null (see dojox.gfx.defaultStroke) returns the parent or null (see dojox.gfx.Surface, dojox.gfx.shape.VirtualGroup, or dojox.gfx.Group) returns the bounding box or null (see dojox.gfx.defaultRect) returns an array of four points or null four points represent four corners of the untransformed bounding box returns a Node, which is used as a source of events for this shape sets a shape object (SVG) a shape object (see dojox.gfx.defaultPath, dojox.gfx.defaultPolyline, dojox.gfx.defaultRect, dojox.gfx.defaultEllipse, dojox.gfx.defaultCircle, dojox.gfx.defaultLine, or dojox.gfx.defaultImage) sets a fill object (VML) a fill object (see dojox.gfx.defaultLinearGradient, dojox.gfx.defaultRadialGradient, dojox.gfx.defaultPattern, or dojo.Color) sets a stroke object (VML) a stroke object (see dojox.gfx.defaultStroke) sets a transformation matrix a matrix or a matrix-like object (see an argument of dojox.gfx.Matrix2D constructor for a list of acceptable arguments) physically sets a matrix moves a shape to front of its parent's list of shapes moves a shape to back of its parent's list of shapes moves a shape to front of its parent's list of shapes (VML) moves a shape to back of its parent's list of shapes (VML) multiplies the existing matrix with an argument on right side (this.matrix * matrix) a matrix or a matrix-like object (see an argument of dojox.gfx.Matrix2D constructor for a list of acceptable arguments) multiplies the existing matrix with an argument on left side (matrix * this.matrix) a matrix or a matrix-like object (see an argument of dojox.gfx.Matrix2D constructor for a list of acceptable arguments) a shortcut for dojox.gfx.Shape.applyRightTransform a matrix or a matrix-like object (see an argument of dojox.gfx.Matrix2D constructor for a list of acceptable arguments) removes the shape from its parent's list of shapes if true, do not redraw a picture yet sets a parent a parent or null (see dojox.gfx.Surface, dojox.gfx.shape.VirtualGroup, or dojox.gfx.Group) a 2D matrix or a matrix-like object updates the parent matrix with new matrix a 2D matrix or a matrix-like object returns the cumulative (&quot;real&quot;) transformation matrix by combining the shape's matrix with its parent's matrix assigns and clears the underlying node that will represent this shape. Once set, transforms, gradients, etc, can be applied. (no fill &amp; stroke by default) returns the adjusted (&quot;real&quot;) transformation matrix a surface object to be used for drawings destroy all relevant external resources and release all external references to make this object garbage-collectible returns a node, which can be used to attach event listeners always returns the identity matrix local event, fired once when the surface is created asynchronously, used only when isLoaded is false, required only for Silverlight. a hypothetical 2D point to be used for drawings - {x, y} a hypothetical rectangle - {x, y, width, height} a generic rectangle a DOM Node returns the bounding box (its shape in this case) a generic ellipse a DOM Node returns the bounding box a generic circle (this is a helper object, which is defined for convenience) a DOM Node returns the bounding box a generic line (this is a helper object, which is defined for convenience) a DOM Node returns the bounding box a generic polyline/polygon (this is a helper object, which is defined for convenience) a DOM Node sets a polyline/polygon shape object a polyline/polygon shape object close the polyline to make a polygon returns the bounding box a generic image (this is a helper object, which is defined for convenience) a DOM Node returns the bounding box (its shape in this case) ignore setting a stroke style ignore setting a fill style a generic text a DOM Node returns the current font object or null sets a font for text a font object (see dojox.gfx.defaultFont) or a font string connects a handler to an event on this shape connects a handler by token from an event on this shape a container of shapes, which can be used as a foundation for renderer-specific groups, or as a way to logically group shapes (e.g, to propagate matricies) adds a shape to the list a shape removes a shape from the list if true, do not redraw a picture yet removes all shapes from a group/surface moves a shape to front of the list of shapes moves a shape to back of the list of shapes shape creators creates a shape object based on its type; it is meant to be used by group-like objects a shape descriptor object creates a VML group shape creates an SVG rectangle shape a path object (see dojox.gfx.defaultRect) creates an SVG ellipse shape an ellipse object (see dojox.gfx.defaultEllipse) creates an SVG circle shape a circle object (see dojox.gfx.defaultCircle) creates an SVG line shape a line object (see dojox.gfx.defaultLine) creates an SVG polyline/polygon shape a points object (see dojox.gfx.defaultPolyline) or an Array of points creates a VML image shape an image object (see dojox.gfx.defaultImage) creates an SVG text shape a text object (see dojox.gfx.defaultText) creates an SVG path shape a path object (see dojox.gfx.defaultPath) creates an SVG text shape a textpath object (see dojox.gfx.defaultTextPath) creates an instance of the passed shapeType class a class constructor to create an instance of properties to be passed in to the classes &quot;setShape&quot; method overrideSize: Boolean: set the size explicitly, if true converts a color object to a Silverlight hex color string (#aarrggbb) sets a font object (Silverlight) adds a shape to a group/surface a Silverlight shape object remove a shape from a group/surface a Silverlight shape object if true, regenerate a picture removes all shapes from a group/surface underlying node returns a DOM Node specified by the name argument or null an SVG external reference sets a font object (SVG) adds a shape to a group/surface an VML shape object remove a shape from a group/surface an VML shape object if true, regenerate a picture removes all shapes from a group/surface a helper function to parse VML-specific floating-point values a representation of a floating-point number adds a shape to a group/surface an VML shape object remove a shape from a group/surface an VML shape object if true, regenerate a picture removes all shapes from a group/surface A 3d API for dojox.gfx calculate a cylindrical gradient color model defines visual properties center of the cylinder's bottom radius of the cylinder from position in radians from position in radians the cumulative transformation matrix tolerance: Number: tolerable diffirence in colors between gradient steps forms a translation matrix an x coordinate value a y coordinate value a z coordinate value forms a scaling matrix a scaling factor used for the x coordinate a scaling factor used for the y coordinate a scaling factor used for the z coordinate forms a rotating matrix (about the x axis) an angle of rotation in radians (&gt;0 for CW) forms a rotating matrix (about the x axis) an angle of rotation in degrees (&gt;0 for CW) forms a rotating matrix (about the y axis) an angle of rotation in radians (&gt;0 for CW) forms a rotating matrix (about the y axis) an angle of rotation in degrees (&gt;0 for CW) forms a rotating matrix (about the z axis) an angle of rotation in radians (&gt;0 for CW) forms a rotating matrix (about the z axis) an angle of rotation in degrees (&gt;0 for CW) forms a translation matrix an x coordinate value a y coordinate value a z coordinate value forms a rotating matrix (about the x axis) in cameraTransform manner an angle of rotation in radians (&gt;0 for CW) forms a rotating matrix (about the x axis)in cameraTransform manner an angle of rotation in degrees (&gt;0 for CW) forms a rotating matrix (about the y axis) in cameraTransform manner an angle of rotation in radians (&gt;0 for CW) forms a rotating matrix (about the y axis) in cameraTransform manner an angle of rotation in degrees (&gt;0 for CW) forms a rotating matrix (about the z axis) in cameraTransform manner an angle of rotation in radians (&gt;0 for CW) forms a rotating matrix (about the z axis) in cameraTransform manner an angle of rotation in degrees (&gt;0 for CW) converts an object to a matrix, if necessary an object, which is converted to a matrix, if necessary creates a copy of a 3D matrix a 3D matrix-like object to be cloned inverts a 2D matrix a 2D matrix-like object to be inverted applies a matrix to a point matrix: dojox.gfx3d.matrix.Matrix3D: a 3D matrix object to be applied an x coordinate of a point a y coordinate of a point a z coordinate of a point applies a matrix to a point a 3D matrix object to be applied Number an x coordinate of a point Number a y coordinate of a point Number a z coordinate of a point combines matrices by multiplying them sequentially in the given order a 3D matrix-like object, all subsequent arguments are matrix-like objects too applies a matrix to a point matrix: dojox.gfx3d.matrix.Matrix3D: a 3D matrix object to be applied an x coordinate of a point a y coordinate of a point a z coordinate of a point applies a matrix to a point a 3D matrix object to be applied Number an x coordinate of a point Number a y coordinate of a point Number a z coordinate of a point a 3D matrix object a Object object, which knows how to map 3D objects to 2D shapes. sets a Object object sets a transformation matrix a matrix or a matrix-like object (see an argument of dojox.gfx3d.matrix.Matrix constructor for a list of acceptable arguments) multiplies the existing matrix with an argument on right side (this.matrix * matrix) a matrix or a matrix-like object (see an argument of dojox.gfx.matrix.Matrix constructor for a list of acceptable arguments) multiplies the existing matrix with an argument on left side (matrix * this.matrix) a matrix or a matrix-like object (see an argument of dojox.gfx.matrix.Matrix constructor for a list of acceptable arguments) a shortcut for dojox.gfx.Shape.applyRightTransform a matrix or a matrix-like object (see an argument of dojox.gfx.matrix.Matrix constructor for a list of acceptable arguments) sets a fill object (the default implementation is to delegate to the underlying 2D shape). a fill object (see dojox.gfx.defaultLinearGradient, dojox.gfx.defaultRadialGradient, dojox.gfx.defaultPattern, dojo.Color or dojox.gfx.MODEL) sets a stroke object (the default implementation simply ignores it) a stroke object (see dojox.gfx.defaultStroke) a containter of other 3D objects a generic edge in 3D viewport setup the object of points || Object String optional a generic edge in 3D viewport a generic line (this is a helper object, which is defined for convenience) converts an array of arguments to plain numeric values an output argument (array of numbers) an input argument (can be values of Boolean, Number, dojox.gfx.Point, or an embedded array of them) adds a segment valid SVG code for a segment's type a list of parameters for this segment formes a move segment formes a line segment closes a path a generic triangle (this is a helper object, which is defined for convenience) setup the object of points || Object String optional a generic triangle (this is a helper object, which is defined for convenience) setup the object of points || Object String optional a generic triangle (this is a helper object, which is defined for convenience) setup the object of points || Object a generic triangle (this is a helper object, which is defined for convenience) setup the object of points || Object a viewport/container for 3D objects, which knows the camera and lightings sets a transformation matrix a matrix or a matrix-like object (see an argument of dojox.gfx.matrix.Matrix constructor for a list of acceptable arguments) multiplies the existing matrix with an argument on right side (this.matrix * matrix) a matrix or a matrix-like object (see an argument of dojox.gfx3d.matrix.Matrix constructor for a list of acceptable arguments) multiplies the existing matrix with an argument on left side (matrix * this.matrix) a matrix or a matrix-like object (see an argument of dojox.gfx3d.matrix.Matrix constructor for a list of acceptable arguments) a shortcut for dojox.gfx3d.Object.applyRightTransform a matrix or a matrix-like object (see an argument of dojox.gfx3d.matrix.Matrix constructor for a list of acceptable arguments) set the lights Array an array of light object or lights object Color an ambient object Color an specular object add new light/lights to the viewport. || light object: light object(s) iterate all children and call their render callback function. object creators creates an edge object line: Object: a edge object (see dojox.gfx3d.defaultPath) creates an edge object line: Object: a edge object (see dojox.gfx3d.defaultPath) creates an edge object line: Object: a edge object (see dojox.gfx3d.defaultPath) creates an triangle object of points || Object creates an triangle object points: Array of points || Object creates an triangle object points: Array of points || Object creates an triangle object points: Array of points || Object creates an edge object line: Object: a edge object (see dojox.gfx3d.defaultPath) creates an triangle object line: Object: a triangle object (see dojox.gfx3d.defaultPath) creates an instance of the passed shapeType class shapeType: Function: a class constructor to create an instance of rawShape: Object: properties to be passed in to the classes &quot;setShape&quot; method adds a shape to the list shape: dojox.gfx.Shape: a shape removes a shape from the list if true, do not redraw a picture yet build the binary search tree, using binary space partition algorithm. The idea is for any polygon, for example, (a, b, c), the space is divided by the plane into two space: plus and minus. for any arbitary vertex p, if(p - a) dotProduct n = 0, p is inside the plane, &gt; 0, p is in the plus space, vice versa for minus space. n is the normal vector that is perpendicular the plate, defined as: n = ( b - a) crossProduct ( c - a ) in this implementation, n is declared as normal, ,a is declared as orient. sum of the vectors center of the vectors applies a cross product of two vectorss, (x, y, z) and (u, v, w) an x coordinate of a point a y coordinate of a point a z coordinate of a point an x coordinate of a point a y coordinate of a point a z coordinate of a point applies a matrix to a point matrix: dojox.gfx3d.matrix.Matrix3D: a 3D matrix object to be applied Number an x coordinate of a point Number a y coordinate of a point Number a z coordinate of a point Number an x coordinate of a point Number a y coordinate of a point Number a z coordinate of a point applies a cross product of two vectorss, (x, y, z) and (u, v, w) an x coordinate of a point a y coordinate of a point a z coordinate of a point an x coordinate of a point a y coordinate of a point a z coordinate of a point applies a matrix to a point matrix: dojox.gfx3d.matrix.Matrix3D: a 3D matrix object to be applied Number an x coordinate of a point Number a y coordinate of a point Number a z coordinate of a point Number an x coordinate of a point Number a y coordinate of a point Number a z coordinate of a point find the normal of the implicit surface Object a point Object a point Object a point An advanced Grid widget with virtual scrolling, cell editing, and much more a null function? Perform row styling Remove the selected rows from the grid. Manages row selection for grid. Owned by grid and used internally for selection. Override to implement custom selection. Controls grid cell editing process. Owned by grid and used internally for editing. Invoke editing when cell is focused object Grid cell object Grid row index Indicates editing state of the grid. Boolean True if grid is actively editing Indicates if the given cell is being edited. Boolean True if given cell is being edited Grid row index Grid cell index Indicates if the given row is being edited. Boolean True if given row is being edited Grid row index Set the given cell to be edited Grid cell object Grid row index Apply a grid edit Cancel a grid edit Save the grid editing state Grid row index Grid view Restores the grid editing state Grid view Grid row index _Grid mixin that provides default implementations for grid events. css class to apply to grid cells over which the cursor is placed. top level handler for Key Events Top level handler for Content events Top level handler for header events Perform row styling on a given row. Called whenever row styling is updated. containing row state information: selected, true if the row is selcted; over: true of the mouse is over the row; odd: true if the row is odd. Use customClasses and customStyles to control row css classes and styles; both properties are strings. onStyleRow({ selected: true, over:true, odd:false }) Grid key event handler. By default enter begins editing and applies edits, escape cancels an edit, tab, shift-tab, and arrow keys move grid cell focus. Event fired when mouse is over the grid. Decorated event object contains reference to grid, cell, and rowIndex Event fired when mouse moves out of the grid. Decorated event object that contains reference to grid, cell, and rowIndex Event fired when mouse is down inside grid. Decorated event object that contains reference to grid, cell, and rowIndex Event fired when mouse is over any row (data or header). Decorated event object contains reference to grid, cell, and rowIndex Event fired when mouse moves out of any row (data or header). Decorated event object contains reference to grid, cell, and rowIndex Event fired when mouse is down inside grid row Decorated event object that contains reference to grid, cell, and rowIndex Event fired when mouse is over a cell. Decorated event object contains reference to grid, cell, and rowIndex Event fired when mouse moves out of a cell. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when mouse is down in a header cell. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when a cell is clicked. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when a cell is double-clicked. Decorated event object contains reference to grid, cell, and rowIndex Event fired when a cell context menu is accessed via mouse right click. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when a cell receives focus. Cell object containing properties of the grid column. Index of the grid row Event fired when a row is clicked. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when a row is double clicked. decorated event object which contains reference to grid, cell, and rowIndex Event fired when mouse moves over a data row. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when mouse moves out of a data row. Decorated event object contains reference to grid, cell, and rowIndex Event fired when mouse is down in a row. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when a row context menu is accessed via mouse right click. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when mouse moves over the grid header. Decorated event object contains reference to grid, cell, and rowIndex Event fired when mouse moves out of the grid header. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when mouse moves over a header cell. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when mouse moves out of a header cell. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when mouse is down in a header cell. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when the grid header is clicked. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when a header cell is clicked. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when the grid header is double clicked. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when a header cell is double clicked. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when a header cell context menu is accessed via mouse right click. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when the grid header context menu is accessed via mouse right click. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when editing is started for a given grid cell Cell object containing properties of the grid column. Index of the grid row Event fired when editing is applied for a given grid cell Value from cell editor Index of the grid row Index in the grid's data store Event fired when editing is cancelled for a given grid cell Index of the grid row Event fired when editing is applied for a given grid row Index of the grid row Event to determine if a grid row may be selected Boolean true if the row can be selected Index of the grid row Event to determine if a grid row may be deselected Boolean true if the row can be deselected Index of the grid row Event fired when a grid row is selected Index of the grid row Event fired when a grid row is deselected Index of the grid row Controls grid cell focus. Owned by grid and used internally for focusing. Note: grid cell actually receives keyboard input only when cell is being edited. states if the given cell is focused true of the given grid cell is focused grid cell object grid row index states whether currently navigating among column headers. true if focus is on a column header; false otherwise. if one of the column headers currently has focus, return its index. index of the focused column header, or -1 if none have focus. focuses the given grid cell grid row index grid cell index focuses the given grid cell grid cell object grid row index focus next grid cell focus previous grid cell focus grid cell or column header based on position relative to current focus vertical distance from current focus horizontal distance from current focus A grid widget with virtual scrolling, cell editing, complex rows, sorting, fixed columns, sizeable columns, etc. A quick sample: define a get function function get(inRowIndex){ // called in cell context return [this.index, inRowIndex].join(', '); } define the grid structure: var structure = [ // array of view objects { cells: [// array of rows, a row is an array of cells [ { name: "Alpha", width: 6 }, { name: "Beta" }, { name: "Gamma", get: get }] ]} ]; <div id="grid" rowCount="100" get="get" structure="structure" dojoType="dojox.grid._Grid"></div> CSS class applied to the grid's domNode Integer Number of rows to display. Number of rows to keep in the rendering cache. Number of rows to render at a time. If autoWidth is true, grid width is automatically set to fit the data. If autoHeight is true, grid height is automatically set to fit the data. If it is an integer, the height will be automatically set to fit the data if there are fewer than that many rows - and the height will be set to show that many rows if there are more If autoRender is true, grid will render itself after initialization. default height of the grid, measured in any valid css unit. explicit height of the grid, measured in any valid css unit. This will be populated (and overridden) if the height: css attribute exists on the source node. View layout defintion. Can be set to a layout object, or to the (string) name of a layout object. Override defaults and make the indexed grid view elastic, thus filling available horizontal space. Single-click starts editing. Default is double-click Set the selection mode of grid's Selection. Value must be 'single', 'multiple', or 'extended'. Default is 'extended'. If set to true, will add a row selector view to this grid. If set to a CSS width, will add a row selector of that width to this grid. If set to true, will add drag and drop reordering to views with one row of columns. If set to a dijit.Menu, will use this as a context menu for the grid headers. Label of placeholders to search for in the header menu to replace with column toggling menu items. Message that shows while the grid is loading Message that shows when the grid encounters an error loading Message that shows if the grid has no data - wrap it in a span with class 'dojoxGridNoData' if you want it to be styled similar to the loading and error messages flag modifies vertical scrolling behavior. Defaults to true but set to false for slower scroll performance but more immediate scrolling feedback pixel distance a user must scroll vertically to trigger grid scrolling. Default data getter. Data to display for a given grid cell. Row for which to provide data create grid managers for various tasks including rows, focus, selection, editing Creates a new virtual scroller Creates a new Grid layout Install a new structure and rebuild the grid. Structure object defines the grid layout and provides various options for grid views and columns Update the grid's rendering dimensions and resize it sizeBox: Object? {w: int, h: int, l: int, t: int} Render the grid, headers, and views. Edit and scrolling states are reset. To retain edit and scrolling states, see Update. private, used internally to render rows private, used internally to remove rows Use to make multiple changes to rows while queueing row updating. NOTE: not currently supporting nested begin/endUpdate calls Use after calling beginUpdate to render any changes made to rows. Update the grid, retaining edit and scrolling states. Render a single row. Index of the row to render Render consecutive rows at once. Index of the starting row to render How many rows to update. Change the number of rows. Number of rows in the grid. Update the styles for a row after it's state has changed. Update grid when the height of a row has changed. Row height is handled automatically as rows are rendered. Use this function only to update a row's height outside the normal rendering process. index of the row that has changed height Vertically scroll the grid to a given pixel position vertical position of the grid in pixels Scroll the grid to a specific row. grid row index Retrieves the cell object for a given grid column. a grid cell Grid column index of cell to retrieve Returns the cell name of a passed cell Determines if the grid can be sorted Boolean True if grid can be sorted on the given column in the given direction Sort information, 1-based index of column on which to sort, positive for an ascending sort and negative for a descending sort Returns true if grid is sorted in an ascending direction. Returns the index of the column on which the grid is sorted Sort the grid on a column in a specified direction Column index on which to sort. If true, sort the grid in ascending order, otherwise in descending order Add a row to the grid. Remove the selected rows from the grid. Controls grid cell layout. Owned by grid and used internally. Custom grid view. If used in a grid structure, provides a small selectable region for grid rows. A collection of grid columns. A grid is comprised of a set of views that stack horizontally. Grid creates views automatically based on grid's layout structure. Users should typically not need to access individual views directly. Default width of the view Width for the view, in valid css unit Width of the column being toggled (-1 for none) A collection of grid views. Owned by grid and used internally for managing grid views. Returns the first grid view with a scroll bar Respresents a grid cell and contains information about column options and methods for retrieving cell related information. Each column in a grid layout has a cell object and most events and many methods provide access to these objects. provides the html for a given grid cell. html for a given grid cell grid row index formats the cell for editing string of html to place in grid cell cell data to edit grid row index gets the dom node for a given grid cell. dom node for a given grid cell grid row index format the editing dom node. Use when editor is a widget. node dom node for the editor cell data to edit grid row index returns value entered into editor value of editor grid row index set the value of the grid editor grid row index value of editor focus the grid editor grid row index node editor node save editor state grid row index restore editor state grid row index called when editing is completed to clean up editor grid row index apply edit from cell editor grid row index cancel cell edit grid row index optional regex for disallowing keypresses grid cell that provides a standard select for editing value for each item editor returns only the index of the selected option and not the value grid cell that is always in an editable state, regardless of grid editing state grid cell that provides a standard checkbox that is always on for editing A grid widget with virtual scrolling, cell editing, complex rows, sorting, fixed columns, sizeable columns, etc. define the grid structure: var structure = [ // array of view objects { cells: [// array of rows, a row is an array of cells [ { name: "Alpha", width: 6 }, { name: "Beta" }, { name: "Gamma", get: formatFunction } ] ]} ]; define a grid data model var model = new dojox.grid.data.table(null, data); <div id="grid" model="model" structure="structure" dojoType="dojox.VirtualGrid"></div> Set the grid's data model Model object, usually an instance of a dojox.grid.data.Model subclass data socket (called in cell's context) Re-render the grid, getting new data from the model Retrieves the model field on which to sort data. 1-based grid column index; positive if sort is ascending, otherwise negative Determines if a given cell may be edited Boolean True if given cell may be edited A grid cell Grid row index Perform row styling A grid widget with virtual scrolling, cell editing, complex rows, sorting, fixed columns, sizeable columns, etc. A quick sample: define a get function function get(inRowIndex){ // called in cell context return [this.index, inRowIndex].join(', '); } define the grid structure: var structure = [ // array of view objects { cells: [// array of rows, a row is an array of cells [ { name: "Alpha", width: 6 }, { name: "Beta" }, { name: "Gamma", get: get }] ]} ]; <div id="grid" rowCount="100" get="get" structure="structure" dojoType="dojox.VirtualGrid"></div> CSS class applied to the grid's domNode Integer Number of rows to display. Number of rows to keep in the rendering cache. Number of rows to render at a time. If autoWidth is true, grid width is automatically set to fit the data. If autoHeight is true, grid height is automatically set to fit the data. If autoRender is true, grid will render itself after initialization. default height of the grid, measured in any valid css unit. View layout defintion. Can be set to a layout object, or to the (string) name of a layout object. Override defaults and make the indexed grid view elastic, thus filling available horizontal space. Single-click starts editing. Default is double-click flag modifies vertical scrolling behavior. Defaults to true but set to false for slower scroll performance but more immediate scrolling feedback pixel distance a user must scroll vertically to trigger grid scrolling. Default data getter. Data to display for a given grid cell. Row for which to provide data create grid managers for various tasks including rows, focus, selection, editing row manager Creates a new virtual scroller Creates a new Grid layout Install a new structure and rebuild the grid. Structure object defines the grid layout and provides various options for grid views and columns Update the grid's rendering dimensions and resize it {w: int, h: int, l: int, t: int} FIXME: If grid is not sized explicitly, sometimes bogus scrollbars can appear in our container, which may require an extra call to 'resize' to sort out. Render the grid, headers, and views. Edit and scrolling states are reset. To retain edit and scrolling states, see Update. private, used internally to render rows private, used internally to remove rows Use to make multiple changes to rows while queueing row updating. Use after calling beginUpdate to render any changes made to rows. Update the grid, retaining edit and scrolling states. Render a single row. Index of the row to render Change the number of rows. Number of rows in the grid. Update the styles for a row after it's state has changed. Update grid when the height of a row has changed. Row height is handled automatically as rows are rendered. Use this function only to update a row's height outside the normal rendering process. index of the row that has changed height Vertically scroll the grid to a given pixel position vertical position of the grid in pixels Scroll the grid to a specific row. grid row index Retrieves the cell object for a given grid column. a grid cell Grid column index of cell to retrieve Returns the cell name of a passed cell Determines if the grid can be sorted Boolean True if grid can be sorted on the given column in the given direction Sort information, 1-based index of column on which to sort, positive for an ascending sort and negative for a descending sort Returns true if grid is sorted in an ascending direction. Returns the index of the column on which the grid is sorted Sort the grid on a column in a specified direction Column index on which to sort. If true, sort the grid in ascending order, otherwise in descending order Add a row to the grid. Remove the selected rows from the grid. base grid editor class. Other grid editors should inherited from this class. formats the cell for editing string of html to place in grid cell cell data to edit grid row index format the editing dom node. Use when editor is a widget. node dom node for the editor cell data to edit grid row index returns value entered into editor value of editor grid row index set the value of the grid editor grid row index value of editor focus the grid editor grid row index node editor node save editor state grid row index restore editor state grid row index called when editing is completed to clean up editor grid row index apply edit from cell editor grid row index cancel cell edit grid row index optional regex for disallowing keypresses grid cell editor that provides a standard select options: text of each item values: value for each item returnIndex: editor returns only the index of the selected option and not the value grid cell editor that is always on, regardless of grid editing state flag to use editor to format grid cell regardless of editing state. grid cell editor that provides a standard checkbox that is always on basic collection class that provides a default value for items Base abstract grid data model. Makes no assumptions about the structure of grid data. Basic grid data model for static data in the form of an array of rows that are arrays of cell data Grid data model for dynamic data such as data retrieved from a server. Retrieves data automatically when requested and provides notification when data is received stub. Fill in to perform actual data row fetching logic. The returning logic must provide the data back to the system via setRow A grid data model for dynamic data retreived from a store which implements the dojo.data API set. Retrieves data automatically when requested and provides notification when data is received Function determine the row index for a particular item store item to examine to determine row index. flag to indicate if the item passed is a store item or not. Function to remove a set of items from the store based on the row index. array of row indexes from the grid to remove from the store. Call delete on the store Function to remove a set of items from the store based on the row index. An array of row indexes from the grid to remove from the store. Function to cause the model to re-query the store and rebuild the current viewport. Hook function to trap error messages from the store and emit them. Intended for connecting to and handling the error object or at least reporting it. error object returned by the store when a problem occurred. request object that caused the error. Base class to produce html for grid content. Also provide event decoration, providing grid related information inside the event object passed to grid events. Produces html for grid data content. Owned by grid and used internally for rendering data. Override to implement custom rendering. Produces html for grid header content. Owned by grid and used internally for rendering data. Override to implement custom rendering. Maps an html table into a structure parsable for information about cell row and col spanning. Used by headerBuilder Map table topography Find node's map coords by it's structure coords Find a node in inNode's table with the given structure coords Respresents a grid cell and contains information about column options and methods for retrieving cell related information. Each column in a grid layout has a cell object and most events and many methods provide access to these objects. provides the html for a given grid cell. html for a given grid cell grid row index gets the dom node for a given grid cell. dom node for a given grid cell grid row index Controls grid cell editing process. Owned by grid and used internally for editing. Invoke editing when cell is focused object Grid cell object Grid row index Indicates editing state of the grid. Boolean True if grid is actively editing Indicates if the given cell is being edited. Boolean True if given cell is being edited Grid row index Grid cell index Indicates if the given row is being edited. Boolean True if given row is being edited Grid row index Set the given cell to be edited Grid cell object Grid row index Apply a grid edit Cancel a grid edit Save the grid editing state Grid row index Grid view Restores the grid editing state Grid view Grid row index Controls grid cell focus. Owned by grid and used internally for focusing. Note: grid cell actually receives keyboard input only when cell is being edited. states if the given cell is focused true of the given grid cell is focused grid cell object grid row index focuses the given grid cell grid row index grid cell index focuses the given grid cell grid cell object grid row index focus next grid cell focus previous grid cell focus grid cell based on position relative to current focus vertical distance from current focus horizontal distance from current focus Controls grid cell layout. Owned by grid and used internally. VirtualGrid mixin that provides default implementations for grid events. css class to apply to grid cells over which the cursor is placed. top level handler for Key Events Top level handler for Content events Top level handler for header events Perform row styling on a given row. Called whenever row styling is updated. containing row state information: selected, true if the row is selcted; over: true of the mouse is over the row; odd: true if the row is odd. Use customClasses and customStyles to control row css classes and styles; both properties are strings. onStyleRow({ selected: true, over:true, odd:false }) Grid key event handler. By default enter begins editing and applies edits, escape cancels and edit, tab, shift-tab, and arrow keys move grid cell focus. Event fired when mouse is over the grid. Decorated event object contains reference to grid, cell, and rowIndex Event fired when mouse moves out of the grid. Decorated event object that contains reference to grid, cell, and rowIndex Event fired when mouse is down inside grid. Decorated event object that contains reference to grid, cell, and rowIndex Event fired when mouse is over any row (data or header). Decorated event object contains reference to grid, cell, and rowIndex Event fired when mouse moves out of any row (data or header). Decorated event object contains reference to grid, cell, and rowIndex Event fired when mouse is down inside grid row Decorated event object that contains reference to grid, cell, and rowIndex Event fired when mouse is over a cell. Decorated event object contains reference to grid, cell, and rowIndex Event fired when mouse moves out of a cell. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when mouse is down in a header cell. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when a cell is clicked. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when a cell is double-clicked. Decorated event object contains reference to grid, cell, and rowIndex Event fired when a cell context menu is accessed via mouse right click. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when a cell receives focus. Cell object containing properties of the grid column. Index of the grid row Event fired when a row is clicked. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when a row is double clicked. decorated event object which contains reference to grid, cell, and rowIndex Event fired when mouse moves over a data row. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when mouse moves out of a data row. Decorated event object contains reference to grid, cell, and rowIndex Event fired when mouse is down in a row. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when a row context menu is accessed via mouse right click. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when mouse moves over the grid header. Decorated event object contains reference to grid, cell, and rowIndex Event fired when mouse moves out of the grid header. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when mouse moves over a header cell. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when mouse moves out of a header cell. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when mouse is down in a header cell. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when the grid header is clicked. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when a header cell is clicked. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when the grid header is double clicked. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when a header cell is double clicked. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when a header cell context menu is accessed via mouse right click. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when the grid header context menu is accessed via mouse right click. Decorated event object which contains reference to grid, cell, and rowIndex Event fired when editing is started for a given grid cell Cell object containing properties of the grid column. Index of the grid row Event fired when editing is applied for a given grid cell Value from cell editor Index of the grid row Index in the grid's data model Event fired when editing is cancelled for a given grid cell Index of the grid row Event fired when editing is applied for a given grid row Index of the grid row Event to determine if a grid row may be selected Boolean true if the row can be selected Index of the grid row Event to determine if a grid row may be deselected Boolean true if the row can be deselected Index of the grid row Event fired when a grid row is selected Index of the grid row Event fired when a grid row is deselected Index of the grid row Custom grid view. If used in a grid structure, provides a small selectable region for grid rows. summmary: retrieves the default row height int, default row height virtual scroller class, makes no assumption about shape of items being scrolled virtual scrollbox, abstract class Content must in /rows/ Rows are managed in contiguous sets called /pages/ There are a fixed # of rows per page The minimum rendered unit is a page Virtual scroller class that scrolls list of columns. Owned by grid and used internally for virtual scrolling. Manages row selection for grid. Owned by grid and used internally for selection. Override to implement custom selection. A collection of grid columns. A grid is comprised of a set of views that stack horizontally. Grid creates views automatically based on grid's layout structure. Users should typically not need to access individual views directly. Default widget of the view Width for the view, in valid css unit A collection of grid views. Owned by grid and used internally for managing grid views. Returns the first grid view with a scroll bar Adds the help function to all variables. Search for dojo functionality that has something to do with the given string. The namespaces to search in. Defaults to dojox.help._namespaces The maximum number of results. Useful if you reset some values, and want to restore their help function The string-representation of a namespace. Whether to recurse through the namespace. Use this function when you want to resolve the problems created by including a dojox.help package. If you pass an item, only that item will be cleaned Should be called by one of the implementations. Runs startup code Any namespaces to add to the default (dojox.help._namespaces) Whether to start in noConflict mode Stub function to be overridden in one of the dojox.help packages Stub function to be overridden in one of the dojox.help packages A client-side syntax highlighting engine. adjusts relative paths in cssText to be relative to cssUrl a path is considered relative if it doesn't start with '/' and not contains ':' TODO: add all the other options inserts (replaces) the given content into the given node the parent element that will receive the content the content to be set on the parent element. This can be an html string, a node reference or a NodeList, dojo.NodeList, Array or other enumerable list of nodes Optional flags/properties to configure the content-setting. See dojo.html._ContentSetter A safe string/node/nodelist content replacement/injection with hooks for extension Example Usage: dojo.html.set(node, "some string"); dojo.html.set(node, contentNode, {options}); dojo.html.set(node, myNode.childNodes, {options}); Creates a style and attaches it to a dynamically created stylesheet arguments: A fully qualified class name, as it would appear in a CSS dojo.doc. Start classes with periods, target nodes with '#'. Large selectors can also be created like: &quot;#myDiv.myClass span input&quot; single string that would make up a style block, not including the curly braces. Include semi-colons between statements. Do not use JavaScript style declarations in camel case, use as you would in a CSS dojo.doc: &quot;color:#ffoooo;font-size:12px;margin-left:5px;&quot; ) Name of the dynamic style sheet this rule should be inserted into. If is not found by that name, it is created. If no name is passed, the name &quot;default&quot; is used. summary Searches HTML for style sheets that are "toggle-able" - can be enabled and disabled. These would include sheets with the title attribute, as well as the REL attribute. An array of all toggle-able style sheets TODO: Sets of style sheets could be grouped according to an ID and used in sets, much like different groups of radio buttons. It would not however be according to W3C spec summary Collects all the style sheets referenced in the HTML page, including any incuded via @import. An hash map of all the style sheets. TODO: Does not recursively search for @imports, so it will only go one level deep. Adjust relative paths in html string content to point to this page Only useful if you grab content from a another folder than the current one A collection of image related widgets A simple grid of Images that loops through thumbnails A CSS3 Selector that determines the node to become a child Number of Rows to display Number of Columns to display Size in PX of each thumbnail Time (in ms) to show the image before sizing down again how many cycles will be going &quot;simultaneously&quot; (&gt;2 not reccommended) An easing function to use when showing the node (does not apply to shrinking) Setup and layout the images Return information about the position for a given node Returns the next image in the list, or the first one if not available Show the passed node in the picker figure out which three images are being covered, and determine if they need loaded or not Hide the passed node (info.n), passing along properties received. Select an un-viewed image from the list, and show it If you know your Flickr userid, you can set it to prevent a call to fetch the id Your Flickr username The id of the set to display A comma separated list of tags or an array of tags to grab from Flickr Free text search. Photos who's title, description, or tags contain the text will be displayed Where to display the pictures when clicked on. Valid values are the same as the target attribute of the A tag. Gallery widget that wraps a dojox.image.ThumbnailPicker and dojox.image.SlideShow widget Maximum height of an image in the SlideShow widget Maximum width of an image in the SlideShow widget The number of records to retrieve from the data store per request. If true, images are loaded before the user views them. If false, an image is loaded when the user displays it. Defines the name of the attribute to request from the store to retrieve the URL to link to from an image, if any. Defines the name of the attribute to request from the store to retrieve the URL to the thumbnail image. Defines the name of the attribute to request from the store to retrieve the URL to the image. Defines the name of the attribute to request from the store to retrieve the title of the picture, if any. time in seconds, between image changes in the slide show. Initializes the widget, creates the ThumbnailPicker and SlideShow widgets Sets the data store and request objects to read data from. implementation of the dojo.data.api.Read API. This accesses the image data. implementation of the dojo.data.api.Request API. This specifies the query and paging information to be used by the data store An object defining the names of the item attributes to fetch from the data store. The four attributes allowed are 'linkAttr', 'imageLargeAttr', 'imageThumbAttr' and 'titleAttr' Resets the widget to its initial state Changes the image being displayed in the SlideShow to the next image in the data store If true, a slideshow is active, otherwise the slideshow is inactive. Switches the slideshow mode on and off. Shows the image at index 'idx'. idx: Number The position of the image in the data store to display Function Optional callback function to call when the image has finished displaying. Ensures that the ThumbnailPicker and the SlideShow widgets are centered. A dojo-based Lightbox implementation. <a href="image1.jpg" dojoType="dojox.image.Lightbox">show lightbox</a> Grouping images in a page with similar tags will provide a 'slideshow' like grouping of images A string of text to be shown in the Lightbox beneath the image (empty if using a store) Generic time in MS to adjust the feel of widget. could possibly add various durations for the various actions (dialog fadein, sizeing, img fadein ...) Privately set this to disable/enable natural link of anchor tags Add this instance to the master LightBoxDialog Handle the click on the link Show the Lightbox with this instance as the starting point Disables event clobbering and dialog, and follows natural link Enables the dialog (prevents default link) The &quot;dialog&quot; shared between any Lightbox instances on the page, publically available for programatic manipulation. // show a single image from a url var url = "http://dojotoolkit.org/logo.png"; var dialog = new dojox.image.LightboxDialog().startup(); dialog.show({ href: url, title:"My Remote Image"}); The current title, read from object passed to show() The src=&quot;&quot; attribute of our imageNode (can be null at statup) The text to display when an unreachable image is linked If true, ensure the image always stays within the viewport more difficult than necessary to disable, but enabled by default seems sane in most use cases. Path to the image used when a 404 is encountered Add some extra event handlers, and startup our superclass. Show the Master Dialog. Starts the chain of events to show an image in the dialog, including showing the dialog if it is not already visible needs href and title attributes. the values for this image. Load next image in group Load previous image in group Do the prep work before we can show another image A localized hook to accompany _loadImage Resize our dialog container, and fire _showImage 22 == current styled margins or paddings, can calculate programatically if needed Fade in the image, and fire showNav Fade in the footer, and setup our connections. Hide the Master Lightbox Add an image to this Master Lightbox The image information to add. href: String - link to image (required) title: String - title to display attach to group of similar tag or null for individual image instance Handle keyboard navigation internally resize an image to fit within the bounds of the viewport The 'size' object passed around for this image we want to know the viewport size any time it changes make and cleanup animation and animation connections Adds magnification on a portion of an image element, using dojox.gfx create the glassNode, and an img on a dojox.gfx surface position the overlay centered under the cursor set the image's offset in the clipping window relative to the mouse position Adds magnification on a portion of an image element the width and height of the bounding box the multiplier of the Mangification. make img and glassNode elements as children of the body update the calculations should this.scale change show the overlay hide the overlay position the overlay centered under the cursor set the image's offset in the clipping window relative to the mouse position A Slideshow Widget The maximum width of an image. the initial title of the SlideShow a way to customize the wording in the title. supported parameters to be populated are: ${title} = the passed title of the image ${current} = the current index of the image ${total} = the total number of images in the SlideShow should add more? Prevents the slideshow from putting an anchor link around the displayed image enables if true, though still will not link in absence of a url to link to true/false - make the slideshow loop toggle to enable/disable the visual navigation controls Contains the DOM nodes that individual images are stored in when loaded or loading. The number of images to request each time. If true, then images are preloaded, before the user navigates to view them. If false, an image is not loaded until the user views it. If true, the SlideShow begins playing immediately If true, the widget does not resize itself to fix the displayed image. Implementation of the dojo.data.api.Read API, which provides data on the images to be displayed. Defines the name of the attribute to request from the store to retrieve the URL to link to from an image, if any. Defines the name of the attribute to request from the store to retrieve the URL to the image. Defines the name of the attribute to request from the store to retrieve the title of the picture, if any. Time, in seconds, between image transitions during a slideshow. A counter to keep track of which index image is to be loaded next The temporary image to show when a picture is loading. Initilizes the widget, sets up listeners and shows the first image Sets the data store and request objects to read data from. implementation of the dojo.data.api.Read API. This accesses the image data. implementation of the dojo.data.api.Request API. This specifies the query and paging information to be used by the data store An object defining the names of the item attributes to fetch from the data store. The three attributes allowed are 'linkAttr', 'imageLargeAttr' and 'titleAttr' Resets the widget to its initial state Returns true if image at the specified index is loaded, false otherwise. number index in the data store to check if it is loaded. If 'autoload' is true, this tells the widget to start loading images from the specified pointer. number index in the data store to start loading images from. Cleans up the widget when it is being destroyed Changes the image being displayed to the next image in the data store If true, a slideshow is active, otherwise the slideshow is inactive. Switches the slideshow mode on and off. Returns the topic id published to when an image is shown Returns the topic id published to when an image finishes loading. Shows the image at index 'index'. The position of the image in the data store to display Optional callback function to call when the image has finished displaying. Fits the widget size to the size of the image being shown, or centers the image, depending on the value of 'fixedHeight' If true, the widget is always resized, regardless of the value of 'fixedHeight' Returns the padding to place at the top of the image to center it vertically. Load the next unloaded image. Stops a running slide show. Show the previous image. FIXME: either pull code from showNext/prev, or call it here Show the next image Starts a timeout to show the next image when a slide show is active Calculates the dimensions of the navigation controls Sets the title to the image being displayed The String title of the image Ensures that the image width and height do not exceed the maximum. The image DOM node to optionally resize Performs navigation on the images based on users mouse clicks An Event object Shows the navigation controls If true, the navigation controls are repositioned even if they are currently visible. Hides the navigation controls The DOM Event that triggered this function Returns whether the mouse is over the passed element. Element must be display:block (ie, not a &lt;span&gt;) When the page is unloading, if this method runs it will throw an exception. Load image at specified index Implementation of the dojo.data.api.Request API, which defines the query parameters for accessing the store. A scrolling Thumbnail Picker widget A data store that implements the dojo.data Read API. Width or height in pixels, depending if horizontal or vertical. Default height of a thumbnail image Default width of an image Setting useLoadNotifier to true makes a colored DIV appear under each thumbnail image, which is used to display the loading status of each image in the data store. Setting useHyperlink to true causes a click on a thumbnail to open a link. If hyperlinkTarget is set to &quot;new&quot;, clicking on a thumb will open a new window If it is set to anything else, clicking a thumbnail will open the url in the current window. When set to true, the cursor over a thumbnail changes. When true, uses smoothScroll to move between pages If true, the thumbnails are displayed horizontally. Otherwise they are displayed vertically The attribute name for accessing the url from the data store The attribute name for accessing the thumbnail image url from the data store The attribute name for accessing the large image url from the data store The number of images to request each time. The attribute name for accessing the title from the data store The index of the first thumbnail shown The total number of photos in the image store Stores the indices of images that have been marked as loaded using the markImageLoaded function. Initializes styles and listeners Creates DOM nodes for thumbnail images and initializes their listeners Returns the name of the dojo topic that can be subscribed to in order to receive notifications on which thumbnail was selected. Returns the name of the dojo topic that can be subscribed to in order to receive notifications on which thumbnail is now visible Sets the data store and request objects to read data from. implementation of the dojo.data.api.Read API. This accesses the image data. implementation of the dojo.data.api.Request API. This specifies the query and paging information to be used by the data store An object defining the names of the item attributes to fetch from the data store. The four attributes allowed are 'linkAttr', 'imageLargeAttr', 'imageThumbAttr' and 'titleAttr' Resets the widget back to its original state. Returns true if the image at the specified index is currently visible. False otherwise. Displays the next page of images Displays the next page of images Displays thumbnail images, starting at position 'index' The index of the first thumbnail Changes a visual cue to show the image is loaded Adds a CSS class to a thumbnail, only if 'autoLoad' is true The thumbnail DOM node to set the class on The CSS class to add to the DOM node. Loads the next page of thumbnail images Updates the navigation controls to hide/show them when at the first or last images. A dojo.data Read API Request object. Extensions to the Core dojo.io transports Parses an HTTP stream for a message. HTTP stream to parse Extra header information to add to each HTTP request (kind of HTTP inheritance) A true value indicates that the stream may not be finished, it may end arbitrarily in mid stream. The last XHR object will have a special property _lastIndex that indicates the how far along the httpStream could be successfully parsed into HTTP messages. return: Returns an array of XHR-like object for reading the headers for each message Adds the windowName transport as an XHR plugin for the given site. See dojox.io.windowName for more information on the transport. Url prefix of the site which can handle windowName requests. This allows for adapting HTTP requests that could not otherwise be sent with XDR, so you can use a convention for headers and PUT/DELETE methods. Object that implements the iframe handling for XMLHttpRequest IFrame Proxying. starts the xdomain request using the provided facade. This method first does some init work, then delegates to _realSend. starts the actual xdomain request using the provided facade. HTML5 document messaging endpoint. Unpack the event to see if we want to use it. XMLHttpRequest facade object used by dojox.io.proxy.xip. A method that can be overridden by other modules to control when the script attachment occurs. All the properties described in the dojo.__ioArgs type, apply to this type as well, EXCEPT &quot;handleAs&quot;. It is not applicable to dojo.io.script.get() calls, since it is implied by the usage of &quot;callbackParamName&quot; (response will be a JSONP call returning JSON) or &quot;checkString&quot; (response is pure JavaScript defined in the body of the script that was attached). sends a get request using a dynamically created script tag. creates a new &lt;script&gt; tag pointing to the specified URL and adds it to the document. removes the script element with the given id, from the given frameDocument. If no frameDocument is passed, the current document is used. sets up a Deferred object for an IO request. canceller function for dojo._ioSetArgs call. okHandler function for dojo._ioSetArgs call. errHandler function for dojo._ioSetArgs call. sets up an entry in the deadScripts array. inflight check function to see if dfd is still valid. inflight check function to see if IO finished. inflight function to handle a completed response. fixes the URL so that callback used when waiting for a frame to load (related to the usage of the frameId argument to dojo.io.script.get(). Provides secure cross-domain request capability. Sends a request using an iframe (POST or GET) and reads the response through the frame's window.name. The method to use to send the request, GET or POST See dojo.xhr args.authElement: DOMNode? By providing an authElement, this indicates that windowName should use the authorized window.name protocol, relying on the loaded XD resource to return to the provided return URL on completion of authorization/authentication. The provided authElement will be used to place the iframe in, so the user can interact with the server resource for authentication and/or authorization to access the resource. args.onAuthLoad: Function? When using authorized access to resources, this function will be called when the authorization page has been loaded. (When authorization is actually completed, the deferred callback function is called with the result). The primary use for this is to make the authElement visible to the user once the resource has loaded (this can be preferable to showing the iframe while the resource is loading since it may not require authorization, it may simply return the resource). overrides the default xhr handler to implement a registry of xhr handlers adds a server side proxy xhr handler for cross-site URLs is URL to send the requests to. Define a proxy: dojox.io.xhrPlugins.addProxy("/proxy?url="); And then when you call: dojo.xhr("GET",{url:"http://othersite.com/file"}); It would result in the request (to your origin server): GET /proxy?url=http%3A%2F%2Fothersite.com%2Ffile HTTP/1.1 Adds W3C Cross site XHR or XDomainRequest handling for the given URL prefix that start with this URL will be considered for using cross-site XHR. allows for adapting HTTP requests that could not otherwise be sent with XDR, so you can use a convention for headers and PUT/DELETE methods. Provides a HTTP adaption. dojox.io.xhrPlugins.addXdr("http://somesite.com", dojox.io.xhrPlugins.fullHttpAdapter); Performs a JSONQuery on the provided object and returns the results. If no object is provided (just a query), it returns a &quot;compiled&quot; function that evaluates objects according to the provided query. Query string Target of the JSONQuery dojox.json.query("foo",{foo:"bar"}) This will return "bar". To use the validator call this with an instance object and an optional schema object. If a schema is provided, it will be used to validate. If the instance object refers to a schema (self-validating), that schema will be used to validate and the schema parameter is not necessary (if both exist, both validations will occur). The instance value/object to validate The schema to use to validate The checkPropertyChange method will check to see if an value can legally be in property with the given schema This is slightly different than the validate method in that it will fail if the schema is readonly and it will not check for self-validation, it is assumed that the passed in value is already internally valid. The checkPropertyChange method will return the same object type as validate, see JSONSchema.validate for information. The new instance value/object to check The schema to use to validate return: see dojox.validate.jsonSchema.validate A query system for JavaScript objects Returns true if the context stack contains a context for a given instance that satisfies a given method name criteria. An instance to be matched. If null, any context will be examined. Otherwise the context should belong to this instance. An optional pattern to be matched against a method name. Can be a string, a RegExp object or an array of strings and RegExp objects. If it is omitted, any name will satisfy the criteria. Returns an object, which can be used to count calls to methods. Returns an object, which can be used to count calls to methods. the function, which takes method's arguments and returns a key, which can be used to index the result. Returns an object, which can be used to trace calls with Firebug's console. Prints argument, a return value, or an exception. The flag to group output. If true, indents embedded console messages. Language specific extensions Creates a wrapper object, which can be observed. The wrapper object is a proxy to the wrapped object. If you will be making multiple wrapper objects with the same set of listeners, it is recommended that you use makeObservable, as it is more memory efficient. The object to be wrapped and monitored for property access and modification See dojox.lang.makeObservable.onRead See dojox.lang.makeObservable.onWrite See dojox.lang.makeObservable.onInvoke Creates and returns an observable creator function. All the objects that are created with the returned constructor will use the provided onRead and onWrite listeners. The created constructor should be called with a single argument, the object that will be wrapped to be observed. The constructor will return the wrapper object. This is called whenever one of the wrapper objects created from the constructor has a property that is accessed. onRead will be called with two arguments, the first being the wrapped object, and the second is the name of property that is being accessed. The value that onRead returns will be used as the value returned by the property access This is called whenever one of the wrapper objects created from the constructor has a property that is modified. onWrite will be called with three arguments, the first being the wrapped object, the second is the name of property that is being modified, and the third is the value that is being set on the property. This is called when a method on the object is invoked. The first argument is the wrapper object, the second is the original wrapped object, the third is the method name, and the fourth is the arguments. allows you to define functions that should be delegated but may not be enumerable on the wrapped objects, so they must be explicitly included The following could be used to create a wrapper that would prevent functions from being accessed on an object: function onRead(obj,prop){ return typeof obj[prop] == 'function' ? null : obj[prop]; } var observable = dojox.lang.makeObservable(onRead,onWrite); var obj = {foo:1,bar:function(){}}; obj = observable(obj); obj.foo -> 1 obj.bar -> null Functional language constructs, including currying and lambda. builds a function from a text snippet, which represents a valid JS 1.7 list comprehension, returns a string, which represents the function. builds a function from a text snippet, which represents a valid JS 1.7 list comprehension, returns a function object. executes the list comprehension building an array. A collection of layout related Widgets cleans content to make it less likly to generate DOM/JS errors. trigger/load styles in the content Execute (eval) scripts that is found in the content replace keyword '_container_' in scripts with 'dijit.byId(this.id)' NOTE this name might change in the near future reference to the method that should grab the content makes it possible to add custom args to xhrGet, like ioArgs.headers['X-myHeader'] = 'true' callbackchain will start when onLoad occurs callbackchain will start when onUnload occurs replace current content with url's content force a re-download of content cancels a inflight download cancel a in flight download add a callback to the onLoad chain add a callback to the onUnload chain Makes a pane's content dragable by/within it's surface Naturally, the behavior is to invert the axis of the drag. Setting invert:false will make the pane drag in the same direction as the mouse. mousedown handler, start the dragging mouseup handler, stop the dragging mousemove listener, offset the scroll amount by the delta since our last call. An experimental expando-pane for dijit.layout.BorderContainer easing function used to hide pane easing function use to show pane duration to run show/hide animations Create the show and hide animations Toggle this pane's visibility Set the Expando state to &quot;closed&quot; Common animation onEnd code - &quot;unclose&quot; we aren't a layout widget, but need to act like one: A non-modal Floating window. Allow closure of this Node Allow minimizing of pane if true Allow resizing of pane true if true Horrible param name for &quot;Can you maximize this floating pane?&quot; One of: x | xy | y to limit pane's sizing direction Title to use in the header if empty, will create private layout.Dock that scrolls with viewport on bottom span of viewport. Time is MS to spend toggling in/out node [not implemented yet] will be either icon in titlepane to left of Title, and/or icon show when docked in a fisheye-like dock or maybe dockIcon would be better? The className to give to the inner node which has the content Update the Title bar with a new string Close and destroy this widget Close, but do not destroy this FloatingPane Show the FloatingPane Hide and dock the FloatingPane Make this FloatingPane full-screen (viewport) Size the FloatingPane and place accordingly bring this FloatingPane above all other panes Destroy this FloatingPane completely A widget that attaches to a node and keeps track of incoming / outgoing FloatingPanes and handles layout Instert a dockNode refernce into the dock dojox.layout._DockNode is a private widget used to keep track of which pane is docked. Shown in dock icon. should read parent iconSrc? reference to the FloatingPane we reprasent in any given dock remove this dock item from parent dock, and call show() on reffed floatingpane The Grid Container is a container of child elements that are placed in a kind of grid. Contain i18n ressources. Define auto organisation of children into the grid container. Define if the right border has a fixed size. Define if the left border has a fixed size. Allow or not resizing of columns by a grip handle. The number of dropped zones. Define the opacity of the DnD Avatar. Minimum column width in percentage. Minimun children with in pixel (only used for IE6 that doesn't handle min-width css property */ The gridcontainer will only accept the children that fit to the types. In order to do that, the child must have a widgetType or a dndType attribute corresponding to the accepted type.*/ location to add columns, must be set to left or right(default) auto-scrolling enable inside the GridContainer display time of popup in miliseconds if true : Let the mouse to its original location when moving (allow to specify it proper offset) if false : Current behavior, mouse in the upper left corner of the widget Allow to specify its own offset (x and y) onl when Parameter isOffset is true Specify if there is a specific drag handle on widgets Array of classes of nodes that will act as drag handles Determine if user can resizing the widget with the mouse. Save the old width size. Save the old height size. Initialization of the GridContainer widget destroy GridContainer Component. Callback method to resize the GridContainer widget and columns List all zones and insert service into columns. Organize Services by column property of widget. Insert a service in a specific column of the GridContainer widget. Add a service (child widget) in a specific column of the GridContainer widget. widget to insert zone number (column) place in the zone (first = 0) Create all grid (zones and grip) disconnect all events on insertNodes Create a DnD column. Create a grip for a specific zone Initialize the position of a grip which will not change (top) Define the position of a grip and place it on page. Return a DOM node containing a zone by given a index. Return an integer by given a zone Connect events to listen the resize action. Change the type of width columns (% to px) Calculate the minwidth according to the children Change columns size. Disconnect resize events. Change the type of width columns (px to %) Set the number of columns Add some columns Remove some columns with indices passed as an array Update the columns width. Enable a11y into the GridContainer : - Possibility to move focus into the GridContainer (TAB, LEFT ARROW, RIGHT ARROW, UP ARROW, DOWN ARROW). - Possibility to move GridContainer's children (Drag and Drop) with keyboard. (SHIFT + ARROW). If the type of widget is not draggable, a popup is displayed. display a popup when a widget type can not move A Container that turns its Layout Children into a single Pane and transitions between states onHover of the button toggles internal button making on or off The full declared className of the Button widget to use for hasButtons the template for our container scan the container for children, and make &quot;tab buttons&quot; for them Creates a hover button for a child node of the RadioGroup Add a child to this Group and create a button if necessary called when StackContainer receives a selectChild call, used to transition the panes. show the selected child widget hide the specified child widget An extension on a stock RadioGroup, that fades the panes. hide the specified child widget show the specified child widget A Sliding Radio Group A z-index to apply to the incoming pane on startup, set each of the panes off-screen (_showChild is called later) set the child out of view immediately after being hidden Slide in the selected child widget reset the position of the hidden pane out of sight The Buttons for a RadioGroup the Text Label of the button start listening to mouseOver set the selected child on hover, and set our hover state class remove hover state class from sibling Buttons. This is easier (and more reliable) than setting up an additional connection to onMouseOut FIXME: this relies on the template being [div][span]node[/span][/div] A dragable handle used to resize an attached node. id of the Widget OR DomNode that I will size over-ride targetId and attch this handle directly to a reference of a DomNode one of: x|y|xy limit resizing to a single axis, default to xy ... if true, node will size realtime with mouse movement, if false, node will create virtual node, and only resize target on mouseUp css class applied to virtual resize node. only applicable if activeResize = false. onMouseup, animate the node to the new size one of &quot;chain&quot; or &quot;combine&quot; ... visual effect only. combine will &quot;scale&quot; node to size, &quot;chain&quot; will alter width, then height time in MS to run sizing animation. if animateMethod=&quot;chain&quot;, total animation playtime is 2*animateDuration smallest height in px resized node can be smallest width in px resize node can be setup our one major listener upon creation setup movement listeners and calculate initial size called when moving the ResizeHandle ... determines new size based on settings/position and sets styles. apply sizing information based on information in (e) to attached node disconnect listenrs and cleanup sizing Stub fired when sizing is done, for things like Grid A global private resize helper shared between any resizeHandle with activeSizing='false; show helper to start resizing hide helper after resizing is complete size the widget and place accordingly FIXME: this is off when padding present Extends a StackContainer to automatically transition between children and display navigation in the form of tabs or a pager. <div dojoType="dojox.layout.RotatorContainer" id="myRotator" showTabs="true" autoStart="true" transitionDelay="5000"> <div id="pane1" dojoType="dijit.layout.ContentPane" title="1"> Pane 1! </div> <div id="pane2" dojoType="dijit.layout.ContentPane" title="2"> Pane 2! </div> <div id="pane3" dojoType="dijit.layout.ContentPane" title="3" transitionDelay="10000"> Pane 3 with overrided transitionDelay! </div> </div> Sets the display of the tabs. The tabs are actually a StackController. The child's title is used for the tab's label. The delay in milliseconds before transitioning to the next child. The type of transition to perform when switching children. A null transition will transition instantly. The duration of the transition in milliseconds. Starts the timer to transition children upon creation. Pause the rotator when the mouse hovers over it. Pause the rotator when the tab is changed or the pager's next/previous buttons are clicked. Causes the rotator to rotate in reverse order. ID the pager widget. Number of cycles before pausing. The timer used for controlling the transitions. Flag to quick check if the mouse is over the rotator. Flag to track transition state. The declared Class of the Pager used for this Widget Initializes the DOM nodes, tabs, and transition stuff. Initializes the pagers. Unsubscribe to all of our topics Exposes attributes to be changed. Notify the pager's current and total numbers. Triggered when the mouse is moved over the rotator container. Triggered when the mouse is moved off the rotator container. Resets the timer used to start the next transition. Cycles to the next/previous child. This function is only called when a manual change occurs in which case we may need to stop playing and we need to reset the cycle counter Schedules the next transition. Clears the transition timer and pauses the rotator. Fired when the play/pause pager button is toggled. Dispatches the appropriate transition. Crossfades two children. Helper function to style the children. Defines controls used to manipulate a RotatorContainer A pager with the current/total children and previous/next buttons. <div dojoType="dojox.layout.RotatorPager" rotatorId="myRotator"> <button dojoType="dijit.form.Button" dojoAttachPoint="previous">Prev</button> <span dojoAttachPoint="current"></span> / <span dojoAttachPoint="total"></span> <button dojoType="dijit.form.Button" dojoAttachPoint="next">Next</button> </div> The ID of the rotator this pager is tied to. Only required if defined outside of the RotatorContainer's container. Unsubscribe to all of our topics Updates the display of the play/pause button Updates the pager's play/pause button, current child, and total number of children. A pane that &quot;scrolls&quot; its content based on the mouse poisition inside <div dojoType="dojox.layout.ScrollPane" style="width:150px height:300px;"> <!-- any height content --> </div> storage for our top and bottom most scrollpoints height of the visible pane either &quot;horizontal&quot; or &quot;vertical&quot; for scroll orientation. calculates required sizes. Call this if you add/remove content manually, or reload the content. set the pane's scroll offset, and position the virtual scroll helper calculate the relative offset of the cursor over the node, and call _set A draggable and toggle-to-close/open spacer between two items in a BorderContainer the initial and current state of the splitter (and its attached pane) how small the attached pane can be before its considered closed the css height/width value to apply by default when the attached pane is open the css height/width value to apply by default when the attached pane is closed handle mousedown events from the domNode create an object with the style property name: values that will need to be applied to the child pane render the given state setter for the open property event handle, toggle the open state An Object, which represents the object being moved in a GridContainer A constructor function. it is separate so it can be (dynamically) overwritten in case of need. Destroy this avatar instance dnd source handling plotted zone to show the dropping area Calculate each position of children Checks if user clicked on &quot;approved&quot; items. set an item as selectable Return one or more widget selected during the drag. test if this node can be accepted Called to finish the DnD operation Event processor for onmousedown. Event processor for onmouseup. Event processor for onmousemove Assigns a class to the current target anchor based on &quot;before&quot; status Removes a class of the current target anchor based on &quot;before&quot; status. set the position of the drop indicator hide the dashed zone Insert the dashed zone at the right place Inserts new data items (see Dojo Container's insertNodes method for details). An empty widget to show at the user the drop zone of the widget. A collection of various advanced math functions. the Dojo Offline project Called when Dojo Offline can be used. Called when our on- or offline- status changes. Either &quot;online&quot; or &quot;offline&quot;. void Called when a Dojo Offline-enabled application is finished configuring Dojo Offline, and is ready for Dojo Offline to initialize itself. void For advanced usage; most developers can ignore this. Manually goes offline, away from the network. void For advanced usage; most developers can ignore this. Attempts to go online. An optional callback function that will receive one argument: whether the site is available or not and is boolean. If this function is not present we call dojo.xoff.onOnline instead if we are able to go online. console.debug(&quot;goOnline&quot;); For advanced usage; most developers can ignore this. A standard event handler that can be attached to to find out about low-level framework events. Most developers will not need to attach to this method; it is meant for low-level information that can be useful for updating offline user-interfaces in exceptional circumstances. The default Dojo Offline UI widget takes care of most of these situations. The type of the event: * &quot;offlineCacheInstalled&quot; An event that is fired when a user has installed an offline cache after the page has been loaded. If a user didn't have an offline cache when the page loaded, a UI of some kind might have prompted them to download one. This method is called if they have downloaded and installed an offline cache so a UI can reinitialize itself to begin using this offline cache. * &quot;coreOperationFailed&quot; Fired when a core operation during interaction with the offline cache is denied by the user. Some offline caches, such as Google Gears, prompts the user to approve or deny caching files, using the database, and more. If the user denies a request that is core to Dojo Offline's operation, we set dojox.off.coreOpFailed to true and call this method for listeners that would like to respond some how to Dojo Offline 'failing fast'. * &quot;save&quot; Called whenever the framework saves data into persistent storage. This could be useful for providing save feedback or providing appropriate error feedback if saving fails due to a user not allowing the save to occur If the type was 'save', then a saveData object is provided with further save information. This object has the following properties: * status - dojox.storage.SUCCESS, dojox.storage.PENDING, dojox.storage.FAILED Whether the save succeeded, whether it is pending based on a UI dialog asking the user for permission, or whether it failed. * isCoreSave - boolean If true, then this save was for a core piece of data necessary for the functioning of Dojo Offline. If false, then it is a piece of normal data being saved for offline access. Dojo Offline will 'fail fast' if some core piece of data could not be saved, automatically setting dojox.off.coreOpFailed to 'true' and dojox.off.enabled to 'false'. * key - String The key that we are attempting to persist * value - Object The object we are trying to persist * namespace - String The Dojo Storage namespace we are saving this key/value pair into, such as &quot;default&quot;, &quot;Documents&quot;, &quot;Contacts&quot;, etc. Optional. Determines if our web application's website is available. An optional callback function that will receive one argument: whether the site is available or not and is boolean. If this function is not present we call dojox.off.onNetwork instead if we are able to go online. Causes the Dojo Offline framework to save its configuration data into local storage. Causes the Dojo Offline framework to load its configuration data from local storage An optional file, that if present, records the version of our bundle of files to make available offline. If this file is present, and we are not currently debugging, then we only refresh our offline files if the version has changed. For advanced usage; most developers can ignore this. Our list of URLs that will be cached and made available offline. For advanced usage; most developers can ignore this. Whether we are currently in the middle of refreshing our list of offline files. Autoscans the page to find all resources to cache. This includes scripts, images, CSS, and hyperlinks to pages that are in the same scheme/port/host as this page. We also scan the embedded CSS of any stylesheets to find @import statements and url()'s. You should call this method from the top-level, outside of any functions and before the page loads: &lt;script&gt; dojo.require(&quot;dojox.sql&quot;); dojo.require(&quot;dojox.off&quot;); dojo.require(&quot;dojox.off.ui&quot;); dojo.require(&quot;dojox.off.sync&quot;); // configure how we should work offline // set our application name dojox.off.ui.appName = &quot;Moxie&quot;; // automatically &quot;slurp&quot; the page and // capture the resources we need offline dojox.off.files.slurp(); // tell Dojo Offline we are ready for it to initialize itself now // that we have finished configuring it for our application dojox.off.initialize(); &lt;/script&gt; Note that inline styles on elements are not handled (i.e. if you somehow have an inline style that uses a URL); object and embed tags are not scanned since their format differs based on type; and elements created by JavaScript after page load are not found. For these you must manually add them with a dojox.off.files.cache() method call. just schedule the slurp once the page is loaded and Dojo Offline is ready to slurp; dojox.off will call our _slurp() method before indicating it is finished loading void Caches a file or list of files to be available offline. This can either be a full URL, such as http://foobar.com/index.html, or a relative URL, such as ../index.html. This URL is not actually cached until dojox.off.sync.synchronize() is called. or Array[] A URL of a file to cache or an Array of Strings of files to cache console.debug(&quot;dojox.off.files.cache, urlOrList=&quot;+urlOrList); A helper function that will dump and print out all of the URLs that are cached for offline availability. This can help with debugging if you are trying to make sure that all of your URLs are available offline void Removes a URL from the list of files to cache. The URL to remove boolean Determines whether the given resource is available offline. The URL to check void console.debug(&quot;dojox.off.files.refresh&quot;); For advanced usage; most developers can ignore this. Refreshes our list of offline resources, making them available offline. A callback that receives two arguments: whether an error occurred, which is a boolean; and an array of error message strings with details on errors encountered. If no error occured then message is empty array with length 0. For advanced usage; most developers can ignore this. Aborts and cancels a refresh. void Starts synchronizing void Attempts to cancel this sync session Applications call this method from their after getting a &quot;download&quot; event in dojox.off.sync.onSync to signal that they are finished downloading any data that should be available offline Whether our downloading was successful or not. If not present, defaults to true. If unsuccessful, a message explaining why void For advanced usage; most developers can ignore this. Called at the start of the syncing process. Advanced developers can over-ride this method to use their own sync mechanism to start syncing. void For advanced usage; most developers can ignore this. Called when we are going to refresh our list of offline files during syncing. Advanced developers can over-ride this method to do some advanced magic related to refreshing files. dojo.debug(&quot;refreshFiles&quot;); void For advanced usage; most developers can ignore this. Called when syncing wants to upload data. Advanced developers can over-ride this method to completely throw away the Action Log and replaying system and roll their own advanced sync mechanism if needed. void For advanced usage; most developers can ignore this. Called when syncing wants to download data. Advanced developers can over-ride this method to use their own sync mechanism. void For advanced usage; most developers can ignore this. Called when syncing is finished. Advanced developers can over-ride this method to clean up after finishing their own sync mechanism they might have rolled. An array of our action entries, where each one is simply a custom object literal that were passed to add() when this action entry was added. If we halted, the reason why If true, we are in the middle of replaying a command log; if false, then we are not Whether we automatically save the action log after each call to add(); defaults to true. For applications that are rapidly adding many action log entries in a short period of time, it can be useful to set this to false and simply call save() yourself when you are ready to persist your command log -- otherwise performance could be slow as the default action is to attempt to persist the actions log constantly with calls to add(). void Adds an action to our action log void Called when we replay our log, for each of our action entries. A custom object literal representing an action for this application, such as {actionName: &quot;create&quot;, item: {title: &quot;message&quot;, content: &quot;hello world&quot;}} A reference to the dojox.off.sync.actions log so that developers can easily call actionLog.continueReplay() or actionLog.haltReplay(). Number Returns the length of this action log void Halts replaying this command log. The reason we halted. void Indicates that we should continue processing out list of actions. void Completely clears this action log of its entries void For advanced usage; most developers can ignore this. Replays all of the commands that have been cached in this command log when we go back online; onCommand will be called for each command we have For advanced usage; most developers can ignore this. Called when we are finished replaying our commands; called if we have successfully exhausted all of our commands, or if an error occurred during replaying. The default implementation simply continues the synchronization process. Connect to this to register for the event: dojo.connect(dojox.off.sync.actions, &quot;onReplayFinished&quot;, someFunc) A function that should be connected to allow your application to know when Dojo Offline, the page, and the Offline Widget are all initialized and ready to be used: dojo.connect(dojox.off.ui, &quot;onLoad&quot;, someFunc) Called when we go on- or off-line &quot;online&quot; if we just moved online, and &quot;offline&quot; if we just moved offline. A simple, experimental PowerPoint-like presentation project dojox.presentation class basic powerpoint esque engine for handling transitons and control in a page-by-page and part-by-part way FIXME: parsing part(s)/widget(s) in href=&quot;&quot; Slides not working TODO: make auto actions progress. FIXME: Safari keydown/press/up listener not working. noClick=true prevents progression of slides in that broweser unsupported (that i know of) just yet. Default it to take control of window. Would be nice to be able to contain presentation in a styled container, like StackContainer ... theoretically possible. [and may not need this variable?] true to allow navigation popup, false to disallow time in MS fadein/out of popup nav [default: 250] if true, prevents _any_ click events to propagate actions (limiting control to keyboard and/or action.on=&quot;auto&quot; or action.delay=&quot;&quot; actions. if true, window location bar will get a #link to slide for direct access to a particular slide number. icon for navigation &quot;next&quot; button icon for navigation &quot;previous&quot; button connect to the various handlers and controls for this presention jump to slide based on param stub function? TODOC: ? transition to the next slide. transition to the previous slide get the current hash to set in localtion hides navigation shows navigation does nothing? _that_ seems useful. populate navigation select list with refs to slides call this if you add a node to your presentation dynamically. main presentation function, determines next 'best action' for a specified event. goes to slide returns true||false base of a nodes click-ability sets url #mark to direct slide access resize this and children to fix this window/container over-ride stackcontainers _transition method but atm, i find it to be ugly with not way to call _showChild() without over-riding it too. hopefull basic toggles in superclass._transition will be available in dijit, and this won't be necessary. a Comonent of a dojox.presentation, and container for each 'Slide' made up of direct HTML (no part/action relationship), and dojox.presentation.Part(s), and their attached Actions. string to insert into titleNode, title of Slide true on slide tag prevents clicking, false allows (can also be set on base presentation for global control) setup this slide with actions and components (Parts) gotoAndPlay current cached action returns the _next action in this sequence set action chain back to 0 and re-init each Part a node in a presentation.Slide that inherits control from a dojox.presentation.Action can be any element type, and requires styling before parsing like an ID, attach to Action via (part) as=&quot;&quot; / (action) forSlide=&quot;&quot; tags this should be unique identifier? true to leave in page on slide startup/reset false to hide on slide startup/reset override and init() this component set part back to initial calculate state these _seem_ backwards, but quickToggle flips it ugly [unworking] fix to test setting state of component before/after an animation. display:none prevents fadeIns? a widget to attach to a dojox.presentation.Part to control it's properties based on an inherited chain of events ... FIXME: only 'click' supported ATM. plans include on=&quot;delay&quot;, on=&quot;end&quot; of=&quot;&quot;, and on=&quot;auto&quot;. those should make semantic sense to you. attach this action to a dojox.presentation.Part with a matching 'as' attribute will toggle attached [matching] node(s) via forSlide/as relationship(s) default time in MS to run this action effect on it's 'forSlide' node runs this action on attached node(s) quick replacement for getChildrenByType(&quot;class&quot;), but in a child here ... so it's getSiblings. courtesy bill in #dojo could be moved into parent, and just call this.getChildren(), which makes more sense. run this once, should this be startup: function()? Additional input validation methods Validate various credit card types Checks if a string has non whitespace characters. Parameters allow you to constrain the length. A string length Number, minlength: Number, maxlength: Number} flags.length If set, checks if there are exactly flags.length number of characters. flags.minlength If set, checks if there are at least flags.minlength number of characters. flags.maxlength If set, checks if there are at most flags.maxlength number of characters. Validates whether a string denoting a number is between a max and min. A string max:Number min:Number, decimal:String} flags.max A number, which the value must be less than or equal to for the validation to be true. flags.min A number, which the value must be greater than or equal to for the validation to be true. flags.decimal The character used for the decimal point. Default is &quot;.&quot;. fixes ticket #2908 Validates any sort of number based format A string format:String flags.format A string or an Array of strings for multiple formats. Compares value against the Luhn algorithm to verify its integrity validates user input of an HTML form based on input profile form to be validated specifies how the form fields are to be validated {trim:Array, uppercase:Array, lowercase:Array, ucfirst:Array, digit:Array, required:Array, dependencies:Object, constraints:Object, confirm:Object} Evaluates dojo.validate.check() constraints that are specified as array arguments dojo.validate.check() profile that this evaluation is against. The single [] array of function and arguments for the function. form dom name of the field being validated. form element field. checks if value matches the pattern for that card or any card types if none is specified Boolean CC #, white spaces and dashes are ignored one of the values in cardinfo -- if Omitted it it returns a | delimited string of matching card types, or false if no matches found Vadlidate ISBN-10 or ISBN-13 based on the length of value Boolean Validates an IP address Checks if a string could be a valid URL A string An object flags.scheme Can be true, false, or [true, false]. This means: required, not allowed, or either. flags in regexp.host can be applied. flags in regexp.ipAddress can be applied. flags in regexp.tld can be applied. Checks if a string could be a valid email address A string An object flags.allowCruft Allow address like &lt;mailto:foo@yahoo.com&gt;. Default is false. flags in regexp.host can be applied. flags in regexp.ipAddress can be applied. flags in regexp.tld can be applied. Check if value is an email address list. If an empty list is returned, the value didn't pass the test or it was empty. A string An object (same as dojo.validate.isEmailAddressList) Saves the dirty data using REST Ajax methods Reverts all the changes made to JSON/REST data adds an object to the list of dirty objects. This object contains a reference to the object itself as well as a cloned and trimmed version of old object for use with revert. deletes an object to delete Creates or gets a constructor for objects from this service Fetches a resource by an absolute path/id and returns a dojo.Deferred. Return the ids attribute used by this service (based on it's schema). Defaults to &quot;id&quot;, if not other id is defined Returns the REST service and the local id for the given absolute id. The result is returned as an object with a service property and an id property This is the absolute id of the object Creates a REST service using the provided path. Adds a store to the monitored store for local storage Store to add This is the base query to should be used to load the items for the store. Generally you want to load all the items that should be available when offline. Take a string as a url to retrieve an smd or an object that is an smd or partial smd to use as a definition for the service Creates a secure sandbox from which scripts and HTML can be loaded that will only be able to access the provided element and it's descendants, the rest of the DOM and JS environment will not be accessible to the sandboxed scripts and HTML. DOM element to use as the container for the sandbox pass in the text of a script. If it passes and it can be eval'ed, it should be safe. Note that this does not do full syntax checking, it relies on eval to reject invalid scripts. There are also known false rejections: Nesting vars inside blocks will not declare the variable for the outer block Named functions are not treated as declaration so they are generally not allowed unless the name is declared with a var. Var declaration that involve multiple comma delimited variable assignments are not accepted the script to execute The safe libraries that can be called (the functions can not be access/modified by the untrusted code, only called) These globals can be freely interacted with by the untrusted code Loads the script from the given URL using XHR (assuming a plugin system is in place for cross-site requests) within the sandbox url of the script to load Loads the web page from the provided URL using XHR (assuming the plugin system is in place) within the sandbox. All scripts within the web page will also be sandboxed. url of the web page to load Evaluates the given script within the sandbox JavaScript text to evaluate A private class encapsulating any cryptography that must be done on a SQL statement. We instantiate this class and have it hold it's state so that we can potentially have several encryption operations happening at the same time by different SQL statements. Use Corrected Block TEA to encrypt plaintext using password (note plaintext &amp; password must be strings not string objects). Results will be returned to the 'callback' asychronously. Use Corrected Block TEA to decrypt ciphertext using password (note ciphertext &amp; password must be strings not string objects). Results will be returned to the 'callback' asychronously. Objects for mass storage within the browser. For when cookies just aren't enough. Storage provider that uses the features of Google Gears to store data (it is saved into the local SQL database provided by Gears, using dojox.sql) A singleton for working with dojox.storage. Flag that indicates a put() call to a storage provider was succesful. Flag that indicates a put() call to a storage provider failed. Flag that indicates a put() call to a storage provider is pending user approval. Returned by getMaximumSize() if this storage provider can not determine the maximum amount of data it can support. Returned by getMaximumSize() if this storage provider has no theoretical limit on the amount of data it can store. The namespace for all storage operations. This is useful if several applications want access to the storage system from the same domain but want different storage silos. If a function is assigned to this property, then when the settings provider's UI is closed this function is called. Useful, for example, if the user has just cleared out all storage for this provider using the settings UI, and you want to update your UI. Allows this storage provider to initialize itself. This is called after the page has finished loading, so you can not do document.writes(). Storage Provider subclasses should initialize themselves inside of here rather than in their function constructor. Boolean Returns whether this storage provider is available on this platform. Puts a key and value into this storage system. A string key to use when retrieving this value in the future. A value to store; this can be any JavaScript type. A callback function that will receive three arguments. The first argument is one of three values: dojox.storage.SUCCESS, dojox.storage.FAILED, or dojox.storage.PENDING; these values determine how the put request went. In some storage systems users can deny a storage request, resulting in a dojox.storage.FAILED, while in other storage systems a storage request must wait for user approval, resulting in a dojox.storage.PENDING status until the request is either approved or denied, resulting in another call back with dojox.storage.SUCCESS. The second argument in the call back is the key name that was being stored. The third argument in the call back is an optional message that details possible error messages that might have occurred during the storage process. Optional string namespace that this value will be placed into; if left off, the value will be placed into dojox.storage.DEFAULT_NAMESPACE Object Gets the value with the given key. Returns null if this key is not in the storage system. A string key to get the value of. Optional string namespace that this value will be retrieved from; if left off, the value will be retrieved from dojox.storage.DEFAULT_NAMESPACE return: Returns any JavaScript object type; null if the key is not present Determines whether the storage has the given key. Array Enumerates all of the available keys in this storage system. return: Array of available keys Completely clears this storage system of all of it's values and keys. If 'namespace' is provided just clears the keys in that namespace. Removes the given key from this storage system. Boolean Returns whether this storage provider's values are persisted when this platform is shutdown. mixed The maximum storage allowed by this provider Returns the maximum storage size supported by this provider, in thousands of bytes (i.e., if it returns 60 then this means that 60K of storage is supported). If this provider can not determine it's maximum size, then dojox.storage.SIZE_NOT_AVAILABLE is returned; if there is no theoretical limit on the amount of storage this provider can return, then dojox.storage.SIZE_NO_LIMIT is returned Puts multiple keys and values into this storage system. An array of string keys to use when retrieving this value in the future, one per value to be stored An array of values to store; this can be any JavaScript type, though the performance of plain strings is considerably better A callback function that will receive three arguments. The first argument is one of three values: dojox.storage.SUCCESS, dojox.storage.FAILED, or dojox.storage.PENDING; these values determine how the put request went. In some storage systems users can deny a storage request, resulting in a dojox.storage.FAILED, while in other storage systems a storage request must wait for user approval, resulting in a dojox.storage.PENDING status until the request is either approved or denied, resulting in another call back with dojox.storage.SUCCESS. The second argument in the call back is the key name that was being stored. The third argument in the call back is an optional message that details possible error messages that might have occurred during the storage process. Optional string namespace that this value will be placed into; if left off, the value will be placed into dojox.storage.DEFAULT_NAMESPACE Object Gets the valuse corresponding to each of the given keys. Returns a null array element for each given key that is not in the storage system. An array of string keys to get the value of. Optional string namespace that this value will be retrieved from; if left off, the value will be retrieved from dojox.storage.DEFAULT_NAMESPACE return: Returns any JavaScript object type; null if the key is not present Removes the given keys from this storage system. Boolean Determines whether this provider has a settings UI. If this provider has a settings UI, determined by calling hasSettingsUI(), it is shown. If this provider has a settings UI, hides it. Boolean Subclasses can call this to ensure that the key given is valid in a consistent way across different storage providers. We use the lowest common denominator for key values allowed: only letters, numbers, and underscores are allowed. No spaces. Array[] Returns a list of URLs that this storage provider might depend on. Storage provider that uses WHAT Working Group features in Firefox 2 to achieve permanent storage. A singleton class in charge of the dojox.storage system Initializes the storage system and autodetects the best storage provider we can provide on this platform Registers the existence of a new storage provider; used by subclasses to inform the manager of their existence. The storage manager will select storage providers based on their ordering, so the order in which you call this method matters. The full class name of this provider, such as &quot;dojox.storage.FlashStorageProvider&quot;. An instance of this provider, which we will use to call isAvailable() on. keep list of providers as a list so that we can know what order storage providers are preferred; also, store the providers hashed by name in case someone wants to get a provider that uses a particular storage backend Instructs the storageManager to use the given storage class for all storage requests. Autodetects the best possible persistent storage provider available on this platform. console.debug(&quot;dojox.storage.manager.autodetect&quot;); Boolean Returns whether any storage options are available. void Adds an onload listener to know when Dojo Offline can be used. A function to call when Dojo Offline is ready to go void Removes the given onLoad listener Boolean Returns whether the storage system is initialized and ready to be used. Boolean Determines if this platform supports the given storage provider. Object Gets the current provider The storage provider should call this method when it is loaded and ready to be used. Clients who will use the provider will connect to this method to know when they can use the storage system. You can either use dojo.connect to connect to this function, or can use dojox.storage.manager.addOnLoad() to add a listener that does not depend on the dojo.event package. Returns a list of whatever resources are necessary for storage providers to work. The storage provider that was automagically chosen to do storage on this platform, such as dojox.storage.FlashStorageProvider. Attach key listeners to the INPUT field to accomodate dynamic complex BiDi expressions INPUT DOM node Complex Expression Pattern type. One of &quot;FILE_PATH&quot;, &quot;URL&quot;, &quot;EMAIL&quot;, &quot;XPATH&quot; Create the display string by adding the Unicode direction Markers Complex Expression Pattern type. One of &quot;FILE_PATH&quot;, &quot;URL&quot;, &quot;EMAIL&quot;, &quot;XPATH&quot; removes all Unicode directional markers from the string This function strips the unicode directional controls when the text copied to the Clipboard A collection of various objects for advanced string manipulation, including a Builder and a tokenizer. Split a string by a regular expression with the ability to capture the delimeters Each group (excluding the 0 group) is passed as a parameter. If the function returns a value, it's added to the list of tokens. Used as the &quot;this&quot; instance when calling parseDelim A fast buffer for creating large strings. The current length of the internal string. Append all arguments to the end of the buffer Alias for append. Append an array of items to the internal buffer. Remove all characters from the buffer. Replace instances of one string with another in the buffer. Remove len characters starting at index start. If len is not provided, the end of the string is assumed. Insert string str starting at index. Return the string representation of the internal buffer. This class executes doctests. Run the doctests in the module given. doctest = new dojox.testing.DocTest(); doctest.run("dojox.testing.DocTest"); doctest.errors should finally be an empty array. // The above is not a doctest, because it just would // execute itself in a never ending loop. >>> true==true // Test a new line terminating the test. true >>> true==true // Test a new test terminating the test. true >>> true==true // Test a "not a comment"-line, especially an empty line terminating the test. true Each element in the array contains the test in the first element, and the expected result in the second element. Make sure that the types are compared properly. There used to be the bug that a return value false was compared to &quot;false&quot; which made the test fail. This is fixed and should be verified by the following tests. &gt;&gt;&gt; false false &gt;&gt;&gt; &quot;false&quot; &quot;false&quot; &gt;&gt;&gt; true true &gt;&gt;&gt; 1 1 &gt;&gt;&gt; &quot;s&quot; &quot;s&quot; &gt;&gt;&gt; dojo.toJson({one:1}) &quot;{&quot;one&quot;:1}&quot; A set of objects to perform advanced time-based tasks, including a basic Timer. This class provides functionality to really sequentialize function calls. You need to provide a list of functions and some parameters for each (like: pauseBefore) and they will be run one after another. This can be very useful for slideshows or alike things. Run the passed sequence definition The sequence of actions The function to call when done Execute one task of this._defsResolved. This method just provides a hook from the outside, so that an interrupted sequence can be continued. Stop the currently running sequence. interval in ms at which the output function is fired. Timer object executes an &quot;onTick()&quot; method repeatedly at a specified interval. repeatedly at a given interval. between function calls, in milliseconds. Method called every time the interval passes. Override to do something useful. Reset the interval of a timer, whether running or not. interval, in milliseconds. Start the timer ticking. Stop the timer. Universally Unique Identifier (UUID) implementations, including an implementation of UUID 2 Throws an exception if the assertion fails. Must be true for the assertion to succeed. A string describing the assertion. throws: Throws an Error if 'booleanValue' is false. This function returns the Nil UUID: &quot;00000000-0000-0000-0000-000000000000&quot;. Returns true if the UUID was initialized with a valid value. Returns a variant code that indicates what type of UUID this is. Returns one of the enumerated dojox.uuid.variant values. var variant = dojox.uuid.getVariant("3b12f1df-5232-4804-897e-917bf397618a"); dojox.uuid.assert(variant == dojox.uuid.variant.DCE); Returns a version number that indicates what type of UUID this is. Returns one of the enumerated dojox.uuid.version values. var version = dojox.uuid.getVersion("b4308fb0-86cd-11da-a72b-0800200c9a66"); dojox.uuid.assert(version == dojox.uuid.version.TIME_BASED); If this is a version 1 UUID (a time-based UUID), getNode() returns a 12-character string with the &quot;node&quot; or &quot;pseudonode&quot; portion of the UUID, which is the rightmost 12 characters. If this is a version 1 UUID (a time-based UUID), this method returns the timestamp value encoded in the UUID. The caller can ask for the timestamp to be returned either as a JavaScript Date object or as a 15-character string of hex digits. Returns the timestamp value as a JavaScript Date object or a 15-character string of hex digits. examples: var uuidString = "b4308fb0-86cd-11da-a72b-0800200c9a66"; var date, string, hexString; date = dojox.uuid.getTimestamp(uuidString); // returns a JavaScript Date date = dojox.uuid.getTimestamp(uuidString, Date); // string = dojox.uuid.getTimestamp(uuidString, String); // "Mon, 16 Jan 2006 20:21:41 GMT" hexString = dojox.uuid.getTimestamp(uuidString, "hex"); // "1da86cdb4308fb0" Any of these five values: &quot;string&quot;, String, &quot;hex&quot;, &quot;date&quot;, Date This function generates random UUIDs, meaning &quot;version 4&quot; UUIDs. This is the constructor for the Uuid class. The Uuid class offers methods for inspecting existing UUIDs. Compares this UUID to another UUID, and returns 0, 1, or -1. Any object that has toString() method that returns a 36-character string that conforms to the UUID spec. Any object that has toString() method that returns a 36-character string that conforms to the UUID spec. Any object that has toString() method that returns a 36-character string that conforms to the UUID spec. Sets the default generator, which will be used by the &quot;new dojox.uuid.Uuid()&quot; constructor if no parameters are passed in. A UUID generator function, such as dojox.uuid.generateTimeBasedUuid. Returns the default generator. See setGenerator(). This method returns a standard 36-character string representing the UUID, such as &quot;3b12f1df-5232-4804-897e-917bf397618a&quot;. Returns true if this UUID is equal to the otherUuid, or false otherwise. Any object that has toString() method that returns a 36-character string that conforms to the UUID spec. Returns true if the UUID was initialized with a valid value. Returns a variant code that indicates what type of UUID this is. Returns one of the enumerated dojox.uuid.variant values. Returns a version number that indicates what type of UUID this is. Returns one of the enumerated dojox.uuid.version values. var uuid = new dojox.uuid.Uuid("b4308fb0-86cd-11da-a72b-0800200c9a66"); var version = uuid.getVersion(); dojox.uuid.assert(version == dojox.uuid.version.TIME_BASED); If this is a version 1 UUID (a time-based UUID), getNode() returns a 12-character string with the &quot;node&quot; or &quot;pseudonode&quot; portion of the UUID, which is the rightmost 12 characters. If this is a version 1 UUID (a time-based UUID), this method returns the timestamp value encoded in the UUID. The caller can ask for the timestamp to be returned either as a JavaScript Date object or as a 15-character string of hex digits. Returns the timestamp value as a JavaScript Date object or a 15-character string of hex digits. examples: var uuid = new dojox.uuid.Uuid("b4308fb0-86cd-11da-a72b-0800200c9a66"); var date, string, hexString; date = uuid.getTimestamp(); // returns a JavaScript Date date = uuid.getTimestamp(Date); // string = uuid.getTimestamp(String); // "Mon, 16 Jan 2006 20:21:41 GMT" hexString = uuid.getTimestamp("hex"); // "1da86cdb4308fb0" Any of these five values: &quot;string&quot;, String, &quot;hex&quot;, &quot;date&quot;, Date This function generates time-based UUIDs, meaning &quot;version 1&quot; UUIDs. Sets the 'node' value that will be included in generated UUIDs. A 12-character hex string representing a pseudoNode or hardwareNode. Returns the 'node' value that will be included in generated UUIDs. Generates a time-based UUID, meaning a version 1 UUID. An optional 12-character string to use as the node in the new UUID. Methods specific to the Canadian provinces Validates 10 Canadian digit phone number for several common formats Boolean Validates Canadian province abbreviations (2 chars) Boolean Validates Canadian 9 digit social insurance number for several common formats This routine only pattern matches and does not use the Luhn Algorithm to validate number. Boolean Validates Canadian 6 digit postal code: Canadian postal codes are in the format ANA NAN, where A is a letter and N is a digit, with a space separating the third and fourth characters. Boolean Additional pre-made regular expressions for use Builds a RE that matches a top-level domain flags.allowCC Include 2 letter country code domains. Default is true. flags.allowGeneric Include the generic domains. Default is true. flags.allowInfra Include infrastructure domains. Default is true. Builds a RE that matches an IP Address Builds a RE that matches a host An object. flags.allowNamed Allow a named host for local networks. Default is false. flags.allowIP Allow an IP address for hostname. Default is true. flags.allowLocal Allow the host to be &quot;localhost&quot;. Default is false. flags.allowPort Allow a port number to be present. Default is true. flags in regexp.ipAddress can be applied. flags in regexp.tld can be applied. Builds a regular expression that matches a URL An object flags.scheme Can be true, false, or [true, false]. This means: required, not allowed, or match either one. flags in regexp.host can be applied. flags in regexp.ipAddress can be applied. flags in regexp.tld can be applied. Builds a regular expression to match any sort of number based format An object flags.format A string or an Array of strings for multiple formats. A regular expression to match US state and territory abbreviations flags An object. flags.allowTerritories Allow Guam, Puerto Rico, etc. Default is true. flags.allowMilitary Allow military 'states', e.g. Armed Forces Europe (AE). Default is true. a regular expression to match Canadian Province Abbreviations Validates US state and territory abbreviations. A two character string An object flags.allowTerritories Allow Guam, Puerto Rico, etc. Default is true. flags.allowMilitary Allow military 'states', e.g. Armed Forces Europe (AE). Default is true. Validates 10 US digit phone number for several common formats The telephone number string Validates social security number Validates U.S. zip-code A collection of un-categorized widgets, or code not requiring it's own package. constructor for the widget The list of mixin views available on this calendar. Specifies if visual effects should be applied to the widget. The default behavior of the widget does not contain any effects. The dojox.widget.CalendarFx package is needed for these. This widget is a container of other widgets, so this is true. the currently selected Date Instantiates the mixin views set the current date and update the UI. If the date is disabled, the selection will not change, but the display will change to the corresponding month. May be overridden to disable certain dates in the calendar e.g. `isDisabledDate=dojo.date.locale.isWeekend` a date cell was selected. It may be the same as the previous value. called only when the selected date has changed Transitions to the next view. Animates the views to show one and hide another, in a vertical direction. If 'direction' is 1, then the views slide upwards. If 'direction' is -1, the views slide downwards. Animates the horizontal sliding of a table. May be overridden to return CSS classes to associate with the date entry for the given dateObject, for example to indicate a holiday in specified locale. This function overrides the base function defined in dijit._Calendar. It changes the displayed years, months and days depending on the inputs. Base implementation for all view mixins. All calendar views should extend this widget. Clones all nodes with the class 'clazz' in a widget sets the text inside a node returns the header node of a view. If none exists, an empty DIV is created and returned. Adds or subtracts values from a date. The unit, e.g. &quot;day&quot;, &quot;month&quot; or &quot;year&quot;, is specified in the &quot;datePart&quot; property of the calendar view mixin. Mixin for the dojox.widget.Calendar which provides the standard day-view. A single month is shown at a time. View class for the dojox.widget.Calendar. Adds a view showing every day of a single month to the calendar. This should not be mixed in directly with dojox.widget._CalendarBase. Instead, use dojox.widget._CalendarDay Specifies how much to increment the displayed date when the user clicks the array button to increment of decrement the view. Specifies the type of day name to display. &quot;narrow&quot; causes just one letter to be shown. Constructs the calendar view. executed when a day value is clicked. Fills the days of the current month. Adds a dojox.widget._CalendarMonthView view to the calendar widget. A Calendar view listing the 12 months of the year Specifies how much to increment the displayed date when the user clicks the array button to increment of decrement the view. Constructs the view Returns localized month names Populate the month names using the localized values. Handles clicks on month names Adds a dojox.widget._CalendarYearView view to the dojo.widget._CalendarBase widget. A Calendar view listing 12 years Constructs the view Writes the years to display to the view Adjusts the value of a date. It moves it by 12 years each time. Handles clicks on year values. The standard Calendar. It includes day, month and year views. No visual effects are included. A calendar with only a daily view. A calendar with only a month view. A calendar with only a year view. The standard Calendar. It includes day, month and year views. FisheyeLite effects are included. a HSV color picker - similar to Photoshop picker var picker = new dojox.widget.ColorPicker({ // a couple of example toggles: animatePoint:false, showHsv: false, webSafe: false, showRgb: false }); show/update RGB input nodes show/update HSV input nodes show/update Hex value field deprecated? or just use a toggle to show/hide that node, too? toggle to use slideTo (true) or just place the cursor (false) on click time in ms picker node will slide to next location (non-dragging) when animatePoint=true Set to true to fire onChange in an indeterminate way As quickly as we can, set up ie6 alpha-filter support for our underlay. we don't do image handles (done in css), just the 'core' of this widget: the underlay. sets a natural color background for the underlay image against closest hue value (full saturation) 0..255 update the previewNode color, and input values [optional] all these should be in the [0..150] range set the hue picker handle on relative y coordinates set our picker point based on relative x/y coordinates evt.preventDefault(); A Lightbox-like Modal-dialog for HTML Content If false, fix the size of the dialog to the Viewport based on viewportPadding value rather than the calculated or natural stlye. If true, base the size on a passed dimension attribute. Eitherway, the viewportPadding value is used if the the content extends beyond the viewport size for whatever reason. If fixedSize=&quot;true&quot;, this is the value or used when fixed=&quot;false&quot; and dimensions exceed) to use A two-element array of [widht,height] to animate the Dialog to. Defaults to [300,300] An easing function to apply to the sizing animation. Time (in ms) to use in the Animation for sizing. To be passed to dojox.fx.sizeTo, one of &quot;chain&quot; or &quot;combine&quot; to effect the animation sequence. Toogle to show or hide the Title area. Can only be set at startup. Make the pane draggable. Differs from dijit.Dialog by setting default to false Piggyback on dijit.Dialog's _setup for load-time options, deferred to cache and set our desired end position Handle's showing or hiding the close icon Show the inner container after sizing animation A widget to run DocTests inside an HTML page. a pane to display the information for the currently-selected file delete our template string Our template path called after a fetch or load - at this point, this.items should be set and loaded. a specialized version of RollingList that handles file information in a store Our file separator - it will be guessed if not set The top directory string - it will be guessed if not set the attribute to read for finding our parent directory the attribute to read for getting the full path of our file returns the path value of the given value (or current value if not passed a value) Menu similar to the fish eye menu on the Mac OS <div dojoType="FisheyeList" itemWidth="40" itemHeight="40" itemMaxWidth="150" itemMaxHeight="150" orientation="horizontal" effectUnits="2" itemPadding="10" attachEdge="center" labelEdge="bottom"> <div dojoType="FisheyeListItem" id="item1" onclick="alert('click on' + this.label + '(from widget id ' + this.widgetId + ')!');" label="Item 1" iconSrc="images/fisheye_1.png"> </div> ... </div> width of menu item (in pixels) in it's dormant state (when the mouse is far away) height of menu item (in pixels) in it's dormant state (when the mouse is far away) width of menu item (in pixels) in it's fully enlarged state (when the mouse is directly over it) height of menu item (in pixels) in it's fully enlarged state (when the mouse is directly over it) orientation of the menu, either &quot;horizontal&quot; or &quot;vertical&quot; toggle to enable additional listener (window scroll) if FisheyeList is in a fixed postion if true, don't start enlarging menu items until mouse is over an image; if false, start enlarging menu items as the mouse moves near them. controls how much reaction the menu makes, relative to the distance of the mouse from the menu padding (in pixels) betweeen each menu item controls the border that the menu items don't expand past; for example, if set to &quot;top&quot;, then the menu items will drop downwards as they expand. values &quot;center&quot;, &quot;left&quot;, &quot;right&quot;, &quot;top&quot;, &quot;bottom&quot;. controls were the labels show up in relation to the menu item icons values &quot;center&quot;, &quot;left&quot;, &quot;right&quot;, &quot;top&quot;, &quot;bottom&quot;. create our connections and setup our FisheyeList Returns whether the mouse is over the passed element. Node: Must must be display:block (ie, not a &lt;span&gt;) called when mouse moves out of menu's range called when mouse is moved into menu's range called when mouse is moved called when mouse is moved in the vicinity of the menu slowly expand the image to user specified max size label to print next to the icon, when it is moused-over will be set to the id of the orginal div element checks to see if wh is actually a node. returns whether or not node is a child of another node. callback when user moves mouse over this menu item in conservative mode, don't activate the menu until user mouses over an icon callback when user moves mouse off of this menu item user overridable callback when user clicks this menu item A Light-weight Fisheye Component, or an exhanced version of dojo.fx.Toggler ... // make all the LI's in a node Fisheye's: dojo.query("#node li").forEach(function(n){ new dojox.widget.FisheyeLite({},n); }); duationIn: Integer The time (in ms) the run the show animation The Time (in ms) to run the hide animation An object of &quot;property&quot;:scale pairs defaults to font-size with a scale of 2.75 Sometimes, you need to specify a unit. Should be part of properties attrib, but was trying to shorthand the logic there An easing function to use for the show animation An easing function to use for the hide animation Show this Fisheye item. Hide this fisheye item on mouse leave Pre-generate the animations stub function fired when target is clicked connect or override to use. stub function fired when Fisheye Item is fully visible and hovered. connect or override use. a configurable global xhr-listener to display a loading message during running xhr's or to simply provide base-level topic to subscribe to for custom loading messages string to use for progress loading true to display a fixed loading message in TR cornder, false to unly provide &quot;Loader&quot; topic to subscribe to for your own custom loading message. time in ms to toggle in/out the visual load indicator distance in px from the mouse pointer to show attachToPointer avatar setup the loader set's the message in the loader place the floating loading element based on mousemove connection position publish and show progress indicator publish &quot;xhr ended&quot; and hide progress indicator A Pager, displaying a list of sized nodes The url of the previous page icon The url of the next page icon A dojo.data Data store Either &quot;horizontal or &quot;vertical&quot; to define the direction the pages will slide A string describing where to put the Pager &quot;current page&quot; indicator. Options are &quot;leading&quot; or &quot;trailing&quot;. In the case of horiztonal orientation, &quot;leading&quot; indicates positioned above the PageItems. In the case of vertical, &quot;leading&quot; indicates &quot;before&quot;. TODOC Time in milliseconds to transition the pages Spacing between items? TODOC TODOC The full dotted named of a Class to use for the internal Pager Items. The numbers of items to display in each &quot;Page&quot; top level onfocus/onblur listen to set a class &quot;pagerFocus&quot; on some node and remove it onblur Handle keyboard navigation internally Stub Function. Fired after the slide is complete. Override or connect. A menu item that can be used as a placeholder. Set the label of this item to a unique key and you can then use it to add new items at that location. This item is not displayed. replaces this menu item with the given menuItems. The original menu item is not actually removed from the menu - so if you want it removed, you must do that explicitly. true if the replace happened, false if not Removes menu items added by calling replace(). It returns the array of items that were actually removed (in case you want to clean them up later) The array of items that were actually removed Also call destroy on any removed items. A simple widget to take an unorder-list of Text and roll through them // create a scroller from a unorderlist with id="lister" var thinger = new dojox.widget.Roller.Roller({},"lister"); Interval between rolls Toggle to control starup behavior. Call .start() manually if set to `false` If populated prior to instantiation, is used as the Items over the children Animation creator function. Need to create an 'in' and 'out' _Animation stored in _anim Object, which the rest of the widget will reuse. setup the loop connection logic Starts to Roller looping Stops the Roller from looping anymore. Set the Roller to some passed index. If beyond range, go to first. An add-on to the Roller to modify animations. This produces a slide-from-bottom like effect Animation creator function. Need to create an 'in' and 'out' _Animation stored in _anim Object, which the rest of the widget will reuse. a core pane that can be attached to a RollingList. All panes should extend this one The pane that immediately precedes ours the store we must use an array of (possibly not-yet-loaded) items to display in this. If this array is null, then the query and query options are used to get the top-level items to use. This array is also used to watch and see if the pane needs to be reloaded (store notifications are handled) by the pane a query to pass to the datastore. This is only used if items are null query options to be passed to the datastore sets the value of the content and scrolls it into view called when a keypress happens on the widget sets the focus to this current widget checks that the store is loaded either runs the query or loads potentially not-yet-loaded items. returns whether or not the given item is handled by this pane called before a fetch starts called when a fetch error occurs. called before a load starts called when a load error occurs. called after a fetch or load - at this point, this.items should be set and loaded. Override this function to &quot;do your stuff&quot; Our rolling list widget a pane that will handle groups (treats them as menu items) our template The menu that we will call addChild() on for adding items checks that the store is loaded called after a fetch or load - at this point, this.items should be set and loaded. sets the focus to this current widget returns a widget to be used for the container widget. returns the selected menu item - or null if none are selected selectes the given item in the given menu (defaults to pane's menu) a rolling list that can be tied to a data store with children our template string to use an additional class (or space-separated classes) to add for our widget the store we must use a query to pass to the datastore. This is only used if items are null query options to be passed to the datastore one ore more attributes that holds children of a node the attribute to read for finding our parent item (if any) The value that has been selected removes all widgets after the given widget (or index) adds a child to this rolling list - if passed an insertIndex, then all children from that index on will be removed and destroyed before adding the child. sets the state of the given node with the given type and options an object with key-value-pairs. The values are boolean, if true, the key is added as a class, if false, it is removed. scrolls the given widget into view internally sets the value and fires onchange sets the value of this widget to the given store item internally called when a widget should pop up its child gets the pane for the given item, and mixes in our needed parts Returns the pane for the given item (null if the root pane) - after mixing in its stuff. returns a widget for the given store item. The returned item will be added to this widget's container widget. null will be passed in for an &quot;empty&quot; item. sets the store for this widget */ called when a keypress event happens on this widget sets the focus state of this widget Returns the child items for the given store item user overridable function to return a widget for the given item and its children. user-overridable function to return a pane that corresponds to the given item in the store. It can return null to not add a new pane (ie, you are planning on doing something else with it in onItemClick) Item is undefined for the root pane, children is undefined for non-group panes called when an item is clicked - it receives the store item exists so that popups don't disappear too soon exists so that we can close ourselves if we wish called when the value of this widget has changed 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. The title in the header In the event a parent container is expecting a title=&quot;&quot; attribute, set it for the parent via title, and the title of this widget via heading=&quot;&quot; ... assuming you want different titles for each. eg: TabContainer, AccordionContainer, etc. Toggle sort order based on this value. A list of the selected &lt;li&gt; nodes at any given time. toggle to enable/disable sorting do our additional calculations when resize() is called by or in a parent sort the data, and style the nodes. set hover state remove hover state (FIXME: combine with _set?) click listener for data portion of widget. toggle selected state of node, and update this.selected array accordingly a basic sort function, use query sort, or keep this? Sets the widget title to a String stub function, passes the last changed item, and is fired after current state Message that slides in from the corner of the screen, used for notifications like &quot;new email&quot;. Name of topic; anything published to this topic will be displayed as a message. Message format is either String or an object like {message: &quot;hello word&quot;, type: &quot;error&quot;, duration: 500} If message type isn't specified (see &quot;messageTopic&quot; parameter), then display message as this type. Possible values in messageTypes enumeration (&quot;message&quot;, &quot;warning&quot;, &quot;error&quot;, &quot;fatal&quot;) Position from which message slides into screen, one of [&quot;br-up&quot;, &quot;br-left&quot;, &quot;bl-up&quot;, &quot;bl-right&quot;, &quot;tr-down&quot;, &quot;tr-left&quot;, &quot;tl-down&quot;, &quot;tl-right&quot;] Possible values for positionDirection parameter Number of milliseconds to show message String used to separate messages if consecutive calls are made to setContent before previous messages go away sets and displays the given message and show duration the message. If this is a function, it will be called with this toaster widget as the only argument. type of message; possible values in messageTypes enumeration (&quot;message&quot;, &quot;warning&quot;, &quot;error&quot;, &quot;fatal&quot;) duration in milliseconds to display message before removing it. Widget has default value. callback for when user clicks the message show the Toaster hide the Toaster Possible message types. A set of panels that display sequentially, typically notating a step-by-step procedure like an install Label override for the &quot;Next&quot; button. Label override for the &quot;Previous&quot; button. Label override for the &quot;Cancel&quot; button. Label override for the &quot;Done&quot; button. Name of function to call if user presses cancel button. Cancel button is not displayed if function is not specified. If true, disabled buttons are hidden; otherwise, they are assigned the &quot;WizardButtonDisabled&quot; CSS class callback when next button is clicked Finish the wizard's operation A panel in a `dojox.widget.Wizard` If true, then can move back to a previous panel (by clicking the &quot;Previous&quot; button) Name of function that checks if it's OK to advance to the next panel. If it's not OK (for example, mandatory field hasn't been entered), then returns an error message (String) explaining the reason. Name of function that is run if you press the &quot;Done&quot; button from this panel Called when the user presses the &quot;next&quot; button. Calls passFunction to see if it's OK to advance to next panel, and if it isn't, then display error. Returns true to advance, false to not advance. If passFunction returns a string, it is assumed to be a custom error message, and is alert()'ed Declarative data binding and action tags for simplified MVC Register a Wire class desription: The specified Wire class or a class name is registered with a key property of arguments to create a Wire A class or full qualified class name A key property of arguments to create a Wire Returns a class A class A class name Create a Wire from arguments A Wire Arguments to create a Wire Check if an object is a Wire True if the object is a Wire, otherwise false An object to check Transfer a source value to a target value A Wire or arguments to create a Wire for a source value A Wire or arguments to create a Wire for a target value defaultTargetObject Optional default root objects passed to Wires Transfer a source value to a target value on a trigger event or topic A connection handle for disconnect() An event or topic to trigger a transfer A Wire or arguments to create a Wire for a source value A Wire or arguments to create a Wire for a target value Remove a connection or subscription for transfer A connection handle returned by connect() Initialize properties Return an object with property values or an array with element values An object or array with values A root object Set an object properties or an array elements to an object desription: This method calls setValues() method of the child Wires with a corresponding property or element in 'value' argument and 'object' argument. 'object' A root object An object or array with values to set Initialize child Wires An object or array containing child Wires Initialize properties data store attribute: A dotted notation to a descendant attribute Return an attribute value of an item A value found, otherwise 'undefined' A root item Set an attribute value to an item 'object', or 'undefined' for invalid attribute A root item A value to set Return an attribute value of an item A value found, otherwise 'undefined' An item attribute An attribute name Set an attribute value to an item An item An attribute name A value to set Initialize properties Return an array of table row value (object or array) An array of table row value A root array Not supported Return an array or object for a table row An array or object for a table row Initialize properties delimiter string Return a concatenated text A concatinated text Not supported Return a concatenated text A concatinated text A base text A text segment to add Initialize properties Return an array of tree node values An array of tree node values A root array Not supported Initialize child Wires An array of objects containing child Wires Return an array of tree node values An object An object with child Wires Initialize properties converter object (or class name) to convert the return value (for the source Wire) Return a value of an object A value found A default root object Set a value to an object A value to set A default root object Return a property value of an object A value found, otherwise 'undefined' A default root object A property name Set a property value to an object An object A property name A value to set Initialize properties Return an attribute value, a text value or an array of elements A value found, otherwise 'undefined' A root node Set an attribute value or a child text value to an element A root node A value to set Return an attribute value, a text value or an array of elements A value found, otherwise 'undefined' A node An expression for attribute, text or elements Set an attribute value or a child text value to an element A node An expression for attribute or text A value to set Return a child node A child node A parent node A tag name Return a DOM document A DOM document Return a value A value A string to specify an object and its property An optional arguments array Store a value A string to specify an object and its property A value A base widget to &quot;run&quot; a task on an event or a topic event scope event (function) name topic name Call _connect() Connect run() method to an event or a topic Disconnect run() method from an event or a topic Run a task Call run() methods of child Action widgets Over-ride of base widget unitialize function to do some connection cleanup. A widget to define a filter for the parent Action to run property required A specific value the property is required to have. If this isn't provided than any non-false/non-null value of the required propery will cause this filter to pass. A specific type to compare the values as (if requiredValue is set) Valid values for type are boolean, int, string. Default is string. error message to emit if the filter doesn't execute due to property mismatch. property to store an error due to property mismatch. Check if a required property is specified. Also, if provided, check to see if the required property contains a specific value. True if a required property is specified (and if requiredValue is specified, that they match), otherwise false A widget for a data object Call _initializeProperties() Initialize a data object A boolean to reset current properties Return a property value A property value A property name Store a property value A property name A property value A widget to define a data property property name property type name property value Returns a property value A property value A widget for a data store class name of a data store Call _createStore() Create a data store desription: A data store of 'storeClass' is created with arguments specified with attributes. A data store Call getFeatures() method of a data store A features object Call fetch() method of a data store A request object A request object Call save() method of a data store A save arguments object Call newItem() method of a data store A new item A new item arguments object Call deleteItem() method of a data store A boolean Call revert() method of a data store A boolean A widget to invoke a method or publish a topic scope of a method to invoke name of a method to invoke name of a topic to publish for the method or the topic property to store a return value of the method call property to store an error on the method call Invoke a method or publish a topic A function called when the method or the topic publish completed The return value of a method or undefined for a topic A function called on an error occurs The exception or error occurred Returns arguments to a method or topic to invoke Arguments to a trigger event or topic A widget for a service URL to a service description URL to a service service type service handler class name Call _createHandler() Create a service handler desription: A service handler class is determined by: 1. 'handlerClass' attribute 2. 'serviceType' attribute 3. 'serviceType' property in a service description A service handler Call a service method with parameters method name array parameters A REST service handler Call a service method with parameters. method name array of parameters URL for the method Generate a URL A URL A method name An array of parameters A base URL Generate a request content A request content A method name An array of parameters Extract a result A result object A response data returned by a service A REST service handler for XML A request content A method name An array of parameters Extract a result A result object A response data returned by a service A REST service handler for JSON Generate a request content A request content A method name An array of parameters A widget to transfer values through source and target Wires source object and/or property data store for a source data item attribute of a source data item simplified XPath to a source property of an XML element type of the value to be transferred class name of a converter for the value to be transferred target object and/or property data store for a target data item attribute of a target data item simplified XPath to a target property of an XML element Transfer a value from a source to a target Build Wire arguments from attributes Wire arguments object Which Wire arguments to build, &quot;source&quot; or &quot;target&quot; A widget to add a child wire Wire to add a child Wire, &quot;source&quot; or &quot;target&quot;, default to &quot;source&quot; root object for the value property for the value type of the value class name of a converter for the value data item attribute for the value simplified XPath for the value composite property name Add a child Wire to Wire arguments A parent Transfer widget Wire arguments Build child Wire arguments from attributes Wire arguments object A parent Transfer widget A widget to add a column wire column name Add a column Wire to Wire arguments A parent Transfer widget Wire arguments A widget to add node wires property for the node title data item attribute for the node title simplified XPath for the node title Add node Wires to Wire arguments A parent Transfer widget Wire arguments Build node Wires arguments from attributes Wire arguments object A parent Transfer widget A widget to add a segment wire Add a segument Wire to Wire arguments A parent Transfer widget Wire arguments Initialize with an XML element or a tag name Return a property value A property value A property name Store a property value A property name A property value Return a value of the first text child of the element A value of the first text child of the element Return an object representation of the element An object representation of the element Return a DOM document A DOM document XML element or a tag name XML utilities. Currently only includes a DomParser, which returns a psuedo-XML document in JSON-like form. returns a new native XML document from the string provided as the single argument to parse(). Parsing errors throw exceptions. an object, which makes a node follow the mouse, used as a default mover, and as a base class for custom movers a node (or node's id) to be moved object which implements the functionality of the move, and defines proper events (onMoveStart and onMoveStop) event processor for onmousemove mouse event makes the node absolute; it is meant to be called only once stops the move, deletes all references, so the object can be garbage-collected a constructor of the Selector allows selection of only one element, if true the rest of parameters are passed to the container autosynchronizes the source with its list of DnD nodes, false by default returns a list (an array) of selected nodes unselects all items selects all items deletes all selected items iterates over selected items, see dojo.dnd.Container.forInItems() for details synch up the node list with the data map prepares the object to be garbage-collected event processor for onmousedown mouse event event processor for onmouseup mouse event event processor for onmousemove mouse event this function is called once, when mouse is over our container this function is called once, when mouse is out of our container unselects all items inserts new data items (see Container's insertNodes method for details) the anchor node to be used as a point of insertion a constructor of the Source checks, if the target can accept nodes from this source the source which provides items the list of transferred items Returns true, if we need to copy items, false to move. It is separated to be overwritten dynamically, if needed. the &quot;copy&quot; was pressed optional flag, which means that we are about to drop on itself prepares the object to be garbage-collected event processor for onmousemove mouse event event processor for onmousedown mouse event event processor for onmouseup mouse event topic event processor for /dnd/source/over, called when detected a current source the source which has the mouse over it topic event processor for /dnd/start, called to initiate the DnD operation the source which provides items the list of transferred items copy items, if true, move items otherwise topic event processor for /dnd/drop, called to finish the DnD operation the source which provides items the list of transferred items copy items, if true, move items otherwise the target which accepts items topic event processor for /dnd/cancel, called to cancel the DnD operation called only on the current target, when drop is performed the source which provides items the list of transferred items copy items, if true, move items otherwise called during the active DnD operation, when items are dragged over this target, and it is not disabled called during the active DnD operation, when items are dragged away from this target, and it is not disabled this function is called once, when mouse is over our container this function is called once, when mouse is out of our container assigns a class to the current target anchor based on &quot;before&quot; status insert before, if true, after otherwise removes a class of the current target anchor based on &quot;before&quot; status changes source's state based on &quot;copy&quot; status checks if user clicked on &quot;approved&quot; items mouse event called only on the current target, when drop is performed from an external source called only on the current target, when drop is performed from the same target/source a constructor of the Target --- see the Source constructor for details a constructor of the AutoSource --- see the Source constructor for details a dict of parameters for DnD Source configuration. Note that any property on Source elements may be configured, but this is the short-list can be used as a DnD source. Defaults to true. list of accepted types (text strings) for a target; defaults to [&quot;text&quot;] if true refreshes the node list on every operation; false by default copy items, if true, use a state of Ctrl key otherwise, see selfCopy and selfAccept for more details the move delay in pixels before detecting a drag; 0 by default a horizontal container, if true, vertical otherwise or when omitted copy items by default when dropping on itself, false by default, works only if copyOnly is true accept its own items when copyOnly is true, true by default, works only if copyOnly is true allows dragging only by handles, false by default an object, which makes a node moveable with a timer delay move by this number of ms accumulating position changes during the timeout sanitize parameters returns a constrained version of dojo.dnd.Mover called on drag, and returns a constraint box if true, constraints the whole dragged object withtin the rectangle, otherwise the constraint is applied to the left-top corner a specialization of dojo.dnd.constrainedMover, which constrains to the specified box a constraint box (l, t, w, h) if true, constraints the whole dragged object withtin the rectangle, otherwise the constraint is applied to the left-top corner a specialization of dojo.dnd.constrainedMover, which constrains to the parent node &quot;margin&quot; to constrain within the parent's margin box, &quot;border&quot; for the border box, &quot;padding&quot; for the padding box, and &quot;content&quot; for the content box; &quot;content&quot; is the default value. if true, constraints the whole dragged object withtin the rectangle, otherwise the constraint is applied to the left-top corner an object, which makes a node moveable restrict move within boundaries. the rest is passed to the base class a function, which calculates a constraint box, it is called in a context of the moveable object. called during the very first move notification, can be used to initialize coordinates, can be overwritten. called during every move notification, should actually move the node, can be overwritten. an object, which makes a node moveable an object, which makes a node moveable Effects library on top of Base animations summary Returns an animation that will slide "node" defined in args Object from its current position to the position defined by (args.left, args.top). dojo.fx.slideTo({ node: node, left:"40", top:"50", unit:"px" }).play() Chain a list of dojo._Animation s to run in sequence dojo.fx.chain([ dojo.fadeIn({ node:node }), dojo.fadeOut({ node:otherNode }) ]).play(); Combine a list of dojo._Animation s to run in parallel dojo.fx.combine([ dojo.fadeIn({ node:node }), dojo.fadeOut({ node:otherNode }) ]).play(); Collection of easing functions to use beyond the default dojo._defaultEasing dojo.require("dojo.fx.easing"); var anim = dojo.fadeOut({ node: 'node', duration: 2000, easing: dojo.fx.easing.quadIn }).play(); A linear easing function An easing function that starts away from the target, and quickly accelerates towards the end value An easing function that pops past the range briefly, and slowly comes back. An easing function combining the effects of backIn and backOut An easing function the elastically snaps from the start value An easing function that elasticly snaps around the target value, near the end of the Animation An easing function that elasticly snaps around the value, near the beginning and end of the Animation An easing function that &quot;bounces&quot; near the beginning of an Animation An easing function that &quot;bounces&quot; near the end of an Animation An easing function that &quot;bounces&quot; at the beginning and end of the Animation class constructor for an animation toggler. It accepts a packed set of arguments about what type of animation to use in each direction, duration, etc. var t = new dojo.fx.Toggler({ node: "nodeId", showDuration: 500, // hideDuration will default to "200" showFunc: dojo.wipeIn, // hideFunc will default to "fadeOut" }); t.show(100); // delay showing for 100ms // ...time passes... t.hide(); the node to toggle in milliseconds to run the show Animation in milliseconds to run the hide Animation The function that returns the dojo._Animation to show the node The function that returns the dojo._Animation to hide the node Toggle the node to showing Toggle the node to hidden True if client is using Google Gears factory method to get a Google Gears plugin instance to expose in the browser runtime environment, if present removes !DOCTYPE and title elements from the html string. khtml is picky about dom faults, you can't attach a style or &lt;title&gt; node as child of body must go into head, so we need to cut out those tags An html string for insertion into the dom removes all child nodes from the given node the parent element inserts the given content into the given node overlaps similiar functionality in dijit.layout.ContentPane._setContent the parent element content: the content to be set on the parent element. This can be an html string, a node reference or a NodeList, dojo.NodeList, Array or other enumerable list of nodes shouldEmptyFirst if shouldEmptyFirst is true, the node will first be emptied of all content before the new content is inserted defaults to false inserts (replaces) the given content into the given node the parent element that will receive the content the content to be set on the parent element. This can be an html string, a node reference or a NodeList, dojo.NodeList, Array or other enumerable list of nodes Optional flags/properties to configure the content-setting. See dojo.html._ContentSetter A safe string/node/nodelist content replacement/injection with hooks for extension Example Usage: dojo.html.set(node, "some string"); dojo.html.set(node, contentNode, {options}); dojo.html.set(node, myNode.childNodes, {options}); Provides a configurable, extensible object to wrap the setting on content on a node call the set() method to actually set the content.. the original params are mixed directly into the instance &quot;this&quot; An node which will be the parent element that we set content into The content to be placed in the node. Can be an HTML string, a node reference, or a enumerable list of nodes Usually only used internally, and auto-generated with each instance Should the content be treated as a full html document, and the real content stripped of &lt;html&gt;, &lt;body&gt; wrapper before injection Should the content be treated as a full html document, and the real content stripped of &lt;html&gt;, &lt;body&gt; wrapper before injection Should the node by passed to the parser after the new content is set front-end to the set-content sequence An html string, node or enumerable list of nodes for insertion into the dom If not provided, the object's content property will be used sets the content on the node runs the dojo parser over the node contents, storing any results in this.parseResults Any errors resulting from parsing are passed to _onError for handling shows user the string that is returned by on[type]Error overide/implement on[type]Error and return your own string to customize Utility classes to enable loading of resources for internationalization (i18n) Returns an Object containing the localization for a given resource bundle in a package, matching the specified locale. package which is associated with this resource the base filename of the resource bundle (without the &quot;.js&quot; suffix) the variant to load (optional). By default, the locale defined by the host environment: dojo.locale Returns canonical form of locale, as used by Dojo. See dojo.requireLocalization() A helper method to assist in searching for locale-based resources. Will iterate through the variants of a particular locale, either up or down, executing a callback function. For example, &quot;en-us&quot; and true will try &quot;en-us&quot; followed by &quot;en&quot; and finally &quot;ROOT&quot;. Load built, flattened resource bundles, if available for all locales used in the page. Only called by built layer files. All the properties described in the dojo.__ioArgs type, apply to this type. The following additional properties are allowed for dojo.io.iframe.send(): Creates a hidden iframe in the page. Used mostly for IO transports. You do not need to call this to start a dojo.io.iframe request. Just call send(). The name of the iframe. Used for the name attribute on the iframe. A string of JavaScript that will be executed when the content in the iframe loads. The value of the src attribute on the iframe element. If a value is not given, then dojo/resources/blank.html will be used. Sets the URL that is loaded in an IFrame. The replace parameter indicates whether location.replace() should be used when changing the location of the iframe. Returns the document object associated with the iframe DOM Node argument. function that sends the request to the server. This transport can only process one send() request at a time, so if send() is called multiple times, it will queue up the calls and only process one at a time. Additional I/O transports (Ajax) Internal method used to fire the next request in the bind queue. generic handler for jsonp callback. A pointer to this function is used for all jsonp callbacks. NOTE: the &quot;this&quot; in this function will be the Deferred object that represents the script request. localized formatting and parsing routines for Number Format a Number as a String, using locale-specific settings the number to be formatted. If not a valid JavaScript number, return null. Apply pattern to format value as a string using options. Gives no consideration to local customs. the number to be formatted. a pattern string as described by [unicode.org TR35](http://www.unicode.org/reports/tr35/#Number_Format_Patterns) _applyPattern is usually called via `dojo.number.format()` which populates an extra property in the options parameter, &quot;customs&quot;. The customs object specifies group and decimal parameters if set. Rounds the number at the given number of places the number to round the number of decimal places where rounding takes place rounds next place to nearest multiple Apply numeric pattern to absolute value using options. Gives no consideration to local customs. the number to be formatted, ignores sign the number portion of a pattern (e.g. `#,##0.00`) Builds the regular needed to parse a number Convert a properly formatted string to a primitive Number, using locale-specific settings. A string representation of a Number Builds a regular expression to match a real number in exponential notation Builds a regular expression that matches an integer override [formatting pattern](http://www.unicode.org/reports/tr35/#Number_Format_Patterns) with this string choose a format type based on the locale from the following: decimal, scientific, percent, currency. decimal by default. fixed number of decimal places to show. This overrides any information in the provided pattern. 5 rounds to nearest .5; 0 rounds to nearest whole (default). -1 means don't round. an [ISO4217](http://en.wikipedia.org/wiki/ISO_4217) currency code, a three letter sequence like &quot;USD&quot; localized currency symbol override the locale used to determine formatting rules the decimal separator the group separator number of decimal places. the range &quot;n,m&quot; will format to m places. 5 rounds to nearest .5; 0 rounds to nearest whole (default). -1 means don't round. override pattern with this string. Default is provided based on locale. choose a format type based on the locale from the following: decimal, scientific, percent, currency. decimal by default. override the locale used to determine formatting rules strict parsing, false by default number of decimal places to accept: Infinity, a positive number, or a range &quot;n,m&quot;. Defined by pattern or Infinity if pattern not provided. override pattern with this string. Default is provided based on locale. choose a format type based on the locale from the following: decimal, scientific, percent, currency. decimal by default. override the locale used to determine formatting rules strict parsing, false by default object with currency information The integer number of decimal places or a range given as &quot;n,m&quot;. If not given, the decimal part is optional and the number of places is unlimited. A string for the character used as the decimal point. Default is &quot;.&quot;. Whether decimal places are allowed. Can be true, false, or [true, false]. Default is [true, false] Express in exponential notation. Can be true, false, or [true, false]. Default is [true, false], (i.e. will match if the exponential part is present are not). The leading plus-or-minus sign on the exponent. Can be true, false, or [true, false]. Default is [true, false], (i.e. will match if it is signed or unsigned). flags in regexp.integer can be applied. The leading plus-or-minus sign. Can be true, false, or `[true,false]`. Default is `[true, false]`, (i.e. will match if it is signed or unsigned). The character used as the thousands separator. Default is no separator. For more than one symbol use an array, e.g. `[&quot;,&quot;, &quot;&quot;]`, makes ',' optional. group size between separators second grouping, where separators 2..n have a different interval than the first separator (for India) The Dom/Widget parsing package Takes array of nodes, and turns them into class instances and potentially calls a layout method to allow them to connect with any children Search specified node (or root node) recursively for class instances, and instantiate them Searches for dojoType=&quot;qualified.class.name&quot; Creates a reference to anonFuncPtr in thisObj with a completely unique name. The new name is returned as a String. Regular expressions and Builder resources Adds escape sequences for special characters in regular expressions a String with special characters to be left unescaped Builds a regular expression that groups subexpressions A single value or an array of values. A function. Takes one parameter and converts it to a regular expression. If true, uses non-capturing match, otherwise matches are retained by regular expression. Defaults to false adds group match to expression If true, uses non-capturing match, otherwise matches are retained by regular expression. Scroll the passed node into view, if it is not. Stub to be replaced dijit.robot. Scroll the passed node into view, if it is not. The id of the node, or the node itself, to move the mouse to. If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes. This is useful if you need to move the mouse to an node that is not yet present. Delay in milliseconds, to wait before firing. The delay is a delta with respect to the previous automation call. Moves the mouse over the specified node at the specified relative x,y offset. The id of the node, or the node itself, to move the mouse to. If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes. This is useful if you need to move the mouse to an node that is not yet present. Delay in milliseconds, to wait before firing. The delay is a delta with respect to the previous automation call. For example, the following code ends after 600ms: doh.mouseClick({left:true}, 100) // first call; wait 100ms doh.typeKeys(&quot;dij&quot;, 500) // 500ms AFTER previous call; 600ms in all Approximate time Robot will spend moving the mouse The default is 100ms. x offset relative to the node, in pixels, to move the mouse. The default is half the node's width. y offset relative to the node, in pixels, to move the mouse. The default is half the node's height. Opens the application at the specified URL for testing, redirecting dojo to point to the application environment instead of the test environment. URL to open. Any of the test's dojo.doc calls (e.g. dojo.byId()), and any dijit.registry calls (e.g. dijit.byId()) will point to elements and widgets inside this application. Notifies DOH that the doh.robot is about to make a page change in the application it is driving, returning a doh.Deferred object the user should return in their runTest function as part of a DOH test. The doh.robot will execute the actions the test passes into the submitActions argument (like clicking the submit button), expecting these actions to create a page change (like a form submit). After these actions execute and the resulting page loads, the next test will start. Dojo remote-procedure-call resources call an arbitrary remote method without requiring it to be predefined with SMD the name of the remote method you want to call. of parameters to pass to method JSON-RPC bind method. Takes remote method, parameters, deferred, and a url, calls createRequest to make a JSON-RPC envelope and passes that off with bind. The name of the method we are calling The parameters we are passing off to the method The Deferred object for this particular request create a JSON-RPC envelope for the request The name of the method we are creating the requst for The array of parameters for this request; parse the result envelope and pass the results back to the callback function Object Object containing envelope of data we recieve from the server Generic JSONP service. Minimally extends RpcService to allow easy definition of nearly any JSONP style service. Example SMD files exist in dojox.data JSONP bind method. Takes remote method, parameters, deferred, and a url, calls createRequest to make a JSON-RPC envelope and passes that off with bind. The name of the method we are calling The parameters we are passing off to the method The Deferred object for this particular request create a JSONP req params: array The array of parameters for this request; Take a string as a url to retrieve an smd or an object that is an smd or partial smd to use as a definition for the service parse the results coming back from an rpc request. this base implementation, just returns the full object subclasses should parse and only return the actual results Object Object that is the return results from an rpc request create callback that calls the Deferres errback method Deferred The deferred object handling a request. create callback that calls the Deferred's callback method Deferred The deferred object handling a request. generate the local bind methods for the remote object The name of the method we are generating the array of parameters for this call. the service url for this call callback method for reciept of a smd object. Parse the smd and generate functions based on the description object defining this service. String utilities for Dojo Efficiently replicate a string `n` times. the string to replicate number of times to replicate the string Pad a string to guarantee that it is at least `size` length by filling with the character `ch` at either the start or end of the string. Pads at the start, by default. the string to pad length to provide padding character to pad, defaults to '0' adds padding at the end if true, otherwise pads at start // Fill the string to length 10 with "+" characters on the right. Yields "Dojo++++++". dojo.string.pad("Dojo", 10, "+", true); Performs parameterized substitutions on a string. Throws an exception if any parameter is unmatched. a string with expressions in the form `${key}` to be replaced or `${key:format}` which specifies a format function. hash to search for substitutions a function to process all parameters before substitution takes place, e.g. dojo.string.encodeXML where to look for optional format function; default to the global namespace // returns "File 'foo.html' is not found in directory '/temp'." dojo.string.substitute( "File '${0}' is not found in directory '${1}'.", ["foo.html","/temp"] ); // also returns "File 'foo.html' is not found in directory '/temp'." dojo.string.substitute( "File '${name}' is not found in directory '${info.dir}'.", { name: "foo.html", info: { dir: "/temp" } } ); trims whitespaces from both sides of the string