Spec-Zone.ru › Yii 2.0

Класс yii\jui\Sortable

Все классы | Свойства | Методы | События
Наследование yii\jui\Sortable » 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/Sortable.php

Sortable отображает виджет сортировки jQuery UI.

Например:

echo Sortable::widget([
    'items' => [
        'Item 1',
        ['content' => 'Item2'],
        [
            'content' => 'Item3',
            'options' => ['tag' => 'li'],
        ],
    ],
    'options' => ['tag' => 'ul'],
    'itemOptions' => ['tag' => 'li'],
    'clientOptions' => ['cursor' => 'move'],
]);

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

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

Свойство Тип Описание Определено в
$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
$itemOptions массив Список атрибутов HTML для тегов контейнера элемента. yii\jui\Sortable
$items массив Список сортируемых элементов. yii\jui\Sortable
$options массив Атрибуты HTML для тега контейнера виджета. yii\jui\Sortable
$stack yii\base\Widget[] Виджеты, которые в настоящее время отображаются (не завершены). yii\base\Widget
$view yii\web\View Объект представления, который можно использовать для отображения представлений или файлов представлений. yii\base\Widget
$viewPath строка Директория, содержащая файлы представлений для данного виджета. yii\base\Widget

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

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

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

Метод Описание Определено в
__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\Widget
off() Отсоединяет существующий обработчик событий от этого компонента. yii\base\Component
on() Присоединяет обработчик событий к событию. yii\base\Component
render() Отображает представление. yii\base\Widget
renderFile() Отображает файл представления. yii\base\Widget
renderItems() Отображает сортируемые элементы, как указано в $items. yii\jui\Sortable
run() Отображает виджет. yii\jui\Sortable
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 = ['activate' => 'sortactivate', 'beforeStop' => 'sortbeforestop', 'change' => 'sortchange', 'create' => 'sortcreate', 'deactivate' => 'sortdeactivate', 'out' => 'sortout', 'over' => 'sortover', 'receive' => 'sortreceive', 'remove' => 'sortremove', 'sort' => 'sort', 'start' => 'sortstart', 'stop' => 'sortstop', 'update' => 'sortupdate']

$itemOptions общедоступное свойство

Список HTML-атрибутов для тегов контейнера элементов. Он будет перезаписан опциями, заданными в индивидуальных $items. Признаются следующие специальные опции:

  • tag: строка, по умолчанию "li", имя тега контейнера элементов.

См. также yii\helpers\Html::renderTagAttributes() для получения подробностей о том, как отображаются атрибуты.

public array $itemOptions = []

$items общедоступное свойство

Список сортируемых элементов. Каждый элемент может быть строкой, представляющей содержимое элемента, или массивом следующей структуры:

[
    'content' => 'item content',
    // the HTML attributes of the item container tag. This will overwrite "itemOptions".
    'options' => [],
]
public array $items = []

$options свойство public

Атрибуты HTML для тега контейнера виджета. Распознаются следующие специальные опции:

  • tag: строка, по умолчанию "ul", имя тега контейнера этого виджета.

См. также yii\helpers\Html::renderTagAttributes() для получения подробностей о том, как рендерятся атрибуты.

public array $options = []

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

renderItems() метод public

Отображает сортируемые элементы, как указано в $items.

public string renderItems ( )
возвращает строка

Результат рендеринга.

выбрасывает \yii\jui\InvalidConfigException.

run() метод public

Отображает виджет.

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-sortable.html

Spec-Zone.ru

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