dijit/form/ValidationTextBox.js

• Provides:

  • dijit.form.ValidationTextBox

• Requires:

  • dojo.i18n in common
  • dijit.form.TextBox in common
  • dijit.Tooltip in common

• dijit.form.ValidationTextBox

  • type

    Function

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

    Base class for textbox widgets with the ability to validate content of various types and provide user feedback.

  • tags:

• dijit.form.ValidationTextBox.templateString

  • type

    Object

• dijit.form.ValidationTextBox.baseClass

  • type

    String

• dijit.form.ValidationTextBox.required

  • type

    Boolean

  • summary

    User is required to enter data into this field.

• dijit.form.ValidationTextBox.promptMessage

  • type

    String

  • summary

    If defined, display this hint string immediately on focus to the textbox, if empty.
    Also displays if the textbox value is Incomplete (not yet valid but will be with additional input).
    Think of this like a tooltip that tells the user what to do, not an error message
    that tells the user what they've done wrong.
    
    Message disappears when user starts typing.

• dijit.form.ValidationTextBox.invalidMessage

  • type

    String

  • summary

    The message to display if value is invalid.
    The translated string value is read from the message file by default.
    Set to "" to use the promptMessage instead.

• dijit.form.ValidationTextBox.missingMessage

  • type

    String

  • summary

    The message to display if value is empty and the field is required.
    The translated string value is read from the message file by default.
    Set to "" to use the invalidMessage instead.

• dijit.form.ValidationTextBox.message

  • type

    String

  • summary

    Currently error/prompt message.
    When using the default tooltip implementation, this will only be
    displayed when the field is focused.

• dijit.form.ValidationTextBox.constraints

  • type

    dijit.form.ValidationTextBox.__Constraints

  • summary

    user-defined object needed to pass parameters to the validator functions

• dijit.form.ValidationTextBox.regExp

  • tags: extension
  • type

    String

  • summary

    regular expression string used to validate the input
    Do not specify both regExp and regExpGen

• dijit.form.ValidationTextBox.regExpGen

  • parameters:
    • constraints: (typeof dijit.form.ValidationTextBox.__Constraints)
  • returns

    String

  • summary

    Overridable function used to generate regExp when dependent on constraints.
    Do not specify both regExp and regExpGen.

  • tags: extension
  • type

    Function

• dijit.form.ValidationTextBox.state

  • tags: readonly
  • type

    String

  • summary

    Shows current state (ie, validation result) of input (""=Normal, Incomplete, or Error)

• dijit.form.ValidationTextBox.tooltipPosition

  • type

    String[]

  • summary

    See description of <code>dijit.Tooltip.defaultPosition</code> for details on this parameter.

• dijit.form.ValidationTextBox._setValueAttr

  • summary

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

  • type

    Function

• dijit.form.ValidationTextBox.validator

  • parameters:
    • value: (typeof anything)
    • constraints: (typeof dijit.form.ValidationTextBox.__Constraints)
  • summary

    Overridable function used to validate the text input against the regular expression.

  • tags:
  • type

    Function

• dijit.form.ValidationTextBox._isValidSubset

  • summary

    Returns true if the value is either already valid or could be made valid by appending characters.
    This is used for validation while the user [may be] still typing.

  • type

    Function

• dijit.form.ValidationTextBox.isValid

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

    Tests if value is valid.
    Can override with your own routine in a subclass.

  • tags:
  • type

    Function

• dijit.form.ValidationTextBox._isEmpty

  • parameters:
    • value
  • returns

    Boolean

  • summary

    Checks for whitespace

  • type

    Function

• dijit.form.ValidationTextBox.getErrorMessage

  • parameters:
    • isFocused: (typeof Boolean)
  • returns

    String

  • summary

    Return an error message to show if appropriate

  • tags:
  • type

    Function

• dijit.form.ValidationTextBox.getPromptMessage

  • parameters:
    • isFocused: (typeof Boolean)
  • returns

    String

  • summary

    Return a hint message to show when widget is first focused

  • tags:
  • type

    Function

• dijit.form.ValidationTextBox._maskValidSubsetError

  • type

    Object

• dijit.form.ValidationTextBox.validate

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

    Called by oninit, onblur, and onkeypress.

  • description

    Show missing or invalid messages if appropriate, and highlight textbox field.

  • tags:
  • type

    Function

• dijit.form.ValidationTextBox.disabled

  • type

    Object

• dijit.form.ValidationTextBox.displayMessage

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

    Overridable method to display validation errors/hints.
    By default uses a tooltip.

  • tags: extension
  • type

    Function

• dijit.form.ValidationTextBox._refreshState

  • type

    Function

• dijit.form.ValidationTextBox.constructor

  • constructor - constructor
  • type

    Function

• dijit.form.ValidationTextBox._setConstraintsAttr

  • parameters:
    • constraints: (typeof Object)
  • type

    Function

• dijit.form.ValidationTextBox._computePartialRE

  • type

    Function

