Constructordijit.ColorPalette

dojo.require("dijit.ColorPalette");
defined in dijit/ColorPalette.js

Grid showing various colors, so the user can pick a certain color Can be used standalone, or as a popup.

Usage

function ()
parametertypedescription
paramsObjectOptional.
srcNodeRefDomNode|String 

Examples

Example 1


Example 2

var picker = new dijit.ColorPalette({ },srcNode);
picker.startup();

Jump to PropertiesFunctionsBack to top

Construct the UI for this widget from a template, setting this.domNode.
Functionconnect(obj: Object, event: String, method: String|Function)
Defined by dijit._Widget
Connects specified obj/event to specified method of this object and registers for disconnect() on widget destroy. Special event: "ondijitclick" triggers on a click or enter-down or space-up Similar to dojo.connect() but takes three arguments rather than four.
Functioncreate(params: Object?, srcNodeRef: DomNode|String)
Defined by dijit._Widget
Kick off the life-cycle of a widget
Functiondestroy(finalize: Boolean)
Defined by dijit._Widget
Destroy this widget, but not its descendants
Defined by dijit._Widget
Recursively destroy the children of this widget and their descendants.
Defined by dijit._Widget
Destroy this widget and it's descendants. This is the generic "destructor" function that all widget users should call to cleanly discard with a widget. Once a widget is destroyed, it's removed from the manager object.
Defined by dijit._Widget
Destroys the DOM nodes associated with this widget
Functiondisconnect(handles: Object)
Defined by dijit._Widget
Disconnects handle created by this.connect. Also removes handle from this widget's list of connects
Focus this ColorPalette. Puts focus on the first swatch.
Defined by dijit._Widget
Returns all the widgets that contained by this, i.e., all widgets underneath this.containerNode.
Defined by dijit._Widget
Return true if this widget can currently be focused and false if not
Defined by dijit._Widget
Checks the DOM to for the text direction for bi-directional support
Defined by dijit._Widget
stub function. Override or connect to this method to receive notifications for when the widget moves out of focus.
FunctiononChange(color: String)
Callback when a color is selected.
Defined by dijit._Widget
Callback if someone tries to close the child, child will be closed if func returns true
Defined by dijit._Widget
stub function. Override or connect to this method to receive notifications for when the widget moves into focus.
Overrides dijit._Widget
Called after a widget's dom has been setup
Defined by dijit._Widget
Called after the parameters to the widget have been read-in, but before the widget template is instantiated. Especially useful to set properties that are referenced in the widget template.
Functionpostscript(params: Object?, srcNodeRef: DomNode|String)
Defined by dijit._Widget
FunctionsetAttribute(attr: String, value)
Defined by dijit._Widget
Set native HTML attributes reflected in the widget, such as readOnly, disabled, and maxLength in TextBox widgets.
Defined by dijit._Widget
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.
Defined by dijit._Widget
Defined by dijit._Widget
stub function. Override to implement custom widget tear-down behavior.
Function_attachTemplateNodes(rootNode: DomNode, getAttrFunc: Function?)
Defined by dijit._Templated
Iterate through the template and attach functions and nodes accordingly.
Defined by dijit._Templated
relocate source contents to templated container node this.containerNode must be able to receive children, or exceptions will be thrown
Function_navigateByKey(increment, typeCount)
This is the callback for typematic. It changes the focus and the highlighed color.
needed for Firefox 2 on Mac OS X
Handler for click, enter key & space key. Selects the color.
Handler for onFocus. Removes highlight of the color that just lost focus, and highlights the new color.
Handler for onMouseOver. Put focus on the color under the mouse.
Overrides dijit._Widget
Function_selectColor(selectNode)
This selects a color. It triggers the onChange event area: The area node that covers the color being selected.
Defined by dijit._Templated

Jump to FunctionsPropertiesBack to top

Defined by dijit._Widget
A map of attributes and attachpoints -- typically standard HTML attributes -- to set on the widget's dom, at the "domNode" attach point, by default. Other node references can be specified as properties of 'this'
Defined by dijit._Widget
HTML class attribute
Defined by dijit._Templated
holds child elements. "containerNode" is generally set via a dojoAttachPoint assignment and it designates where children of the src dom node will be placed
number of milliseconds before a held key or button becomes typematic
Defined by dijit._Widget
Unsupported by Dijit, but here for completeness. Dijit only supports setting text direction on the entire document. Bi-directional support, as defined by the [HTML DIR](http://www.w3.org/TR/html401/struct/dirlang.html#adef-dir) attribute. Either left-to-right "ltr" or right-to-left "rtl".
this is our visible representation of the widget! Other DOM Nodes may by assigned to other properties, usually through the template system's dojoAttachPonit syntax, but the domNode property is the canonical "top level" node in widget UI.
Defined by dijit._Widget
a unique, opaque ID string that can be assigned by users or by the system. If the developer passes an ID which is known not to be unique, the specified ID is ignored and the system-generated ID is used instead.
Defined by dijit._Widget
Rarely used. Overrides the default Dojo locale used to render this widget, as defined by the [HTML LANG](http://www.w3.org/TR/html401/struct/dirlang.html#adef-lang) attribute. Value must be among the list of locales specified during by the Dojo bootstrap, formatted according to [RFC 3066](http://www.ietf.org/rfc/rfc3066.txt) (like en-us).
Size of grid, either "7x10" or "3x4".
Defined by dijit._Widget
pointer to original dom node
Defined by dijit._Widget
HTML style attribute
Widget tabindex.
Defined by dijit._Templated
a node that represents the widget template. Pre-empts both templateString and templatePath.
Overrides dijit._Templated
Path to the template of this widget.
Defined by dijit._Templated
a string that represents the widget template. Pre-empts the
fraction of time used to change the typematic timer between events 1.0 means that each typematic event fires at defaultTimeout intervals < 1.0 means that each typematic event fires at an increasing faster rate
Defined by dijit._Widget
Defined by dijit._Templated
should we parse the template to find widgets that might be declared in markup inside it? false by default.
Index of the currently focused color.
This is stores the path to the palette images
Defined by dijit._Widget
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.
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 the number of colors horizontally across.
/ This is the number of colors vertically down.