The sap.m.MaskInput
control allows users to easily enter data in a certain format and in a fixed-width input (for example: date, time, phone number, credit card number, currency, IP address, MAC address, and others).
Constructor for a new MaskInput.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.m.MaskInput(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new control, generated automatically if no ID is given |
|
mSettings? | object | Initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
effectiveShowClearIcon | boolean | false | Specifies whether the clear icon should be shown/hidden on user interaction. Visibility: hidden |
mask | string | Mask defined by its characters type (respectively, by its length). You should consider the following important facts: 1. The mask characters normally correspond to an existing rule (one rule per unique char). Characters which don't, are considered immutable characters (for example, the mask '2099', where '9' corresponds to a rule for digits, has the characters '2' and '0' as immutable). 2. Adding a rule corresponding to the |
|
placeholderSymbol | string | _ | Defines a placeholder symbol. Shown at the position where there is no user input yet. Visibility: public |
showClearIcon | boolean | false | Specifies whether a clear icon is shown. Pressing the icon will clear input's value and fire the change event. |
Name | Type | Default Value | Description |
---|---|---|---|
editable | boolean | true | Defines whether the control can be modified by the user or not. Note: A user can tab to non-editable control, highlight it, and copy the text from it. |
enabled | boolean | true | Indicates whether the user can interact with the control or not. Note: Disabled controls cannot be focused and they are out of the tab-chain. Visibility: public |
name | string | The name to be used in the HTML code (for example, for HTML forms that send data to the server via submission). Visibility: public |
|
placeholder | string | Defines a short hint intended to aid the user with data entry when the control has no value. Visibility: public |
|
required | boolean | false | Indicates that user input is required. This property is only needed for accessibility purposes when a single relationship between the field and a label (see aggregation |
showValueStateMessage | boolean | true | Indicates whether the value state message should be shown or not. |
textAlign | sap.ui.core.TextAlign | Initial | Defines the horizontal alignment of the text that is shown inside the input field. |
textDirection | sap.ui.core.TextDirection | Inherit | Defines the text directionality of the input field, e.g. |
value | string | Defines the value of the control. Visibility: public |
|
valueState | sap.ui.core.ValueState | None | Visualizes the validation state of the control, e.g. |
valueStateText | string | Defines the text that appears in the value state message pop-up. If this is not specified, a default text is shown from the resource bundle. |
|
width | sap.ui.core.CSSSize | Defines the width of the control. Note: If the provided width is too small, the control gets stretched to its min width, which is needed in order for the control to be usable and well aligned. Visibility: public |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
rules | 0..n | sap.m.MaskInputRule |
A list of validation rules (one rule per mask character). |
Name | Cardinality | Type | Description |
---|---|---|---|
formattedValueStateText | 0..1 | sap.m.FormattedText |
Defines the formatted text that appears in the value state message pop-up. It can include links. If both |
Method | Description |
---|---|
addRule |
Adds some rule to the aggregation rules. |
destroyRules |
Destroys all the rules in the aggregation rules. |
sap.m.MaskInput.extend |
Creates a new subclass of class sap.m.MaskInput with name
|
getMask |
Gets current value of property mask. Mask defined by its characters type (respectively, by its length). You should consider the following important facts: 1. The mask characters normally correspond to an existing rule (one rule per unique char). Characters which don't, are considered immutable characters (for example, the mask '2099', where '9' corresponds to a rule for digits, has the characters '2' and '0' as immutable). 2. Adding a rule corresponding to the |
sap.m.MaskInput.getMetadata |
Returns a metadata object for class sap.m.MaskInput. |
getPlaceholderSymbol |
Gets current value of property placeholderSymbol. Defines a placeholder symbol. Shown at the position where there is no user input yet. Default value is |
getRules |
Gets content of aggregation rules. A list of validation rules (one rule per mask character). |
getShowClearIcon |
Gets current value of property showClearIcon. Specifies whether a clear icon is shown. Pressing the icon will clear input's value and fire the change event. Default value is |
indexOfRule |
Checks for the provided |
insertRule |
Inserts a rule into the aggregation rules. |
removeAllRules |
Removes all the controls from the aggregation rules. Additionally, it unregisters them from the hosting UIArea. |
removeRule |
Removes a rule from the aggregation rules. |
setMask |
Sets a new value for property mask. Mask defined by its characters type (respectively, by its length). You should consider the following important facts: 1. The mask characters normally correspond to an existing rule (one rule per unique char). Characters which don't, are considered immutable characters (for example, the mask '2099', where '9' corresponds to a rule for digits, has the characters '2' and '0' as immutable). 2. Adding a rule corresponding to the When called with a value of |
setPlaceholderSymbol |
Sets a new value for property placeholderSymbol. Defines a placeholder symbol. Shown at the position where there is no user input yet. When called with a value of Default value is |
setShowClearIcon |
Sets a new value for property showClearIcon. Specifies whether a clear icon is shown. Pressing the icon will clear input's value and fire the change event. When called with a value of Default value is |
Adds some rule to the aggregation rules.
Param | Type | DefaultValue | Description |
---|---|---|---|
oRule | sap.m.MaskInputRule |
The rule to add; if empty, nothing is inserted |
Creates a new subclass of class sap.m.MaskInput with name sClassName
and enriches it with the information contained in oClassInfo
.
oClassInfo
might contain the same kind of information as described in sap.m.InputBase.extend.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Gets current value of property mask.
Mask defined by its characters type (respectively, by its length). You should consider the following important facts: 1. The mask characters normally correspond to an existing rule (one rule per unique char). Characters which don't, are considered immutable characters (for example, the mask '2099', where '9' corresponds to a rule for digits, has the characters '2' and '0' as immutable). 2. Adding a rule corresponding to the placeholderSymbol
is not recommended and would lead to an unpredictable behavior. 3. You can use the special escape character '^' called "Caret" prepending a rule character to make it immutable. Use the double escape '^^' if you want to make use of the escape character as an immutable one.
Gets current value of property placeholderSymbol.
Defines a placeholder symbol. Shown at the position where there is no user input yet.
Default value is "_"
.
Gets content of aggregation rules.
A list of validation rules (one rule per mask character).
Gets current value of property showClearIcon.
Specifies whether a clear icon is shown. Pressing the icon will clear input's value and fire the change event.
Default value is false
.
Checks for the provided sap.m.MaskInputRule
in the aggregation rules. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oRule | sap.m.MaskInputRule |
The rule whose index is looked for |
Inserts a rule into the aggregation rules.
Param | Type | DefaultValue | Description |
---|---|---|---|
oRule | sap.m.MaskInputRule |
The rule to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation rules.
Additionally, it unregisters them from the hosting UIArea.
Removes a rule from the aggregation rules.
Param | Type | DefaultValue | Description |
---|---|---|---|
vRule | int string sap.m.MaskInputRule |
The rule to remove or its index or id |
Sets a new value for property mask.
Mask defined by its characters type (respectively, by its length). You should consider the following important facts: 1. The mask characters normally correspond to an existing rule (one rule per unique char). Characters which don't, are considered immutable characters (for example, the mask '2099', where '9' corresponds to a rule for digits, has the characters '2' and '0' as immutable). 2. Adding a rule corresponding to the placeholderSymbol
is not recommended and would lead to an unpredictable behavior. 3. You can use the special escape character '^' called "Caret" prepending a rule character to make it immutable. Use the double escape '^^' if you want to make use of the escape character as an immutable one.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sMask | string |
New value for property |
Sets a new value for property placeholderSymbol.
Defines a placeholder symbol. Shown at the position where there is no user input yet.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is "_"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sPlaceholderSymbol | string | "_" |
New value for property |
Sets a new value for property showClearIcon.
Specifies whether a clear icon is shown. Pressing the icon will clear input's value and fire the change event.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bShowClearIcon | boolean | false |
New value for property |