Base class for a "plugin" to the editor, which is usually a single button on the Toolbar and some associated code
| Parameter | Type | Description |
|---|---|---|
| args | Object |
Optional Initial settings for any of the attributes. |
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
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
If true, this plugin executes by calling Editor.execCommand() with the argument specified in command.
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 |
Initialize the button or other widget that will control this plugin. This code only works for plugins controlling built-in commands in the editor.
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 |
Class of widget (ex: dijit.form.Button or dijit/form/FilteringSelect)
that is added to the toolbar to control this plugin.
This is used to instantiate the button, unless button itself is specified directly.
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 |
Change state of the plugin to respond to events in the editor.
This is called on meaningful events in the editor, such as change of selection or caret position (but not simple typing of alphanumeric keys). It gives the plugin a chance to update the CSS of its button.
For example, the "bold" plugin will highlight/unhighlight the bold button depending on whether the characters next to the caret are bold or not.
Only makes sense when useDefaultCommand is true, as it calls Editor.queryCommandEnabled(command).