CJuiDraggable
| Пакет | zii.widgets.jui |
|---|---|
| Наследование | класс CJuiDraggable » CJuiWidget » CWidget » CBaseController » CComponent |
| С версии | 1.1 |
| Исходный код | framework/zii/widgets/jui/CJuiDraggable.php |
CJuiDraggable отображает перетаскиваемый виджет.
CJuiDraggable инкапсулирует плагин JUI Draggable.
Для использования этого виджета, можно вставить следующий код в представление:
Настроив свойство options, можно указать параметры, которые необходимо передать плагину JUI Draggable. Обратитесь к документации JUI Draggable API для возможных параметров (имя-значение) и к странице JUI Draggable для общего описания и демо.
CJuiDraggable инкапсулирует плагин JUI Draggable.
Для использования этого виджета, можно вставить следующий код в представление:
$this->beginWidget('zii.widgets.jui.CJuiDraggable',array(
// additional javascript options for the draggable plugin
'options'=>array(
'scope'=>'myScope',
),
));
echo 'Your draggable content here';
$this->endWidget();
Настроив свойство options, можно указать параметры, которые необходимо передать плагину JUI Draggable. Обратитесь к документации JUI Draggable API для возможных параметров (имя-значение) и к странице JUI Draggable для общего описания и демо.
Свойства Public
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| actionPrefix | строка | префикс к идентификаторам действий. | CWidget |
| controller | CController | Возвращает контроллер, к которому принадлежит данный виджет. | CWidget |
| cssFile | смешанный тип | имя файла темы CSS. | CJuiWidget |
| htmlOptions | массив | HTML атрибуты, которые должны быть отображены в HTML теге, представляющем виджет JUI. | CJuiWidget |
| id | строка | Возвращает ID виджета или генерирует новый, если требуется. | CWidget |
| options | массив | начальные JavaScript параметры, которые должны быть переданы плагину JUI. | CJuiWidget |
| owner | CBaseController | Возвращает владельца/создателя данного виджета. | CWidget |
| scriptFile | смешанный тип | основной JUI файл JavaScript. | CJuiWidget |
| scriptUrl | строка | корневой URL, содержащий все JUI файлы JavaScript. | CJuiWidget |
| skin | смешанный тип | имя используемой темы данного виджета. | CWidget |
| tagName | строка | имя элемента Draggable. | CJuiDraggable |
| theme | строка | имя темы JUI. | CJuiWidget |
| themeUrl | строка | корневой URL, содержащий все папки тем JUI. | CJuiWidget |
| viewPath | строка | Возвращает директорию, содержащую файлы представления для этого виджета. | CWidget |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | CComponent |
| __construct() | Конструктор. | CWidget |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства пустым. | 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() | Отображает открывающий тег элемента draggable. | CJuiDraggable |
| raiseEvent() | Возбуждает событие. | CComponent |
| render() | Отображает представление. | CWidget |
| renderFile() | Отображает файл представления. | CBaseController |
| renderInternal() | Отображает файл представления. | CBaseController |
| run() | Отображает закрывающий тег элемента draggable. | CJuiDraggable |
| setId() | Устанавливает идентификатор виджета. | CWidget |
| widget() | Создаёт виджет и выполняет его. | CBaseController |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| registerCoreScripts() | Регистрирует основные файлы скриптов. | CJuiWidget |
| registerScriptFile() | Регистрирует файл JavaScript по адресу scriptUrl. | CJuiWidget |
| resolvePackagePath() | Определяет путь установки пакета JUI. | CJuiWidget |
Подробное описание свойств
tagName свойство
public string $tagName;
имя элемента Draggable. По умолчанию 'div'.
Подробное описание методов
init() метод
public void init() |
Исходный код: framework/zii/widgets/jui/CJuiDraggable.php#55 (показать)
public function init()
{
parent::init();
$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}').draggable($options);");
echo CHtml::openTag($this->tagName,$this->htmlOptions)."\n";
}
Отображает открывающий тег элемента draggable. Этот метод также регистрирует необходимый JavaScript-код.
run() метод
public void run() |
Исходный код: framework/zii/widgets/jui/CJuiDraggable.php#74 (показать)
public function run()
{
echo CHtml::closeTag($this->tagName);
}
Отображает закрывающий тег элемента, за который можно перетаскивать.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CJuiDraggable
