Packageview.primeFaces.surfaceComponents.components
Classpublic class InputMask
InheritanceInputMask Inheritance components.MaskedTextInput
Implements view.interfaces.IGetChildrenSurfaceComponent, view.interfaces.IIdAttribute, view.interfaces.IHistorySurfaceComponent, interfaces.IComponentSizeOutput

Representation of PrimeFaces inputMask component.

Visual Editor XML:
     <InputMask
     Attributes
     id=""
     width="100"
     height="30"
     value=""
     mask="(999) 999-9999"
     required="false"/>
     
PrimeFaces output:
     <p:inputMask
     Attributes
     id=""
     style="width:100px;height:30px;"
     value=""
     mask="(999) 999-9999"
     required="false"/>
     

Default MXML Propertytext



Public Properties
 PropertyDefined By
  height : Number
[override] [read-only] PrimeFaces: style
InputMask
  heightOutput : Boolean
InputMask
  idAttribute : String
PrimeFaces: id (Optional)
InputMask
  maskText : String
[override] [read-only] PrimeFaces: mask
InputMask
  percentHeight : Number
[override] [read-only] PrimeFaces: style
InputMask
  percentWidth : Number
[override] [read-only] PrimeFaces: style
InputMask
  required : Boolean
PrimeFaces: required
InputMask
  text : String
[override] [read-only] PrimeFaces: value
InputMask
  width : Number
[override] [read-only] PrimeFaces: style
InputMask
  widthOutput : Boolean
InputMask
Protected Properties
 PropertyDefined By
  heightOutputChanged : Boolean
InputMask
  widthOutputChanged : Boolean
InputMask
Public Methods
 MethodDefined By
  
InputMask
  
toRora():XML
InputMask
  
InputMask
Protected Methods
 MethodDefined By
  
[override]
InputMask
Public Constants
 ConstantDefined By
  ELEMENT_NAME : String = InputMask
[static]
InputMask
  PRIME_FACES_XML_ELEMENT_NAME : String = inputMask
[static]
InputMask
Property Detail
heightproperty
height:Number  [read-only] [override]

PrimeFaces: style

The default value is "30".

This property can be used as the source for data binding.


Implementation
    public function get height():Number

Example
Visual Editor XML:
<InputMask height="30"/>
PrimeFaces:
<p:inputMask style="width:100px;height:30px;"/>
heightOutputproperty 
heightOutput:Boolean

This property can be used as the source for data binding.


Implementation
    public function get heightOutput():Boolean
    public function set heightOutput(value:Boolean):void
heightOutputChangedproperty 
protected var heightOutputChanged:Boolean

idAttributeproperty 
idAttribute:String

PrimeFaces: id (Optional)


Implementation
    public function get idAttribute():String
    public function set idAttribute(value:String):void

Example
Visual Editor XML:
<InputMask id=""/>
PrimeFaces:
<p:inputMask id=""/>
maskTextproperty 
maskText:String  [read-only] [override]

PrimeFaces: mask

The default value is "(999) 999-9999".

This property can be used as the source for data binding.


Implementation
    public function get maskText():String

Example
Visual Editor XML:
<InputMask mask="(999) 999-9999"/>
PrimeFaces:
<p:inputMask mask="(999) 999-9999"/>
percentHeightproperty 
percentHeight:Number  [read-only] [override]

PrimeFaces: style

This property can be used as the source for data binding.


Implementation
    public function get percentHeight():Number

Example
Visual Editor XML:
<InputMask percentHeight="80"/>
PrimeFaces:
<p:inputMask style="height:80%;"/>
percentWidthproperty 
percentWidth:Number  [read-only] [override]

PrimeFaces: style

This property can be used as the source for data binding.


Implementation
    public function get percentWidth():Number

Example
Visual Editor XML:
<InputMask percentWidth="80"/>
PrimeFaces:
<p:inputMask style="width:80%;"/>
requiredproperty 
required:Boolean

PrimeFaces: required

The default value is "false".

This property can be used as the source for data binding.


Implementation
    public function get required():Boolean
    public function set required(value:Boolean):void

Example
Visual Editor XML:
<inputMask required="false"/>
PrimeFaces:
<p:inputMask required="false"/>
textproperty 
text:String  [read-only] [override]

PrimeFaces: value


Implementation
    public function get text():String

Example
Visual Editor XML:
<InputMask value=""/>
PrimeFaces:
<p:inputMask value=""/>
widthproperty 
width:Number  [read-only] [override]

PrimeFaces: style

The default value is "100".

This property can be used as the source for data binding.


Implementation
    public function get width():Number

Example
Visual Editor XML:
<InputMask width="100"/>
PrimeFaces:
<p:inputMask style="width:100px;height:30px;"/>
widthOutputproperty 
widthOutput:Boolean

This property can be used as the source for data binding.


Implementation
    public function get widthOutput():Boolean
    public function set widthOutput(value:Boolean):void
widthOutputChangedproperty 
protected var widthOutputChanged:Boolean

Constructor Detail
InputMask()Constructor
public function InputMask()



Method Detail
commitProperties()method
override protected function commitProperties():void

toRora()method 
public function toRora():XML

Returns
XML
toRoyaleConvertCode()method 
public function toRoyaleConvertCode():XML

Returns
XML
Constant Detail
ELEMENT_NAMEConstant
public static const ELEMENT_NAME:String = InputMask

PRIME_FACES_XML_ELEMENT_NAMEConstant 
public static const PRIME_FACES_XML_ELEMENT_NAME:String = inputMask