dijit/form/TextBox.js

• Provides:

  • dijit.form.TextBox

• Requires:

  • dijit.form._FormWidget in common

• dijit.form.TextBox

  • type

    Function

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

    A base class for textbox form inputs

• dijit.form.TextBox.trim

  • type

    Boolean

  • summary

    Removes leading and trailing whitespace if true.  Default is false.

• dijit.form.TextBox.uppercase

  • type

    Boolean

  • summary

    Converts all characters to uppercase if true.  Default is false.

• dijit.form.TextBox.lowercase

  • type

    Boolean

  • summary

    Converts all characters to lowercase if true.  Default is false.

• dijit.form.TextBox.propercase

  • type

    Boolean

  • summary

    Converts the first character of each word to uppercase if true.

• dijit.form.TextBox.maxLength

  • type

    String

  • summary

    HTML INPUT tag maxLength declaration.

• dijit.form.TextBox.selectOnClick

  • tags: const
  • type

    Boolean

  • summary

    If true, all text will be selected when focused with mouse

• dijit.form.TextBox.placeHolder

  • type

    String

  • summary

    Defines a hint to help users fill out the input field (as defined in HTML 5).
    This should only contain plain text (no html markup).
    
    
    allows IE to disallow focus, but Firefox cannot be disabled for mousedown events

• dijit.form.TextBox.templateString

  • type

    Object

• dijit.form.TextBox._singleNodeTemplate

  • type

    String

• dijit.form.TextBox._buttonInputDisabled

• dijit.form.TextBox.baseClass

  • type

    String

• dijit.form.TextBox.attributeMap

  • type

    Object

• dijit.form.TextBox.postMixInProperties

  • type

    Function

• dijit.form.TextBox._setPlaceHolderAttr

  • parameters:
    • v
  • type

    Function

• dijit.form.TextBox._phspan

  • type

    Object

• dijit.form.TextBox._phspan.innerHTML

  • type

    String

• dijit.form.TextBox._updatePlaceHolder

  • type

    Function

• dijit.form.TextBox._phspan.style.display

• dijit.form.TextBox._getValueAttr

  • summary

    Hook so get('value') works as we like.

  • description

    For `dijit.form.TextBox` this basically returns the value of the <input>.
    
    For `dijit.form.MappedTextBox` subclasses, which have both
    a "displayed value" and a separate "submit value",
    This treats the "displayed value" as the master value, computing the
    submit value from it via this.parse().

  • type

    Function

• dijit.form.TextBox._setValueAttr

  • parameters:
    • value: (typeof The)

      visual element value is also set to a corresponding,
      but not necessarily the same, value.

    • priorityChange: (typeof Boolean)

      If true, an onChange event is fired immediately instead of
      waiting for the next blur event.

    • formattedValue: (typeof String)

      If specified, used to set the visual element value,
      otherwise a computed visual value is used.

  • summary

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

  • description

    Sets the value of the widget to "value" which can be of
    any type as determined by the widget.

  • type

    Function

• dijit.form.TextBox.textbox.value

  • type

    String

• dijit.form.TextBox.displayedValue

  • type

    String

  • summary

    For subclasses like ComboBox where the displayed value
    (ex: Kentucky) and the serialized value (ex: KY) are different,
    this represents the displayed value.
    
    Setting 'displayedValue' through set('displayedValue', ...)
    updates 'value', and vice-versa.  Otherwise 'value' is updated
    from 'displayedValue' periodically, like onBlur etc.
    
    TODO: move declaration to MappedTextBox?
    Problem is that ComboBox references displayedValue,
    for benefit of FilteringSelect.
    
    
    if the textbox is blank, what value should be reported

• dijit.form.TextBox.getDisplayedValue

  • summary

    Deprecated.  Use get('displayedValue') instead.

  • tags:
  • type

    Function

• dijit.form.TextBox._getDisplayedValueAttr

  • summary

    Hook so get('displayedValue') works.

  • description

    Returns the displayed value (what the user sees on the screen),
    after filtering (ie, trimming spaces etc.).
    
    For some subclasses of TextBox (like ComboBox), the displayed value
    is different from the serialized value that's actually
    sent to the server (see dijit.form.ValidationTextBox.serialize)

  • type

    Function

• dijit.form.TextBox.setDisplayedValue

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

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

  • tags:
  • type

    Function

• dijit.form.TextBox._setDisplayedValueAttr

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

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

  • description

    Sets the value of the visual element to the string "value".
    The widget value is also set to a corresponding,
    but not necessarily the same, value.

  • type

    Function

• dijit.form.TextBox.format

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

    Replacable function to convert a value to a properly formatted string.

  • tags: extension
  • type

    Function

• dijit.form.TextBox.parse

  • parameters:
    • value: (typeof String)
    • constraints: (typeof Object)
  • returns

    String

  • summary

    Replacable function to convert a formatted string to a value

  • tags: extension
  • type

    Function

• dijit.form.TextBox._refreshState

  • summary

    After the user types some characters, etc., this method is
    called to check the field for validity etc.  The base method
    in <code>dijit.form.TextBox</code> does nothing, but subclasses override.

  • tags:
  • type

    Function

• dijit.form.TextBox._onInput

  • parameters:
    • e
  • type

    Function

• dijit.form.TextBox.postCreate

  • type

    Function

• dijit.form.TextBox._blankValue

  • type

    String

• dijit.form.TextBox.filter

  • parameters:
    • val
  • summary

    Auto-corrections (such as trimming) that are applied to textbox
    value on blur or form submit.

  • description

    For MappedTextBox subclasses, this is called twice
    - once with the display value
    - once the value as set/returned by set('value', ...)
    and get('value'), ex: a Number for NumberTextBox.
    
    In the latter case it does corrections like converting null to NaN.  In
    the former case the NumberTextBox.filter() method calls this.inherited()
    to execute standard trimming code in TextBox.filter().
    
    TODO: break this into two methods in 2.0

  • tags: extension
  • type

    Function

• dijit.form.TextBox._setBlurValue

  • type

    Function

• dijit.form.TextBox._onBlur

  • parameters:
    • e
  • type

    Function

• dijit.form.TextBox.textbox.selectionStart

  • type

    Object

• dijit.form.TextBox.textbox.selectionEnd

  • type

    Object

• dijit.form.TextBox._onFocus

  • parameters:
    • by: (typeof String)
  • type

    Function

• dijit.form.TextBox._selectOnClickHandle

  • type

    Object

• dijit.form.TextBox.reset

  • type

    Function

• dijit.selectInputText

  • parameters:
    • element: (typeof DomNode)
    • start: (typeof Number)
    • stop: (typeof Number)
  • summary

    Select text in the input element argument, from start (default 0), to stop (default end).

  • type

    Function

• dojo.global

  • alias - dojo.global

• dojo.doc

  • alias - dojo.doc

• dijit.form

  • type

    Object

• dijit

  • type

    Object