dojox/editor/plugins/Save (version 1.10)

dijit/_editor/_Plugin

Summary

This plugin provides Save capability to the editor. When clicked, the document in the editor frame will be posted to the URL provided, or none, if none provided. Users who desire a different save function can extend this plugin (via dojo.extend) and over-ride the save method while save is in process, the save button is disabled.

Usage

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

Initial settings for any of the attributes.

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

Property Summary

  • 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.
  • 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
  • iconClassPrefixThe CSS class name for the button node is formed from iconClassPrefix and command
  • logResultsBoolean flag to indicate that the default action for save and error handlers is to just log to console.
  • urlThe URL to POST the content back to.
  • useDefaultCommandIf true, this plugin executes by calling Editor.execCommand() with the argument specified in command.

Method Summary

  • _getAttrNames(name) Helper function for get() and set().
  • _initButton() Over-ride for creation of the save button.
  • _save() Function to trigger saving of the editor document
  • _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.
  • buttonClass() Class of widget (ex: dijit.form.Button or dijit/form/FilteringSelect) that is added to the toolbar to control this plugin.
  • connect(o,f,tf) Deprecated.
  • destroy()
  • get(name) Get a property from a plugin.
  • getLabel(key) Returns the label to use for the button
  • own() Track specified handles and remove/destroy them when this instance is destroyed, unless they were already removed/destroyed manually.
  • save(content) User over-ridable save function for the editor content.
  • set(name,value) Set a property on a plugin
  • setEditor(editor) Over-ride for the setting of the 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

  • onError(error,ioargs) User over-ridable save success function for editor content.
  • onSuccess(resp,ioargs) User over-ridable save success function for editor content.

Properties

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.

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

The CSS class name for the button node is formed from iconClassPrefix and command

logResults

Boolean flag to indicate that the default action for save and error handlers is to just log to console. Default is true.

url

The URL to POST the content back to. Used by the save function.

useDefaultCommand
Defined by: dijit/_editor/_Plugin

If true, this plugin executes by calling Editor.execCommand() with the argument specified in command.

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

Over-ride for creation of the save button.

_save()

Function to trigger saving of the editor document

_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
buttonClass()

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.

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()
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
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];
save(content)

User over-ridable save function for the editor content. Please note that the service URL provided should do content filtering of the posted content to avoid XSS injection via the data from the editor.

Parameter Type Description
content undefined
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)

Over-ride for the setting of the editor.

Parameter Type Description
editor Object

The editor to configure for this plugin to use.

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

onError(error,ioargs)

User over-ridable save success function for editor content. Be sure to call this.inherited(arguments) if over-riding this method.

Parameter Type Description
error undefined
ioargs undefined
onSuccess(resp,ioargs)

User over-ridable save success function for editor content. Be sure to call this.inherited(arguments) if over-riding this method.

Parameter Type Description
resp undefined

The response from the server, if any, in text format.

ioargs undefined
Error in the documentation? Can’t find what you are looking for? Let us know!