Класс yii\jui\Selectable
| Наследование | yii\jui\Selectable » 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/Selectable.php |
Selectable отображает виджет jQuery UI selectable.
Например:
echo Selectable::widget([
'items' => [
'Item 1',
[
'content' => 'Item2',
],
[
'content' => 'Item3',
'options' => [
'tag' => 'li',
],
],
],
'options' => [
'tag' => 'ul',
],
'itemOptions' => [
'tag' => 'li',
],
'clientOptions' => [
'tolerance' => 'fit',
],
]);
Selectable в режиме начала.
Selectable::begin([
'clientOptions' => [
'filter' => 'my-selectable-item',
'tolerance' => 'touch',
],
]);
- Элемент 1
- Элемент 2
- Элемент 3
- Элемент 4
Ещё один элемент
Selectable::end();
См. также http://api.jqueryui.com/selectable/.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $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\Selectable |
| $items | массив | Список выбираемых элементов. | yii\jui\Selectable |
| $mode | строка | Режим отображения виджета. | yii\jui\Selectable |
| $options | массив | Атрибуты HTML для тега контейнера виджета. | yii\jui\Selectable |
| $stack | yii\base\Widget[] | Виджеты, которые в данный момент отображаются (не завершены). | yii\base\Widget |
| $view | yii\web\View | Объект представления, который можно использовать для отображения представлений или файлов представлений. | yii\base\Widget |
| $viewPath | строка | Директория, содержащая файлы представлений для этого виджета. | yii\base\Widget |
Защищённые свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $clientEventMap | массив | Имена событий, сопоставленные с тем, что должно быть указано в `. | yii\jui\Widget |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __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\jui\Selectable |
| 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\Selectable |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| render() | Отображает представление. | yii\base\Widget |
| renderFile() | Отображает файл представления. | yii\base\Widget |
| renderItems() | Отображает элементы выбора, как указано в $items. | yii\jui\Selectable |
| run() | Отображает виджет. | yii\jui\Selectable |
| 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 |
Константы
| Константа | Значение | Описание | Определено в |
|---|---|---|---|
| MODE_BEGIN | 'MODE_BEGIN' | yii\jui\Selectable | |
| MODE_DEFAULT | 'MODE_DEFAULT' | yii\jui\Selectable |
Подробности свойств
$itemOptions публичное свойство
Список HTML атрибутов для тегов контейнера элемента. Он будет перезаписан параметрами "options", заданными в отдельных $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 = []
$mode открытое свойство
Режим, используемый для отображения виджета.
public string $mode = self::MODE_DEFAULT
$options открытое свойство
Атрибуты HTML для тега контейнера виджета. Признаются следующие специальные опции:
- tag: строка, по умолчанию "ul", имя тега контейнера этого виджета.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как отображаются атрибуты.
public array $options = []
Подробное описание методов
begin() открытый статический метод
Начинает работу виджета.
Этот метод создает экземпляр вызываемого класса, устанавливая режим MODE_BEGIN. Любой элемент между begin() и end(), соответствующий атрибуту фильтра, будет выбираемым. Он применит конфигурацию к созданному экземпляру. Позже должен быть вызван соответствующий вызов end(). Поскольку некоторые виджеты могут использовать буферизацию вывода, вызов end() должен быть сделан в том же представлении, чтобы избежать нарушения вложенности буферов вывода.
См. также end().
| public static static begin ( $config = [] ) | ||
|---|---|---|
| $config | массив |
Пара имя-значение, которые будут использованы для инициализации свойств объекта |
| return | static |
Новый созданный экземпляр виджета |
init() открытый метод
Инициализирует виджет.
| public void init ( ) |
|---|
renderItems() открытый метод
Отображает выбираемые элементы, как указано в $items.
| public строка renderItems ( ) | ||
|---|---|---|
| return | строка |
Результат отображения. |
| throws | \yii\jui\InvalidConfigException. | |
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-selectable.html
