A collection of Plugins for inserting and modifying tables in the Editor See end of this document for all available plugs and dojox/editorPlugins/tests/editorTablePlugs.html for an example
NOT IMPLEMENTED: Not handling cell merge, span or split
Parameter | Type | Description |
---|---|---|
args | Object |
Optional Initial settings for any of the attributes. |
See the dojox/editor/plugins/TablePlugins 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
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.
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 |
Parameter | Type | Description |
---|---|---|
str | 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 |
Gets the selected cells from the passed table.
array of TDs or empty array
Gets the table in focus Collects info on the table - see return params
Parameter | Type | Description |
---|---|---|
forceNewData | undefined |
After changing column amount, change widths to keep columns even
Where each plugin performs its action. Note: not using execCommand. In spite of their presence in the Editor as query-able plugins, I was not able to find any evidence that they are supported (especially in NOT IE). If they are supported in other browsers, it may help with the undo problem.
Parameter | Type | Description |
---|---|---|
cmd | undefined | |
args | undefined |
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
Parameter | Type | Description |
---|---|---|
editor | undefined |
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 |
Over-ride for button state control for disabled to work.
subscribed to from the global object's publish method
Parameter | Type | Description |
---|---|---|
withinTable | undefined |