Mixin: UIEditDialog

UIEditDialog

Base class for dialogs that allow the user to input data.

Members


maxLength :number

Gets/sets the maximum number of characters that the user is allowed to enter. The number of characters may be further limited by the validator, if set.

Type:
  • number
Since:
  • 1.0
Default Value:
  • 32767

<readonly> result :string|number

Gets the value entered by the user. May be null if the user canceled.

Type:
  • string | number
Since:
  • 1.0

title :string

Gets/sets the title shown on the dialog. Default is no title. Typically a short prompt directing the user what to enter.

Type:
  • string
Since:
  • 1.0

Methods


exec( [initialVal])

Launches the dialog as a modal dialog and returns the value entered by the user.

Parameters:
Name Type Argument Default Description
initialVal string <optional>
''

The initial value to show in the dialog when it launches. Can be used to show a previously entered result as a reference to the user.

Since:
  • 1.0
Returns:

The value enterd by the user. Same value can be read from result after.

Type
string | number

reset()

Resets the properties of the dialog back to the defaults. This can be used to reset the dialog back to a known state before using it for a different purpose.

Since:
  • 1.0