Spec-Zone.ru › Yii 2.0

Класс yii\jui\Draggable

Все классы | Свойства | Методы | События
Наследование yii\jui\Draggable » yii\jui\Widget » yii\base\Widget » yii\base\Component » yii\base\Object
Реализует yii\base\Configurable, yii\base\ViewContextInterface
Доступно с версии 2.0
Исходный код https://github.com/yiisoft/yii2-jui/blob/master/Draggable.php

Draggable отображает виджет jQuery UI для перетаскивания.

Например:

Draggable::begin([
    'clientOptions' => ['grid' => [50, 20]],
]);

echo 'Draggable contents here...';

Draggable::end();

См. также http://api.jqueryui.com/draggable/.

Публичные свойства

Свойство Тип Описание Определено в
$autoIdPrefix строка Префикс для автоматически сгенерированных идентификаторов виджета. yii\base\Widget
$behaviors yii\base\Behavior[] Список поведений, прикрепленных к этому компоненту yii\base\Component
$clientEvents массив Обработчики событий для подлежащего виджета jQuery UI. yii\jui\Widget
$clientOptions массив Параметры для подлежащего виджета jQuery UI. yii\jui\Widget
$counter целое число Счетчик, используемый для генерации $id для виджетов. yii\base\Widget
$id строка Идентификатор виджета. yii\base\Widget
$options массив Атрибуты HTML для тега контейнера виджета. yii\jui\Widget
$stack yii\base\Widget[] Виджеты, которые в настоящее время отображаются (не завершены). yii\base\Widget
$view yii\web\View Объект представления, который может использоваться для отображения представлений или файлов представлений. yii\base\Widget
$viewPath строка Директория, содержащая файлы представлений для этого виджета. yii\base\Widget

Защищенные свойства

Свойство Тип Описание Определено в
$clientEventMap массив Имена событий, сопоставленные с тем, что должно быть указано в `. yii\jui\Draggable

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

Метод Описание Определено в
__call() Вызывает именованный метод, который не является методом класса. yii\base\Object
__clone() Этот метод вызывается после создания объекта путём клонирования существующего. yii\base\Component
__construct() Конструктор. yii\base\Object
__get() Возвращает значение свойства объекта. yii\base\Object
__isset() Проверяет, установлено ли свойство, т.е. определено и не равно null. yii\base\Object
__set() Устанавливает значение свойства объекта. yii\base\Object
__unset() Устанавливает свойство объекта в null. yii\base\Object
afterRun() Этот метод вызывается сразу после выполнения виджета. yii\base\Widget
attachBehavior() Прикрепляет поведение к этому компоненту. yii\base\Component
attachBehaviors() Прикрепляет список поведений к компоненту. yii\base\Component
beforeRun() Этот метод вызывается сразу перед выполнением виджета. yii\base\Widget
begin() Начинает выполнение виджета. yii\base\Widget
behaviors() Возвращает список поведений, по которым должен вести себя этот компонент. yii\base\Component
canGetProperty() Возвращает значение, указывающее, можно ли прочитать свойство. yii\base\Object
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Object
className() Возвращает полное квалифицированное имя этого класса. yii\base\Object
detachBehavior() Отсоединяет поведение от компонента. yii\base\Component
detachBehaviors() Отсоединяет все поведения от компонента. yii\base\Component
end() Заканчивает выполнение виджета. yii\base\Widget
ensureBehaviors() Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. yii\base\Component
getBehavior() Возвращает объект поведения с заданным именем. yii\base\Component
getBehaviors() Возвращает все прикрепленные к этому компоненту поведения. yii\base\Component
getId() Возвращает идентификатор виджета. yii\base\Widget
getView() Возвращает объект представления, который можно использовать для рендеринга представлений или файлов представлений. yii\base\Widget
getViewPath() Возвращает директорию, содержащую файлы представлений для этого виджета. yii\base\Widget
hasEventHandlers() Возвращает значение, указывающее, есть ли обработчик, прикрепленный к заданному событию. yii\base\Component
hasMethod() Возвращает значение, указывающее, определён ли метод. yii\base\Object
hasProperty() Возвращает значение, указывающее, определено ли свойство. yii\base\Object
init() Инициализирует виджет. yii\jui\Draggable
off() Отсоединяет существующего обработчика событий от этого компонента. yii\base\Component
on() Прикрепляет обработчик событий к событию. yii\base\Component
render() Рендерит представление. yii\base\Widget
renderFile() Рендерит файл представления. yii\base\Widget
run() Рендерит виджет. yii\jui\Draggable
setId() Устанавливает идентификатор виджета. yii\base\Widget
setView() Устанавливает объект представления, который будет использоваться этим виджетом. yii\base\Widget
trigger() Вызывает событие. yii\base\Component
widget() Создаёт экземпляр виджета и запускает его. yii\base\Widget

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

Метод Описание Определено в
registerClientEvents() Регистрирует события конкретного виджета jQuery UI. yii\jui\Widget
registerClientOptions() Регистрирует параметры конкретного виджета jQuery UI. yii\jui\Widget
registerWidget() Регистрирует пакет ресурсов конкретного виджета jQuery UI, инициализирует его параметрами клиента и регистрирует связанные события. yii\jui\Widget

События

Событие Тип Описание Определено в
EVENT_AFTER_RUN yii\base\WidgetEvent Событие, генерируемое сразу после выполнения виджета. (доступно с версии 2.0.11) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent Событие, генерируемое сразу перед выполнением виджета. (доступно с версии 2.0.11) yii\base\Widget
EVENT_INIT yii\base\Event Событие, генерируемое при инициализации виджета через init(). (доступно с версии 2.0.11) yii\base\Widget

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

$clientEventMap защищённое свойство

Имена событий, сопоставленные с тем, что должно быть указано в .on(). Если пусто, предполагается, что событие, переданное в clientEvents, имеет префикс имени виджета.

protected array $clientEventMap = ['create' => 'dragcreate', 'drag' => 'drag', 'stop' => 'dragstop', 'start' => 'dragstart']

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

init() публичный метод

Инициализирует виджет.

public void init ( )

run() публичный метод

Рендерит виджет.

public void run ( )

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-jui-draggable.html

Spec-Zone.ru

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