class sap.m.MaskInputRule

Control sample: sap.m.MaskInputRule
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/MaskInputRule
Application Component: CA-UI5-CTR

The sap.m.MaskInputRule control holds the mapping of a single maskFormatSymbol to the regular expression regex that defines the allowed characters for the rule.


Constructor

Constructor for a new MaskInputRule.

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.MaskInputRule(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


Properties

Name Type Default Value Description
maskFormatSymbol string *

Defines the symbol used in the mask format which will accept a certain range of characters.

Visibility: public
regex string [a-zA-Z0-9]

Defines the allowed characters as a regular expression.

Visibility: public

Methods Overview

Method Description
sap.m.MaskInputRule.extend

Creates a new subclass of class sap.m.MaskInputRule with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Element.extend.

getMaskFormatSymbol

Gets current value of property maskFormatSymbol.

Defines the symbol used in the mask format which will accept a certain range of characters.

Default value is "*".

sap.m.MaskInputRule.getMetadata

Returns a metadata object for class sap.m.MaskInputRule.

getRegex

Gets current value of property regex.

Defines the allowed characters as a regular expression.

Default value is "[a-zA-Z0-9]".

setMaskFormatSymbol

Sets a new value for property maskFormatSymbol.

Defines the symbol used in the mask format which will accept a certain range of characters.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "*".

setRegex

Sets a new value for property regex.

Defines the allowed characters as a regular expression.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "[a-zA-Z0-9]".

sap.m.MaskInputRule.extend

Creates a new subclass of class sap.m.MaskInputRule with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Element.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

getMaskFormatSymbol

Gets current value of property maskFormatSymbol.

Defines the symbol used in the mask format which will accept a certain range of characters.

Default value is "*".

sap.m.MaskInputRule.getMetadata

Returns a metadata object for class sap.m.MaskInputRule.

getRegex

Gets current value of property regex.

Defines the allowed characters as a regular expression.

Default value is "[a-zA-Z0-9]".

setMaskFormatSymbol

Sets a new value for property maskFormatSymbol.

Defines the symbol used in the mask format which will accept a certain range of characters.

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
sMaskFormatSymbol string "*"

New value for property maskFormatSymbol

setRegex

Sets a new value for property regex.

Defines the allowed characters as a regular expression.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "[a-zA-Z0-9]".

Param Type DefaultValue Description
sRegex string "[a-zA-Z0-9]"

New value for property regex