Класс yii\jui\Spinner
| Наследование | yii\jui\Spinner » yii\jui\InputWidget » 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/Spinner.php |
Spinner отображает виджет jQuery UI spinner.
Например:
echo Spinner::widget([
'model' => $model,
'attribute' => 'country',
'clientOptions' => ['step' => 2],
]);
В следующем примере будет использовано свойство name:
echo Spinner::widget([
'name' => 'country',
'clientOptions' => ['step' => 2],
]);
Вы также можете использовать этот виджет в \yii\jui\yii\widgets\ActiveForm с помощью метода \yii\jui\yii\widgets\ActiveField::widget(), например так:
<?= $form->field($model, 'from_date')->widget(\yii\jui\Spinner::classname(), [
'clientOptions' => ['step' => 2],
]) ?>
См. также http://api.jqueryui.com/spinner/.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $attribute | string | Атрибут модели, с которым связан этот виджет. | yii\jui\InputWidget |
| $autoIdPrefix | string | Префикс для автоматически сгенерированных идентификаторов виджета. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список поведений, прикреплённых к этому компоненту | yii\base\Component |
| $clientEvents | array | Обработчики событий для базового виджета jQuery UI. | yii\jui\Widget |
| $clientOptions | array | Параметры для базового виджета jQuery UI. | yii\jui\Widget |
| $counter | integer | Счётчик, используемый для генерации $id для виджетов. | yii\base\Widget |
| $id | string | Идентификатор виджета. | yii\base\Widget |
| $model | yii\base\Model | Модель данных, с которой связан этот виджет. | yii\jui\InputWidget |
| $name | string | Имя входного поля. | yii\jui\InputWidget |
| $options | array | Атрибуты HTML для тега контейнера виджета. | yii\jui\Widget |
| $stack | yii\base\Widget[] | Виджеты, которые в настоящее время отображаются (не завершены). | yii\base\Widget |
| $value | string | Значение входного поля. | yii\jui\InputWidget |
| $view | yii\web\View | Объект представления, который можно использовать для отображения представлений или файлов представления. | yii\base\Widget |
| $viewPath | string | Директория, содержащая файлы представлений для этого виджета. | yii\base\Widget |
Защищённые свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $clientEventMap | array | Имена событий, отображаемые на то, что должно быть указано в `. | yii\jui\Spinner |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __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\InputWidget |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| render() | Рендерит представление. | yii\base\Widget |
| renderFile() | Рендерит файл представления. | yii\base\Widget |
| renderWidget() | Рендерит виджет Spinner. | yii\jui\Spinner |
| run() | Рендерит виджет. | yii\jui\Spinner |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создаёт экземпляр виджета и запускает его. | yii\base\Widget |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| hasModel() | yii\jui\InputWidget | |
| 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 = ['spin' => 'spin', 'change' => 'spinchange', 'create' => 'spincreate', 'start' => 'spinstart', 'stop' => 'spinstop']
Подробное описание методов
renderWidget() публичный метод
Рендерит виджет Spinner.
| public string renderWidget ( ) | ||
|---|---|---|
| возвращает | string |
Результат рендеринга. |
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-spinner.html
