diff options
Diffstat (limited to 'framework/zii/widgets/jui/CJuiSelectable.php')
| -rw-r--r-- | framework/zii/widgets/jui/CJuiSelectable.php | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/framework/zii/widgets/jui/CJuiSelectable.php b/framework/zii/widgets/jui/CJuiSelectable.php new file mode 100644 index 0000000..426a359 --- /dev/null +++ b/framework/zii/widgets/jui/CJuiSelectable.php @@ -0,0 +1,84 @@ +<?php +/** + * CJuiSelectable class file. + * + * @author Sebastian Thierer <sebathi@gmail.com> + * @link http://www.yiiframework.com/ + * @copyright Copyright © 2008-2011 Yii Software LLC + * @license http://www.yiiframework.com/license/ + */ + +Yii::import('zii.widgets.jui.CJuiWidget'); + +/** + * CJuiSelectable displays an accordion widget. + * + * CJuiSelectable encapsulates the {@link http://jqueryui.com/demos/selectable/ JUI Selectable} + * plugin. + * + * To use this widget, you may insert the following code in a view: + * <pre> + * $this->widget('zii.widgets.jui.CJuiSelectable', array( + * 'items'=>array( + * 'id1'=>'Item 1', + * 'id2'=>'Item 2', + * 'id3'=>'Item 3', + * ), + * // additional javascript options for the selectable plugin + * 'options'=>array( + * 'delay'=>'300', + * ), + * )); + * </pre> + * + * By configuring the {@link options} property, you may specify the options + * that need to be passed to the JUI Selectable plugin. Please refer to + * the {@link http://jqueryui.com/demos/selectable/ JUI Selectable} documentation + * for possible options (name-value pairs). + * + * @author Sebastian Thierer <sebathi@gmail.com> + * @version $Id: CJuiSelectable.php 3207 2011-05-12 08:05:26Z mdomba $ + * @package zii.widgets.jui + * @since 1.1 + */ +class CJuiSelectable extends CJuiWidget { + /** + * @var array list of selectable items (id=>item content). + * Note that the item contents will not be HTML-encoded. + */ + public $items=array(); + /** + * @var string the name of the container element that contains all items. Defaults to 'ol'. + */ + public $tagName='ol'; + /** + * @var string the template that is used to generated every selectable item. + * The token "{content}" in the template will be replaced with the item content, + * while "{id}" will be replaced with the item ID. + */ + public $itemTemplate='<li id="{id}">{content}</li>'; + + /** + * Run this widget. + * This method registers necessary javascript and renders the needed HTML code. + */ + 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}').selectable({$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); + } +} + + |