Class CMaskedTextField

CMaskedTextField generates a masked text field.

CMaskedTextField is similar to CHtml::textField() except that an input mask will be used to help users enter properly formatted data. The masked text field is implemented based on the jQuery masked input plugin (see http://digitalbush.com/projects/masked-input-plugin).

CComponent

CBaseController

CWidget

CInputWidget

CMaskedTextField

Package: system\web\widgets
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/web/widgets/CMaskedTextField.php

Methods summary
`public`	# `run( )` Executes the widget. This method registers all needed client scripts and renders the text field. Executes the widget. This method registers all needed client scripts and renders the text field. Overrides `CWidget::run()`
`public`	# `registerClientScript( )` Registers the needed CSS and JavaScript. Registers the needed CSS and JavaScript.
`protected array`	# `getClientOptions( )` Returns `array` the options for the text field

Methods inherited from CInputWidget
`hasModel(), resolveNameID()`

Methods inherited from CWidget
`__construct(), actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), init(), render(), setId()`

Methods inherited from CBaseController
`beginCache(), beginClip(), beginContent(), beginWidget(), createWidget(), endCache(), endClip(), endContent(), endWidget(), renderFile(), renderInternal(), widget()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties summary
`public string`	`$mask`	# the input mask (e.g. '99/99/9999' for date input). The following characters are predefined: a: represents an alpha character (A-Z,a-z). 9: represents a numeric character (0-9). : represents an alphanumeric character (A-Z,a-z,0-9). ?: anything listed after '?' within the mask is considered optional user input. Additional characters can be defined by specifying the `CMaskedTextField::$charMap` property. the input mask (e.g. '99/99/9999' for date input). The following characters are predefined: a: represents an alpha character (A-Z,a-z). 9: represents a numeric character (0-9). : represents an alphanumeric character (A-Z,a-z,0-9). ?: anything listed after '?' within the mask is considered optional user input. Additional characters can be defined by specifying the `CMaskedTextField::$charMap` property.
`public array`	`$charMap`	# the mapping between mask characters and the corresponding patterns. For example, array('~'=>'[+-]') specifies that the '~' character expects '+' or '-' input. Defaults to null, meaning using the map as described in `CMaskedTextField::$mask`. the mapping between mask characters and the corresponding patterns. For example, array('~'=>'[+-]') specifies that the '~' character expects '+' or '-' input. Defaults to null, meaning using the map as described in `CMaskedTextField::$mask`.
`public string`	`$placeholder`	# the character prompting for user input. Defaults to underscore '_'. the character prompting for user input. Defaults to underscore '_'.
`public string`	`$completed`	# a JavaScript function callback that will be invoked when user finishes the input. a JavaScript function callback that will be invoked when user finishes the input.

Properties inherited from CInputWidget
`$attribute, $htmlOptions, $model, $name, $value`

Properties inherited from CWidget
`$actionPrefix, $skin`

Magic properties inherited from CWidget
`$controller, $id, $owner, $viewPath`

Packages

Classes

Class CMaskedTextField

Overrides

Returns