dojox/editor/plugins/TablePlugins (version 1.10)

dijit/_editor/_Plugin

Summary

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

Usage

var foo = new TablePlugins(args);
dijit/_editor/_Plugin
Parameter Type Description
args Object
Optional

Initial settings for any of the attributes.

See the dojox/editor/plugins/TablePlugins reference documentation for more information.

Property Summary

  • alwaysAvailable
  • buttonPointer to dijit/form/Button or other widget (ex: dijit/form/FilteringSelect) that is added to the toolbar to control this plugin.
  • commandString like "insertUnorderedList", "outdent", "justifyCenter", etc. that represents an editor command.
  • commandName
  • disabledFlag to indicate if this plugin has been disabled and should do nothing helps control button state, among other things.
  • editorPoints to the parent editor
  • iconClassPrefix
  • label
  • undoEnabled
  • useDefaultCommand

Method Summary

  • _getAttrNames(name) Helper function for get() and set().
  • _initButton()
  • _makeTitle(str)
  • _set(name,value) Helper function to set new value for specified attribute
  • _setDisabledAttr(disabled) Function to set the plugin state and call updateState to make sure the button is updated appropriately.
  • begEdit()
  • buttonClass()
  • connect(o,f,tf) Deprecated.
  • destroy() Over-ridden destroy to do some cleanup.
  • endEdit()
  • get(name) Get a property from a plugin.
  • getLabel(key) Returns the label to use for the button
  • getSelectedCells() Gets the selected cells from the passed table.
  • getTableInfo(forceNewData) Gets the table in focus Collects info on the table - see return params
  • makeColumnsEven() After changing column amount, change widths to keep columns even
  • modTable(cmd,args) Where each plugin performs its action.
  • own() Track specified handles and remove/destroy them when this instance is destroyed, unless they were already removed/destroyed manually.
  • selectTable()
  • set(name,value) Set a property on a plugin
  • setEditor(editor)
  • setToolbar(toolbar) Tell the plugin to add it's controller widget (often a button) to the toolbar.
  • updateState() Over-ride for button state control for disabled to work.

Event Summary

Properties

alwaysAvailable
button
Defined by: dijit/_editor/_Plugin

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

command
Defined by: dijit/_editor/_Plugin

String like "insertUnorderedList", "outdent", "justifyCenter", etc. that represents an editor command. Passed to editor.execCommand() if useDefaultCommand is true.

commandName
disabled
Defined by: dijit/_editor/_Plugin

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.

editor
Defined by: dijit/_editor/_Plugin

Points to the parent editor

iconClassPrefix
undoEnabled
useDefaultCommand

Methods

_getAttrNames(name)

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
Returns:undefined | object
_initButton()
_makeTitle(str)
Parameter Type Description
str undefined
Returns:undefined
_set(name,value)

Helper function to set new value for specified attribute

Parameter Type Description
name String
value anything
_setDisabledAttr(disabled)

Function to set the plugin state and call updateState to make sure the button is updated appropriately.

Parameter Type Description
disabled undefined
begEdit()
buttonClass()
connect(o,f,tf)

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
destroy()

Over-ridden destroy to do some cleanup.

endEdit()
get(name)

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:undefined
getLabel(key)

Returns the label to use for the button

Parameter Type Description
key String
Returns:undefined
getSelectedCells()

Gets the selected cells from the passed table.

Returns:any | Array

array of TDs or empty array

getTableInfo(forceNewData)

Gets the table in focus Collects info on the table - see return params

Parameter Type Description
forceNewData undefined
Returns:undefined
makeColumnsEven()

After changing column amount, change widths to keep columns even

modTable(cmd,args)

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
own()
Defined by dijit/Destroyable

Track specified handles and remove/destroy them when this instance is destroyed, unless they were already removed/destroyed manually.

Returns:any | undefined

The array of specified handles, so you can do for example:

var handle = this.own(on(...))[0];
selectTable()
set(name,value)

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.

Returns:function | string

Set a property on a plugin

setEditor(editor)
Parameter Type Description
editor undefined
setToolbar(toolbar)

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
updateState()

Over-ride for button state control for disabled to work.

Events

onDisplayChanged(withinTable)

subscribed to from the global object's publish method

Parameter Type Description
withinTable undefined
onEditorLoaded()
Error in the documentation? Can’t find what you are looking for? Let us know!