Yii Framework v1.1.10 类参考
CMaskedTextField
| 包 | system.web.widgets |
|---|---|
| 继承 | class CMaskedTextField » CInputWidget » CWidget » CBaseController » CComponent |
| 源自 | 1.0 |
| 版本 | $Id: CMaskedTextField.php 3515 2011-12-28 12:29:24Z mdomba $ |
| 源码 | framework/web/widgets/CMaskedTextField.php |
CMaskedTextField 生成一个支持掩码的输入框。
CMaskedTextField 类似于CHtml::textField， 区别在于 一个支持掩码的输入框可以帮助用户按正确的格式输入数据。 支持掩码的输入框是在jQuery masked input插件的基础上实现的。 (参见 http://digitalbush.com/projects/masked-input-plugin)。
CMaskedTextField 类似于CHtml::textField， 区别在于 一个支持掩码的输入框可以帮助用户按正确的格式输入数据。 支持掩码的输入框是在jQuery masked input插件的基础上实现的。 (参见 http://digitalbush.com/projects/masked-input-plugin)。
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| actionPrefix | string | actions的ID的前缀。 当微件在CController::actions中声明了 动作提供者，可以为其动作的ID指定前缀以区别 于别的微件或控制器。当微件用于控制器 的视图中时，必须配置同样的前缀。 | CWidget |
| attribute | string | the 与此小物件相关联的属性。 这个名字可以包含方括号 (e. | CInputWidget |
| charMap | array | 掩码字符与相对应的模板的映射。 例如，array('~'=>'[+-]') 指明'~'字符对应'+'或'-'输入。 默认值是null，表示使用mask中声明的映射。 | CMaskedTextField |
| completed | string | 当用户完成输入后调用的一个JavaScript回调函数。 | CMaskedTextField |
| controller | CController | 返回此微件所属的控制器。 | CWidget |
| htmlOptions | array | 渲染输入标签时附加的HTML选项 | CInputWidget |
| id | string | 返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。 | CWidget |
| mask | string | 输入掩码 (例如日期输入格式"99/99/9999")。下列字符已预先定义：
|
CMaskedTextField |
| model | CModel | 与此小物件相关联的数据模型。 | CInputWidget |
| name | string | 输入控件的名字。如果model没有设置，则必须设置此属性。 | CInputWidget |
| owner | CBaseController | 返回此微件的所有者或创建者。 | CWidget |
| placeholder | string | 用于提示用户输入的字符。默认值是下划线'_'。 | CMaskedTextField |
| skin | mixed | 微件使用的皮肤的名称。默认为“default”。 如果此属性设置为false，微件将不会有皮肤被使用。 | CWidget |
| value | string | 输入控件的值 | CInputWidget |
| viewPath | string | 返回包含此微件所需的视图文件的路径。 | CWidget |
公共方法
受保护方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| getClientOptions() | 返回输入框需要的选项。 | CMaskedTextField |
| hasModel() | 确定此小物件是否与一个数据模型相关联。 | CInputWidget |
| resolveNameID() | CInputWidget |
属性详细
charMap
属性
public array $charMap;
掩码字符与相对应的模板的映射。 例如，array('~'=>'[+-]') 指明'~'字符对应'+'或'-'输入。 默认值是null，表示使用mask中声明的映射。
clientOptions
属性
只读
protected array getClientOptions()
输入框需要的选项。
completed
属性
public string $completed;
当用户完成输入后调用的一个JavaScript回调函数。
mask
属性
public string $mask;
输入掩码 (例如日期输入格式"99/99/9999")。下列字符已预先定义：
- a: 表示一个字母（A-Z，a-z）。
- 9: 表示一个数字（0-9）。
- *: 表示一个字母或数字（A-Z，a-z，0-9）。
- ?: 掩码中跟在“?”字符后的任何字符串是可选的用户输入。
placeholder
属性
public string $placeholder;
用于提示用户输入的字符。默认值是下划线'_'。
方法详细
getClientOptions()
方法
|
protected array getClientOptions()
| ||
| {return} | array | 输入框需要的选项。 |
源码： framework/web/widgets/CMaskedTextField.php#99 (显示)
protected function getClientOptions()
{
$options=array();
if($this->placeholder!==null)
$options['placeholder']=$this->placeholder;
if(is_string($this->completed))
{
if(strncmp($this->completed,'js:',3))
$options['completed']='js:'.$this->completed;
else
$options['completed']=$this->completed;
}
return $options;
}
registerClientScript()
方法
|
public void registerClientScript()
|
源码： framework/web/widgets/CMaskedTextField.php#81 (显示)
public function registerClientScript()
{
$id=$this->htmlOptions['id'];
$miOptions=$this->getClientOptions();
$options=$miOptions!==array() ? ','.CJavaScript::encode($miOptions) : '';
$js='';
if(is_array($this->charMap))
$js.='jQuery.mask.definitions='.CJavaScript::encode($this->charMap).";\n";
$js.="jQuery(\"#{$id}\").mask(\"{$this->mask}\"{$options});";
$cs=Yii::app()->getClientScript();
$cs->registerCoreScript('maskedinput');
$cs->registerScript('Yii.CMaskedTextField#'.$id,$js);
}
注册必须的CSS和JavaScript。
run()
方法
|
public void run()
|
源码： framework/web/widgets/CMaskedTextField.php#57 (显示)
public function run()
{
if($this->mask=='')
throw new CException(Yii::t('yii','Property CMaskedTextField.mask cannot be empty.'));
list($name,$id)=$this->resolveNameID();
if(isset($this->htmlOptions['id']))
$id=$this->htmlOptions['id'];
else
$this->htmlOptions['id']=$id;
if(isset($this->htmlOptions['name']))
$name=$this->htmlOptions['name'];
$this->registerClientScript();
if($this->hasModel())
echo CHtml::activeTextField($this->model,$this->attribute,$this->htmlOptions);
else
echo CHtml::textField($name,$this->value,$this->htmlOptions);
}
执行此小物件。 此方法注册所有必须的客户端脚本，并渲染出 输入框。