dijit/form/CurrencyTextBox.js

• Provides:

  • dijit.form.CurrencyTextBox

• Requires:

  • dojo.currency in common
  • dijit.form.NumberTextBox in common

• dijit.form.CurrencyTextBox.__Constraints

  • type

    Function

  • chains:
    • dijit.form.NumberTextBox.__Constraints: (prototype)
    • dojo.currency.__FormatOptions.prototype: (prototype)
    • dojo.currency.__ParseOptions.prototype: (prototype)
    • dijit.form.NumberTextBox.__Constraints: (call)
    • dojo.currency.__FormatOptions: (call)
    • dojo.currency.__ParseOptions: (call)
  • summary

    Specifies both the rules on valid/invalid values (minimum, maximum,
    number of required decimal places), and also formatting options for
    displaying the value when the field is not focused (currency symbol,
    etc.)

  • description

    Follows the pattern of `dijit.form.NumberTextBox.constraints`.
    In general developers won't need to set this parameter

  • example

    To ensure that the user types in the cents (for example, 1.00 instead of just 1):
    		{fractional:true}

• dijit.form.CurrencyTextBox

  • type

    Function

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

    A validating currency textbox

  • description

    CurrencyTextBox is similar to `dijit.form.NumberTextBox` but has a few
    extra features related to currency:
    
    1. After specifying the currency type (american dollars, euros, etc.) it automatically
    sets parse/format options such as how many decimal places to show.
    2. The currency mark (dollar sign, euro mark, etc.) is displayed when the field is blurred
    but erased during editing, so that the user can just enter a plain number.

• dijit.form.CurrencyTextBox.currency

  • tags: const
  • type

    String

  • summary

    the [ISO4217](http://en.wikipedia.org/wiki/ISO_4217) currency code, a three letter sequence like "USD"

• dijit.form.CurrencyTextBox.constraints

  • type

    dijit.form.CurrencyTextBox.__Constraints

  • summary

    Despite the name, this parameter specifies both constraints on the input
    (including minimum/maximum allowed values) as well as
    formatting options.  See <code>dijit.form.CurrencyTextBox.__Constraints</code> for details.

• dijit.form.CurrencyTextBox.baseClass

  • type

    String

• dijit.form.CurrencyTextBox.regExpGen

  • parameters:
    • constraints
  • type

    Function

• dijit.form.CurrencyTextBox._formatter

  • alias - dojo.currency.format

• dijit.form.CurrencyTextBox._parser

  • alias - dojo.currency.parse

• dijit.form.CurrencyTextBox.parse

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

    Parses string value as a Currency, according to the constraints object

  • tags: extension
  • type

    Function

• dijit.form.CurrencyTextBox._setConstraintsAttr

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

    Function

• dijit.form

  • type

    Object

• dijit

  • type

    Object