This plugin provides dropdown color pickers for setting text color and background color
The commands provided by this plugin are:
| Parameter | Type | Description |
|---|---|---|
| args | Object |
Optional Initial settings for any of the attributes. |
See the dijit/_editor/plugins/TextColor reference documentation for more information.
Pointer to dijit/form/Button or other widget (ex: dijit/form/FilteringSelect)
that is added to the toolbar to control this plugin.
If not specified, will be created on initialization according to buttonClass
The color picker dijit to use, defaults to dijit/ColorPalette
String like "insertUnorderedList", "outdent", "justifyCenter", etc. that represents an editor command.
Passed to editor.execCommand() if useDefaultCommand is true.
Flag to indicate if this plugin has been disabled and should do nothing helps control button state, among other things. Set via the setter api.
The CSS class name for the button node is formed from iconClassPrefix and command
False as we do not use the default editor command/click behavior.
Helper function for get() and set(). Caches attribute name values so we don't do the string ops every time.
| Parameter | Type | Description |
|---|---|---|
| name | undefined |
Helper function to set new value for specified attribute
| Parameter | Type | Description |
|---|---|---|
| name | String | |
| value | anything |
Function to set the plugin state and call updateState to make sure the button is updated appropriately.
| Parameter | Type | Description |
|---|---|---|
| disabled | undefined |
Deprecated. Use this.own() with dojo/on or dojo/aspect.instead.
Make a connect.connect() that is automatically disconnected when this plugin is destroyed.
Similar to dijit/_Widget.connect().
| Parameter | Type | Description |
|---|---|---|
| o | undefined | |
| f | undefined | |
| tf | undefined |
Get a property from a plugin.
Get a named property from a plugin. The property may potentially be retrieved via a getter method. If no getter is defined, this just retrieves the object's property. For example, if the plugin has a properties "foo" and "bar" and a method named "_getFooAttr", calling:
plugin.get("foo");
would be equivalent to writing:
plugin._getFooAttr();
and:
plugin.get("bar");
would be equivalent to writing:
plugin.bar;
| Parameter | Type | Description |
|---|---|---|
| name | undefined | The property to get. |
Returns the label to use for the button
| Parameter | Type | Description |
|---|---|---|
| key | String |
Track specified handles and remove/destroy them when this instance is destroyed, unless they were already removed/destroyed manually.
The array of specified handles, so you can do for example:
var handle = this.own(on(...))[0];
Set a property on a plugin
Sets named properties on a plugin which may potentially be handled by a setter in the plugin. For example, if the plugin has a properties "foo" and "bar" and a method named "_setFooAttr", calling:
plugin.set("foo", "Howdy!");
would be equivalent to writing:
plugin._setFooAttr("Howdy!");
and:
plugin.set("bar", 3);
would be equivalent to writing:
plugin.bar = 3;
set() may also be called with a hash of name/value pairs, ex:
plugin.set({
foo: "Howdy",
bar: 3
})
This is equivalent to calling set(foo, "Howdy") and set(bar, 3)
| Parameter | Type | Description |
|---|---|---|
| name | attribute | The property to set. |
| value | anything | The value to set in the property. |
Set a property on a plugin
Tell the plugin which Editor it is associated with.
| Parameter | Type | Description |
|---|---|---|
| editor | dijit/Editor |
Tell the plugin to add it's controller widget (often a button) to the toolbar. Does nothing if there is no controller widget.
| Parameter | Type | Description |
|---|---|---|
| toolbar | dijit/Toolbar |
Overrides _Plugin.updateState(). This updates the ColorPalette to show the color of the currently selected text.