Spec-Zone.ru › Yii 1.1

CJuiSelectable

Пакет zii.widgets.jui
Наследование class CJuiSelectable » CJuiWidget » CWidget » CBaseController » CComponent
С версии 1.1
Исходный код framework/zii/widgets/jui/CJuiSelectable.php
CJuiSelectable отображает виджет аккордеон.

CJuiSelectable инкапсулирует плагин JUI Selectable.

Чтобы использовать этот виджет, вы можете вставить следующий код в представление:
$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',
    ),
));


Настроив свойство options, вы можете указать параметры, которые необходимо передать плагину JUI Selectable. Обратитесь к документации JUI Selectable API для возможных параметров (имя-значение) и к странице JUI Selectable для общего описания и демонстрации.

Общественные свойства

Свойство Тип Описание Определено в
actionPrefix строка префикс к идентификаторам действий. CWidget
controller CController Возвращает контроллер, к которому относится этот виджет. CWidget
cssFile смешанный тип имя файла темы CSS. CJuiWidget
htmlOptions массив атрибуты HTML, которые должны быть отображены в теге HTML, представляющем виджет JUI. CJuiWidget
id строка Возвращает идентификатор виджета или генерирует новый, если запрошено. CWidget
itemTemplate строка шаблон, используемый для генерации каждого элемента для выбора. CJuiSelectable
items массив список элементов для выбора (id=>содержимое элемента). CJuiSelectable
options массив начальные JavaScript-параметры, которые должны быть переданы плагину JUI. CJuiWidget
owner CBaseController Возвращает владельца/создателя этого виджета. CWidget
scriptFile смешанный тип основной JavaScript-файл JUI. CJuiWidget
scriptUrl строка корневой URL, содержащий все JavaScript-файлы JUI. CJuiWidget
skin смешанный тип имя используемой кожей виджета. CWidget
tagName строка имя контейнерного элемента, содержащего все элементы. CJuiSelectable
theme строка имя темы JUI. CJuiWidget
themeUrl строка корневой URL, содержащий все папки темы JUI. CJuiWidget
viewPath строка Возвращает директорию, содержащую файлы представлений для данного виджета. CWidget

Публичные методы

Метод Описание Определено в
__call() Вызывает метод с заданным именем, который не является методом класса. CComponent
__construct() Конструктор. CWidget
__get() Возвращает значение свойства, список обработчиков событий или поведение по его имени. CComponent
__isset() Проверяет, является ли значение свойства null. CComponent
__set() Устанавливает значение свойства компонента. CComponent
__unset() Устанавливает свойство компонента в null. CComponent
actions() Возвращает список действий, используемых этим виджетом. CWidget
asa() Возвращает объект поведения с заданным именем. CComponent
attachBehavior() Прикрепляет поведение к этому компоненту. CComponent
attachBehaviors() Прикрепляет список поведений к компоненту. CComponent
attachEventHandler() Прикрепляет обработчик событий к событию. CComponent
beginCache() Начинает кэширование фрагмента. CBaseController
beginClip() Начинает запись клипа. CBaseController
beginContent() Начинает отображение содержимого, которое будет декорироваться указанным представлением. CBaseController
beginWidget() Создаёт виджет и выполняет его. CBaseController
canGetProperty() Определяет, может ли свойство быть прочитано. CComponent
canSetProperty() Определяет, может ли свойство быть установлено. CComponent
createWidget() Создаёт виджет и инициализирует его. CBaseController
detachBehavior() Открепляет поведение от компонента. CComponent
detachBehaviors() Открепляет все поведения от компонента. CComponent
detachEventHandler() Открепляет существующий обработчик событий. CComponent
disableBehavior() Отключает прикреплённое поведение. CComponent
disableBehaviors() Отключает все прикреплённые к этому компоненту поведения. CComponent
enableBehavior() Включает прикреплённое поведение. CComponent
enableBehaviors() Включает все прикреплённые к этому компоненту поведения. CComponent
endCache() Завершает кэширование фрагмента. CBaseController
endClip() Завершает запись клипа. CBaseController
endContent() Завершает отображение содержимого. CBaseController
endWidget() Завершает выполнение указанного виджета. CBaseController
evaluateExpression() Вычисляет выражение PHP или обратный вызов в контексте этого компонента. CComponent
getController() Возвращает контроллер, к которому принадлежит этот виджет. CWidget
getEventHandlers() Возвращает список прикреплённых обработчиков событий для события. CComponent
getId() Возвращает идентификатор виджета или генерирует новый, если запрошено. CWidget
getOwner() Возвращает владельца/создателя этого виджета. CWidget
getViewFile() Ищет файл скрипта представления по имени представления. CWidget
getViewPath() Возвращает директорию, содержащую файлы представлений для этого виджета. CWidget
hasEvent() Определяет, определено ли событие. CComponent
hasEventHandler() Проверяет, есть ли прикреплённые обработчики к событию с заданным именем. CComponent
hasProperty() Определяет, определено ли свойство. CComponent
init() Инициализирует виджет. CJuiWidget
raiseEvent() Вызывает событие. CComponent
render() Отображает представление. CWidget
renderFile() Отображает файл представления. CBaseController
renderInternal() Отображает файл представления. CBaseController
run() Запустить этот виджет. CJuiSelectable
setId() Устанавливает идентификатор виджета. CWidget
widget() Создаёт виджет и выполняет его. CBaseController

Защищённые методы

Метод Описание Определено в
registerCoreScripts() Регистрирует основные файлы скриптов. CJuiWidget
registerScriptFile() Регистрирует файл JavaScript по scriptUrl. CJuiWidget
resolvePackagePath() Определяет путь к установке пакета JUI. CJuiWidget

Подробное описание свойств

itemTemplate свойство

public string $itemTemplate;

шаблон, используемый для генерации каждого элемента выбора. Токен "{content}" в шаблоне будет заменён содержимым элемента, а "{id}" — идентификатором элемента.

items свойство

public array $items;

список элементов выбора (id=>содержимое элемента). Обратите внимание, что содержимое элементов не будет кодироваться в HTML.

tagName свойство

public string $tagName;

имя контейнерного элемента, содержащего все элементы. По умолчанию равно 'ol'.

Подробное описание методов

run() метод

public void run()
Исходный код: framework/zii/widgets/jui/CJuiSelectable.php#66 (показать)
public function run()
{
    
$id=$this->getId();
    if(isset(
$this->htmlOptions['id']))
        
$id=$this->htmlOptions['id'];
    else
        
$this->htmlOptions['id']=$id;

    
$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);
}

Запустите этот виджет. Этот метод регистрирует необходимый javascript и рендерит необходимый HTML код.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CJuiSelectable

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API