• dijit.form.ValidationTextBox._partialre

  • type

    String

• dijit.form.ValidationTextBox.postMixInProperties

  • type

    Function

• dijit.form.ValidationTextBox.messages

  • type

    Object

• dijit.form.ValidationTextBox._setDisabledAttr

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

    Function

• dijit.form.ValidationTextBox._setRequiredAttr

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

    Function

• dijit.form.ValidationTextBox._setMessageAttr

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

    Function

• dijit.form.ValidationTextBox.reset

  • type

    Function

• dijit.form.ValidationTextBox._onBlur

  • type

    Function

• dijit.form.MappedTextBox

  • type

    Function

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

    A dijit.form.ValidationTextBox subclass which provides a base class for widgets that have
    a visible formatted display value, and a serializable
    value in a hidden input field which is actually sent to the server.

  • description

    The visible display may
    be locale-dependent and interactive.  The value sent to the server is stored in a hidden
    input field which uses the `name` attribute declared by the original widget.  That value sent
    to the server is defined by the dijit.form.MappedTextBox.serialize method and is typically
    locale-neutral.

  • tags:

• dijit.form.MappedTextBox.postMixInProperties

  • type

    Function

• dijit.form.MappedTextBox.nameAttrSetting

  • type

    String

• dijit.form.MappedTextBox.serialize

  • parameters:
    • val: (typeof anything)
    • options: (typeof Object)
  • returns

    String

  • summary

    Overridable function used to convert the get('value') result to a canonical
    (non-localized) string.  For example, will print dates in ISO format, and
    numbers the same way as they are represented in javascript.

  • tags: extension
  • type

    Function

• dijit.form.MappedTextBox.toString

  • returns

    String

  • summary

    Returns widget as a printable string using the widget's value

  • tags:
  • type

    Function

• dijit.form.MappedTextBox.validate

  • type

    Function

• dijit.form.MappedTextBox.valueNode.value

  • type

    String

• dijit.form.MappedTextBox.buildRendering

  • type

    Function

• dijit.form.MappedTextBox.valueNode

  • type

    Object

• dijit.form.MappedTextBox.reset

  • type

    Function

• dijit.form.RangeBoundTextBox

  • type

    Function

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

    Base class for textbox form widgets which defines a range of valid values.

• dijit.form.RangeBoundTextBox.rangeMessage

  • type

    String

  • summary

    The message to display if value is out-of-range

• dijit.form.RangeBoundTextBox.constraints

  • type

    dijit.form.RangeBoundTextBox.__Constraints

• dijit.form.RangeBoundTextBox.rangeCheck

  • parameters:
    • primitive: (typeof Number)
    • constraints: (typeof dijit.form.RangeBoundTextBox.__Constraints)
  • summary

    Overridable function used to validate the range of the numeric input value.

  • tags:
  • type

    Function

• dijit.form.RangeBoundTextBox.isInRange

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

    Tests if the value is in the min/max range specified in constraints

  • tags:
  • type

    Function

• dijit.form.RangeBoundTextBox._isDefinitelyOutOfRange

  • summary

    Returns true if the value is out of range and will remain
    out of range even if the user types more characters

  • type

    Function

• dijit.form.RangeBoundTextBox._isValidSubset

  • summary

    Overrides <code>dijit.form.ValidationTextBox._isValidSubset</code>.
    Returns true if the input is syntactically valid, and either within
    range or could be made in range by more typing.

  • type

    Function

• dijit.form.RangeBoundTextBox.isValid

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

    Function

• dijit.form.RangeBoundTextBox.getErrorMessage

  • parameters:
    • isFocused: (typeof Boolean)
  • returns

    String

  • type

    Function

• dijit.form.RangeBoundTextBox.postMixInProperties

  • type

    Function

• dijit.form.RangeBoundTextBox.messages

  • type

    Object

• dijit.form.RangeBoundTextBox._setConstraintsAttr

  • parameters:
    • constraints: (typeof Object)
  • type

    Function

• dijit.form.RangeBoundTextBox._setValueAttr

  • parameters:
    • value: (typeof Number)
    • priorityChange: (typeof Boolean)
  • summary

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

  • type

    Function

• dijit.form.ValidationTextBox.__Constraints

  • type

    Function

• dijit.form.ValidationTextBox.__Constraints.locale

  • type

    String

  • summary

    locale used for validation, picks up value from this widget's lang attribute

• dijit.form.ValidationTextBox.__Constraints._flags_

  • type

    anything

  • summary

    various flags passed to regExpGen function

• dijit.form.RangeBoundTextBox.__Constraints

  • type

    Function

• dijit.form.RangeBoundTextBox.__Constraints.min

  • type

    Number

  • summary

    Minimum signed value.  Default is -Infinity

• dijit.form.RangeBoundTextBox.__Constraints.max

  • type

    Number

  • summary

    Maximum signed value.  Default is +Infinity

• dijit.form

  • type

    Object

• dijit

  • type

    Object