dojox/editor/plugins/Save.js

• Provides:

  • dojox.editor.plugins.Save

• Requires:

  • dijit.form.Button in common
  • dijit._editor._Plugin in common
  • dojo.i18n in common

• dojox.editor.plugins.Save

  • type

    Function

  • chains:
    • dijit._editor._Plugin: (prototype)
    • dijit._editor._Plugin: (call)
  • summary

    This plugin provides Save cabability to the editor.  When
    clicked, the document in the editor frame will be osted 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.

• dojox.editor.plugins.Save.iconClassPrefix

  • tags: const
  • type

    String

  • summary

    The CSS class name for the button node is formed from <code>iconClassPrefix</code>
    and <code>command</code>

• dojox.editor.plugins.Save.url

  • type

    String

• dojox.editor.plugins.Save.logResults

  • type

    Object

• dojox.editor.plugins.Save._initButton

  • summary

    Over-ride for creation of the save button.

  • type

    Function

• dojox.editor.plugins.Save.button

  • type

    Object

• dojox.editor.plugins.Save.updateState

  • summary

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

  • type

    Function

• dojox.editor.plugins.Save.setEditor

  • parameters:
    • editor: (typeof Object)

      The editor to configure for this plugin to use.

  • summary

    Over-ride for the setting of the editor.

  • type

    Function

• dojox.editor.plugins.Save.editor

• dojox.editor.plugins.Save.setEditor.editor

  • type

    Object

  • summary

    The editor to configure for this plugin to use.

• dojox.editor.plugins.Save._save

  • summary

    Function to trigger saving of the editor document

  • tags:
  • type

    Function

• dojox.editor.plugins.Save.save

  • parameters:
    • content
  • summary

    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.

  • tags: public
  • type

    Function

• dojox.editor.plugins.Save.onSuccess

  • parameters:
    • resp: (typeof The)

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

    • ioargs
  • summary

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

  • tags: public
  • type

    Function

• dojox.editor.plugins.Save.onError

  • parameters:
    • error
    • ioargs
  • summary

    User over-ridable save success function for editor content.
    Be sure to call this.inherited(arguments) if over-riding this method.
    resp:
    The response from the server, if any, in text format.

  • tags: public
  • type

    Function

• dojox.editor.plugins

  • type

    Object

• dojox.editor

  • type

    Object

• dojox

  • type

    Object