dojox/editor/plugins/AutoSave.js

• Provides:

  • dojox.editor.plugins.AutoSave

• Requires:

  • dojo.string in common
  • dojo.date.locale in common
  • dijit.Dialog in common
  • dijit.MenuItem in common
  • dijit.form.Button in common
  • dijit.form.ComboBox in common
  • dijit.form.TextBox in common
  • dijit.TooltipDialog in common
  • dijit._editor._Plugin in common
  • dijit.form.Button in common
  • dojo.i18n in common
  • dojox.editor.plugins.Save in common

• dojox.editor.plugins._AutoSaveSettingDialog

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)

• dojox.editor.plugins._AutoSaveSettingDialog.dialogTitle

  • type

    String

• dojox.editor.plugins._AutoSaveSettingDialog.dialogDescription

  • type

    String

• dojox.editor.plugins._AutoSaveSettingDialog.paramName

  • type

    String

• dojox.editor.plugins._AutoSaveSettingDialog.paramLabel

  • type

    String

• dojox.editor.plugins._AutoSaveSettingDialog.btnOk

  • type

    String

• dojox.editor.plugins._AutoSaveSettingDialog.btnCancel

  • type

    String

• dojox.editor.plugins._AutoSaveSettingDialog.widgetsInTemplate

  • type

    Object

• dojox.editor.plugins._AutoSaveSettingDialog.templateString

  • type

    String

• dojox.editor.plugins._AutoSaveSettingDialog.postMixInProperties

  • type

    Function

• dojox.editor.plugins._AutoSaveSettingDialog.id

  • type

    Object

• dojox.editor.plugins._AutoSaveSettingDialog.dialogId

  • type

    String

• dojox.editor.plugins._AutoSaveSettingDialog.textBoxId

  • type

    String

• dojox.editor.plugins._AutoSaveSettingDialog.show

  • summary

    Display the setting dialog. If the internal interval value is ""
    set it to zero

  • tags: public
  • type

    Function

• dojox.editor.plugins._AutoSaveSettingDialog._value

  • type

    Number

• dojox.editor.plugins._AutoSaveSettingDialog.hide

  • tags: public
  • type

    Function

• dojox.editor.plugins._AutoSaveSettingDialog.onOk

  • summary

    Handle the OK event and close the dialog.

  • tags: public
  • type

    Function

• dojox.editor.plugins._AutoSaveSettingDialog.onCancel

  • summary

    Handle the Cancel event and close the dialog.

  • tags: public
  • type

    Function

• dojox.editor.plugins._AutoSaveSettingDialog._onKeyDown

  • parameters:
    • evt
  • summary

    Handle the keydown event

  • tags:
  • type

    Function

• dojox.editor.plugins._AutoSaveSettingDialog._onChange

  • parameters:
    • val: (typeof String)
  • summary

    Check if the value is between 1 - 999.

  • tags: public
  • type

    Function

• dojox.editor.plugins._AutoSaveSettingDialog._setValueAttr

  • parameters:
    • val: (typeof String)

      The invertal value

  • summary

    Set the value attribute if it is acceptable

  • tags:
  • type

    Function

• dojox.editor.plugins._AutoSaveSettingDialog._getValueAttr

  • summary

    Get the interval value

  • tags:
  • type

    Function

• dojox.editor.plugins._AutoSaveSettingDialog._isValidValue

  • parameters:
    • val: (typeof String)
  • summary

    Check if this value between 1- 999

  • tags:
  • type

    Function

• dojox.editor.plugins.AutoSave

  • type

    Function

  • chains:
    • dojox.editor.plugins.Save: (prototype)
    • dojox.editor.plugins.Save: (call)
  • summary

    This plugin provides the auto save capability to the editor. The
    plugin saves the content of the editor in interval. When
    the save action is performed, the document in the editor frame
    will be posted to the URL provided, or none, if none provided.

• dojox.editor.plugins.AutoSave.url

  • type

    String

• dojox.editor.plugins.AutoSave.logResults

  • type

    Object

• dojox.editor.plugins.AutoSave.interval

  • type

    Number

• dojox.editor.plugins.AutoSave._iconClassPrefix

  • type

    String

• dojox.editor.plugins.AutoSave._MIN

  • type

    Number

• dojox.editor.plugins.AutoSave._setIntervalAttr

  • parameters:
    • val: (typeof The)

      interval value.

  • summary

    Set the interval value.
    Delay the boundary check to _isValidValue of the dialog class

  • tags:
  • type

    Function

• dojox.editor.plugins.AutoSave._getIntervalAttr

  • summary

    Get the interval value

  • tags:
  • type

    Function

• dojox.editor.plugins.AutoSave.setEditor

  • parameters:
    • editor: (typeof Object)

      The editor to configure for this plugin to use.

  • summary

    Over-ride for the setting of the editor. No toggle button for
    this plugin. And start to save the content of the editor in
    interval

  • type

    Function

• dojox.editor.plugins.AutoSave.editor

• dojox.editor.plugins.AutoSave._strings

  • type

    Object

• dojox.editor.plugins.AutoSave._saveSettingDialog

  • type

    Object

• dojox.editor.plugins.AutoSave._promDialog

  • type

    Object

• dojox.editor.plugins.AutoSave.setEditor.editor

  • type

    Object

  • summary

    The editor to configure for this plugin to use.

• dojox.editor.plugins.AutoSave._initButton

  • type

    Function

• dojox.editor.plugins.AutoSave._menuItemAutoSave

  • type

    Object

• dojox.editor.plugins.AutoSave.button

  • type

    Object

• dojox.editor.plugins.AutoSave._menuItemAutoSaveClickHandler

  • type

    Object

• dojox.editor.plugins.AutoSave._showAutSaveSettingDialog

  • summary

    Show the setting dialog

  • tags:
  • type

    Function

• dojox.editor.plugins.AutoSave._onDialogOk

  • summary

    If the interval is set (larger than 0), enable auto-save.

  • tags:
  • type

    Function

• dojox.editor.plugins.AutoSave._onStopClick

  • summary

    Stop auto-save

  • tags:
  • type

    Function

• dojox.editor.plugins.AutoSave._setSaveInterval

  • parameters:
    • interval: (typeof Number)
  • summary

    Function to trigger saving of the editor document

  • tags:
  • type

    Function

• dojox.editor.plugins.AutoSave._intervalHandler

  • type

    Object

• dojox.editor.plugins.AutoSave._clearSaveInterval

  • type

    Function

• dojox.editor.plugins.AutoSave.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.

  • tags: public
  • type

    Function

• dojox.editor.plugins.AutoSave._promDialogTimeout

  • type

    Object

• dojox.editor.plugins.AutoSave._isWorking

  • type

    bool

• dojox.editor.plugins.AutoSave.onError

  • parameters:
    • error
    • ioargs
  • summary

    User over-ridable save success function for editor content.
    resp:
    The response from the server, if any, in text format.

  • tags: public
  • type

    Function

• dojox.editor.plugins.AutoSave.destroy

  • summary

    Cleanup of our plugin.

  • type

    Function

• dojox.editor.plugins.AutoSave._destroyRecursive

  • type

    Object

• dojox.editor.plugins

  • type

    Object

• dojox.editor

  • type

    Object

• dojox

  • type

    Object