Yii Framework v1.1.10 类参考
CJuiSortable
| 包 | zii.widgets.jui |
|---|---|
| 继承 | class CJuiSortable » CJuiWidget » CWidget » CBaseController » CComponent |
| 源自 | 1.1 |
| 版本 | $Id: CJuiSortable.php 3217 2011-05-12 23:59:50Z alexander.makarow $ |
| 源码 | framework/zii/widgets/jui/CJuiSortable.php |
CJuiSortable用鼠标拖动选定的元素排序。
CJuiSortable封装了JUI Sortable 插件。
使用这个部件，你可以在视图里面插入以下代码：
通过配置options属性， 你可以指定需要传递给JUI Sortable插件的选项。 如果需要选择（name-value pairs）， 请参阅JUI Sortable说明。
如果你在代码的任何位置使用javascript代码，请添加“js:” 在js代码的定义的开始，Yii的开始将使用这个字符串作为js代码。
CJuiSortable封装了JUI Sortable 插件。
使用这个部件，你可以在视图里面插入以下代码：
$this->widget('zii.widgets.jui.CJuiSortable', array(
'items'=>array(
'id1'=>'Item 1',
'id2'=>'Item 2',
'id3'=>'Item 3',
),
// additional javascript options for the accordion plugin
'options'=>array(
'delay'=>'300',
),
));
通过配置options属性， 你可以指定需要传递给JUI Sortable插件的选项。 如果需要选择（name-value pairs）， 请参阅JUI Sortable说明。
如果你在代码的任何位置使用javascript代码，请添加“js:” 在js代码的定义的开始，Yii的开始将使用这个字符串作为js代码。
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| actionPrefix | string | actions的ID的前缀。 当微件在CController::actions中声明了 动作提供者，可以为其动作的ID指定前缀以区别 于别的微件或控制器。当微件用于控制器 的视图中时，必须配置同样的前缀。 | CWidget |
| controller | CController | 返回此微件所属的控制器。 | CWidget |
| cssFile | mixed | 主题的CSS文件名。默认是‘jquery-ui. | CJuiWidget |
| htmlOptions | array | JUI组件中HTML标签的属性设置。 | CJuiWidget |
| id | string | 返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。 | CWidget |
| itemTemplate | string | 用于生成每一个可拖动排序项的模板。 标记“{content}”在模板中将被用item内容替换， 同时“{id}”将被用此项ID替换。 | CJuiSortable |
| items | array | 可拖动排序项的列表（id=>item content）。 请注意，这个项的内容被不被HTML-encoded。 | CJuiSortable |
| options | array | the 初始的JavaScript需要传递给JUI插件的选项。 | CJuiWidget |
| owner | CBaseController | 返回此微件的所有者或创建者。 | CWidget |
| scriptFile | mixed | 主要JUI的JavaScript的文件名。默认是‘jquery-ui. | CJuiWidget |
| scriptUrl | string | 包含所有JUI JavaScript文件的根目录。 如果没有设置这个属性（默认），Yii will publish the JUI package included in the zii release and use that to infer the root script URL. | CJuiWidget |
| skin | mixed | 微件使用的皮肤的名称。默认为“default”。 如果此属性设置为false，微件将不会有皮肤被使用。 | CWidget |
| tagName | string | 包含所有items的容器元素的名称。默认是‘ul’。 | CJuiSortable |
| theme | string | JUI主题的名字。默认是‘base’。确保在themeUrl下有这样一个目录， 其名称是这个属性的值相同（区分大小写）。 | CJuiWidget |
| themeUrl | string | 包含所有JUI的主题文件夹的根目录。 如果没有设置这个属性（默认）， Yii will publish the JUI package included in the zii release and use that to infer the root theme URL. | CJuiWidget |
| viewPath | string | 返回包含此微件所需的视图文件的路径。 | CWidget |
公共方法
受保护方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| registerCoreScripts() | 注册核心的脚本文件。 | CJuiWidget |
| registerScriptFile() | 注册一个JavaScript文件在scriptUrl下。 | CJuiWidget |
| resolvePackagePath() | 确定JUI包安装路径。 | CJuiWidget |
属性详细
itemTemplate
属性
public string $itemTemplate;
用于生成每一个可拖动排序项的模板。 标记“{content}”在模板中将被用item内容替换， 同时“{id}”将被用此项ID替换。
items
属性
public array $items;
可拖动排序项的列表（id=>item content）。 请注意，这个项的内容被不被HTML-encoded。
tagName
属性
public string $tagName;
包含所有items的容器元素的名称。默认是‘ul’。
方法详细
run()
方法
|
public void run()
|
源码： framework/zii/widgets/jui/CJuiSortable.php#69 (显示)
public function run()
{
$id=$this->getId();
if (isset($this->htmlOptions['id']))
$id = $this->htmlOptions['id'];
else
$this->htmlOptions['id']=$id;
$options=empty($this->options) ? '' : CJavaScript::encode($this->options);
Yii::app()->getClientScript()->registerScript(__CLASS__.'#'.$id,"jQuery('#{$id}').sortable({$options});");
echo CHtml::openTag($this->tagName,$this->htmlOptions)."\n";
foreach($this->items as $id=>$content)
{
echo strtr($this->itemTemplate,array('{id}'=>$id,'{content}'=>$content))."\n";
}
echo CHtml::closeTag($this->tagName);
}
运行这个部件。 这个方法注册必要的javascript并渲染相应的HTML代码。