dijit/form/_FormWidget.js

• Provides:

  • dijit.form._FormWidget

• Requires:

  • dojo.window in common
  • dijit._Widget in common
  • dijit._Templated in common
  • dijit._CssStateMixin in common

• dijit.form._FormWidget

  • type

    Function

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

    Base class for widgets corresponding to native HTML elements such as <checkbox> or <button>,
    which can be children of a &lt;form&gt; node or a <code>dijit.form.Form</code> widget.

  • description

    Represents a single HTML element.
    All these widgets should have these attributes just like native HTML input elements.
    You can set them during widget construction or afterwards, via `dijit._Widget.attr`.
    
    They also share some common methods.

• dijit.form._FormWidget.name

  • tags: const
  • type

    String

  • summary

    Name used when submitting form; same as "name" attribute or plain HTML elements

• dijit.form._FormWidget.alt

  • type

    String

  • summary

    Corresponds to the native HTML <input> element's attribute.

• dijit.form._FormWidget.value

  • type

    String

  • summary

    Corresponds to the native HTML <input> element's attribute.

• dijit.form._FormWidget.type

  • type

    String

  • summary

    Corresponds to the native HTML <input> element's attribute.

• dijit.form._FormWidget.tabIndex

  • type

    Integer

  • summary

    Order fields are traversed when user hits the tab key

• dijit.form._FormWidget.disabled

  • type

    Boolean

  • summary

    Should this widget respond to user input?
    In markup, this is specified as "disabled='disabled'", or just "disabled".

• dijit.form._FormWidget.intermediateChanges

  • type

    Boolean

  • summary

    Fires onChange for each value change or only on demand

• dijit.form._FormWidget.scrollOnFocus

  • type

    Boolean

  • summary

    On focus, should this widget scroll into view?

• dijit.form._FormWidget.attributeMap

  • type

    Object

• dijit.form._FormWidget.postMixInProperties

  • type

    Function

• dijit.form._FormWidget.nameAttrSetting

• dijit.form._FormWidget.postCreate

  • type

    Function

• dijit.form._FormWidget._setDisabledAttr

  • parameters:
    • value: (typeof Boolean)
  • type

    Function

• dijit.form._FormWidget.setDisabled

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

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

  • type

    Function

• dijit.form._FormWidget._onFocus

  • parameters:
    • e
  • type

    Function

• dijit.form._FormWidget.isFocusable

  • summary

    Tells if this widget is focusable or not.  Used internally by dijit.

  • tags:
  • type

    Function

• dijit.form._FormWidget.focus

  • summary

    Put focus on this widget

  • type

    Function

• dijit.form._FormWidget.compare

  • parameters:
    • val1: (typeof anything)
    • val2: (typeof anything)
  • summary

    Compare 2 values (as returned by get('value') for this widget).

  • tags:
  • type

    Function

• dijit.form._FormWidget.onChange

  • parameters:
    • newValue
  • summary

    Callback when this widget's value is changed.

  • tags: callback
  • type

    Function

• dijit.form._FormWidget._onChangeActive

  • tags:
  • type

    Boolean

  • summary

    Indicates that changes to the value should call onChange() callback.
    This is false during widget initialization, to avoid calling onChange()
    when the initial value is set.

• dijit.form._FormWidget._handleOnChange

  • parameters:
    • newValue: (typeof anything)

      the new value

    • priorityChange: (typeof Boolean)

      For a slider, for example, dragging the slider is priorityChange==false,
      but on mouse up, it's priorityChange==true.  If intermediateChanges==false,
      onChange is only called form priorityChange=true events.

  • summary

    Called when the value of the widget is set.  Calls onChange() if appropriate

  • tags:
  • type

    Function

• dijit.form._FormWidget._resetValue

• dijit.form._FormWidget._lastValueReported

• dijit.form._FormWidget._pendingOnChange

  • type

    bool

• dijit.form._FormWidget._onChangeHandle

  • type

    Object

• dijit.form._FormWidget.create

  • type

    Function

• dijit.form._FormWidget.destroy

  • type

    Function

• dijit.form._FormWidget.setValue

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

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

  • type

    Function

• dijit.form._FormWidget.getValue

  • summary

    Deprecated.  Use get('value') instead.

  • type

    Function

• dijit.form._FormWidget._onMouseDown

  • parameters:
    • e
  • type

    Function

• dijit.form._FormValueWidget

  • type

    Function

  • chains:
    • dijit.form._FormWidget: (prototype)
    • dijit.form._FormWidget: (call)
  • summary

    Base class for widgets corresponding to native HTML elements such as <input> or <select> that have user changeable values.

  • description

    Each _FormValueWidget represents a single input value, and has a (possibly hidden) <input> element,
    to which it serializes it's input value, so that form submission (either normal submission or via FormBind?)
    works as expected.

• dijit.form._FormValueWidget.readOnly

  • type

    Boolean

  • summary

    Should this widget respond to user input?
    In markup, this is specified as "readOnly".
    Similar to disabled except readOnly form values are submitted.

• dijit.form._FormValueWidget.attributeMap

  • type

    Object

• dijit.form._FormValueWidget._setReadOnlyAttr

  • parameters:
    • value: (typeof Boolean)
  • type

    Function

• dijit.form._FormValueWidget.postCreate

  • type

    Function

• dijit.form._FormValueWidget._lastValueReported

• dijit.form._FormValueWidget._resetValue

• dijit.form._FormValueWidget._setValueAttr

  • parameters:
    • newValue: (typeof anything)
    • priorityChange: (typeof Boolean)
  • summary

    Hook so set('value', value) works.

  • description

    Sets the value of the widget.
    If the value has changed, then fire onChange event, unless priorityChange
    is specified as null (or false?)

  • type

    Function

• dijit.form._FormValueWidget._handleOnChange

  • parameters:
    • newValue: (typeof anything)
    • priorityChange: (typeof Boolean)
  • summary

    Called when the value of the widget has changed.  Saves the new value in this.value,
    and calls onChange() if appropriate.   See _FormWidget._handleOnChange() for details.

  • type

    Function

• dijit.form._FormValueWidget.undo

  • summary

    Restore the value to the last value passed to onChange

  • type

    Function

• dijit.form._FormValueWidget.reset

  • summary

    Reset the widget's value to what it was at initialization time

  • type

    Function

• dijit.form._FormValueWidget._hasBeenBlurred

  • type

    bool

• dijit.form._FormValueWidget._onKeyDown

  • parameters:
    • e
  • type

    Function

• dijit.form._FormValueWidget._layoutHackIE7

  • summary

    Work around table sizing bugs on IE7 by forcing redraw

  • type

    Function

• dijit.form._FormValueWidget.domNode

• dijit.form._FormValueWidget.domNode.firstChild

  • type

    Object

• dijit.form._FormValueWidget.domNode.firstChild.style.filter

• dijit.form

  • type

    Object

• dijit

  • type

    Object