dijit/InlineEditBox.js

• Provides:

  • dijit.InlineEditBox

• Requires:

  • dojo.i18n in common
  • dijit._Widget in common
  • dijit._Container in common
  • dijit.form.Button in common
  • dijit.form.TextBox in common

• dijit.InlineEditBox

  • type

    Function

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

    An element with in-line edit capabilites

  • tags:
  • description

    Behavior for an existing node (`<p>`, `<div>`, `<span>`, etc.) so that
    when you click it, an editor shows up in place of the original
    text.  Optionally, Save and Cancel button are displayed below the edit widget.
    When Save is clicked, the text is pulled from the edit
    widget and redisplayed and the edit widget is again hidden.
    By default a plain Textarea widget is used as the editor (or for
    inline values a TextBox), but you can specify an editor such as
    dijit.Editor (for editing HTML) or a Slider (for adjusting a number).
    An edit widget must support the following API to be used:
    - displayedValue or value as initialization parameter,
    and available through set('displayedValue') / set('value')
    - void focus()
    - DOM-node focusNode = node containing editable text

• dijit.InlineEditBox.editing

  • tags: readonly
  • type

    Boolean

  • summary

    Is the node currently in edit mode?

• dijit.InlineEditBox.autoSave

  • type

    Boolean

  • summary

    Changing the value automatically saves it; don't have to push save button
    (and save button isn't even displayed)

• dijit.InlineEditBox.buttonSave

  • type

    String

  • summary

    Save button label

• dijit.InlineEditBox.buttonCancel

  • type

    String

  • summary

    Cancel button label

• dijit.InlineEditBox.renderAsHtml

  • type

    Boolean

  • summary

    Set this to true if the specified Editor's value should be interpreted as HTML
    rather than plain text (ex: <code>dijit.Editor</code>)

• dijit.InlineEditBox.editor

  • type

    String|Function

  • summary

    Class name (or reference to the Class) for Editor widget

• dijit.InlineEditBox.editorWrapper

  • type

    String|Function

  • summary

    Class name (or reference to the Class) for widget that wraps the editor widget, displaying save/cancel
    buttons.

• dijit.InlineEditBox.editorParams

  • type

    Object

  • summary

    Set of parameters for editor, like {required: true}

• dijit.InlineEditBox.disabled

  • type

    Boolean

  • summary

    If true, clicking the InlineEditBox to edit it will have no effect.

• dijit.InlineEditBox.onChange

  • parameters:
    • value
  • summary

    Set this handler to be notified of changes to value.

  • tags: callback
  • type

    Function

• dijit.InlineEditBox.onCancel

  • summary

    Set this handler to be notified when editing is cancelled.

  • tags: callback
  • type

    Function

• dijit.InlineEditBox.width

  • type

    String

  • summary

    Width of editor.  By default it's width=100% (ie, block mode).

• dijit.InlineEditBox.value

  • type

    String

  • summary

    The display value of the widget in read-only mode

• dijit.InlineEditBox.noValueIndicator

  • tags: const
  • type

    String

  • summary

    The text that gets displayed when there is no value (so that the user has a place to click to edit)

• dijit.InlineEditBox.constructor

  • constructor - constructor
  • type

    Function

  • summary

    Sets up private arrays etc.

  • tags:

• dijit.InlineEditBox.postMixInProperties

  • type

    Function

• dijit.InlineEditBox.displayNode

• dijit.InlineEditBox.displayNode.innerHTML

  • type

    Object

• dijit.InlineEditBox.setDisabled

  • parameters:
    • disabled: (typeof Boolean)
  • summary

    Deprecated.   Use set('disabled', ...) instead.

  • tags:
  • type

    Function

• dijit.InlineEditBox._setDisabledAttr

  • parameters:
    • disabled: (typeof Boolean)
  • summary

    Hook to make set("disabled", ...) work.
    Set disabled state of widget.

  • type

    Function

• dijit.InlineEditBox._onMouseOver

  • summary

    Handler for onmouseover and onfocus event.

  • tags:
  • type

    Function

• dijit.InlineEditBox._onMouseOut

  • summary

    Handler for onmouseout and onblur event.

  • tags:
  • type

    Function

• dijit.InlineEditBox._onClick

  • parameters:
    • e: (typeof Event)
  • summary

    Handler for onclick event.

  • tags:
  • type

    Function

• dijit.InlineEditBox.edit

  • summary

    Display the editor widget in place of the original (read only) markup.

  • tags:
  • type

    Function

• dijit.InlineEditBox._savedPosition

  • type

    Object

• dijit.InlineEditBox._savedOpacity

  • type

    Object

• dijit.InlineEditBox._savedTabIndex

  • type

    Object

• dijit.InlineEditBox.wrapperWidget.editWidget

• dijit.InlineEditBox.wrapperWidget

  • type

    Object

• dijit.InlineEditBox._onBlur

  • summary

    Called when focus moves outside the InlineEditBox.
    Performs garbage collection.

  • tags:
  • type

    Function

• dijit.InlineEditBox.destroy

  • type

    Function

• dijit.InlineEditBox._showText

  • parameters:
    • focus: (typeof Boolean)
  • summary

    Revert to display mode, and optionally focus on display node

  • tags:
  • type

    Function

• dijit.InlineEditBox.save

  • parameters:
    • focus: (typeof Boolean)

      Focus on the display mode text

  • summary

    Save the contents of the editor and revert to display mode.

  • tags:
  • type

    Function

• dijit.InlineEditBox.setValue

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

    Deprecated.   Use set('value', ...) instead.

  • tags:
  • type

    Function

• dijit.InlineEditBox._setValueAttr

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

    Hook to make set("value", ...) work.
    Inserts specified HTML value into this node, or an "input needed" character if node is blank.

  • type

    Function

• dijit.InlineEditBox.getValue

  • summary

    Deprecated.   Use get('value') instead.

  • tags:
  • type

    Function

• dijit.InlineEditBox.cancel

  • parameters:
    • focus: (typeof Boolean)
  • summary

    Revert to display mode, discarding any changes made in the editor

  • tags:
  • type

    Function

• dijit._InlineEditor

  • type

    Function

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

    Internal widget used by InlineEditBox, displayed when in editing mode
    to display the editor and maybe save/cancel buttons.  Calling code should
    connect to save/cancel methods to detect when editing is finished
    
    Has mainly the same parameters as InlineEditBox, plus these values:
    
    style: Object
    Set of CSS attributes of display node, to replicate in editor
    
    value: String
    Value as an HTML string or plain text string, depending on renderAsHTML flag

• dijit._InlineEditor.templateString

  • type

    Object

• dijit._InlineEditor.widgetsInTemplate

  • type

    Object

• dijit._InlineEditor.postMixInProperties

  • type

    Function

• dijit._InlineEditor.messages

  • type

    Object

• dijit._InlineEditor.buildRendering

  • type

    Function

• dijit._InlineEditor.sourceStyle

• dijit._InlineEditor.inlineEditBox.width

• dijit._InlineEditor.domNode.style.display

  • type

    String

• dijit._InlineEditor.editWidget

  • type

    Object

• dijit._InlineEditor.postCreate

  • type

    Function

• dijit._InlineEditor._onIntermediateChange

  • parameters:
    • val
  • summary

    Called for editor widgets that support the intermediateChanges=true flag as a way
    to detect when to enable/disabled the save button

  • type

    Function

• dijit._InlineEditor.destroy

  • type

    Function

• dijit._InlineEditor.getValue

  • summary

    Return the [display] value of the edit widget

  • type

    Function

• dijit._InlineEditor._onKeyPress

  • parameters:
    • e
  • summary

    Handler for keypress in the edit box in autoSave mode.

  • description

    For autoSave widgets, if Esc/Enter, call cancel/save.

  • tags:
  • type

    Function

• dijit._InlineEditor._onBlur

  • summary

    Called when focus moves outside the editor

  • tags:
  • type

    Function

• dijit._InlineEditor._onChange

  • summary

    Called when the underlying widget fires an onChange event,
    such as when the user selects a value from the drop down list of a ComboBox,
    which means that the user has finished entering the value and we should save.

  • tags:
  • type

    Function

• dijit._InlineEditor.enableSave

  • summary

    User overridable function returning a Boolean to indicate
    if the Save button should be enabled or not - usually due to invalid conditions

  • tags: extension
  • type

    Function

• dijit._InlineEditor.focus

  • summary

    Focus the edit widget.

  • tags:
  • type

    Function

• dijit

  • type

    Object