Класс yii\jui\SliderInput
| Наследование | yii\jui\SliderInput » 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/SliderInput.php |
SliderInput отображает виджет слайдера jQuery UI, который записывает его значение в скрытое поле ввода.
Например,
echo SliderInput::widget([
'model' => $model,
'attribute' => 'amount',
'clientOptions' => [
'min' => 1,
'max' => 10,
],
]);
В следующем примере будет использовано свойство name:
echo SliderInput::widget([
'name' => 'amount',
'clientOptions' => [
'min' => 1,
'max' => 10,
],
]);
Вы также можете использовать этот виджет в \yii\jui\yii\widgets\ActiveForm с помощью метода \yii\jui\yii\widgets\ActiveField::widget(), например так:
<?= $form->field($model, 'from_date')->widget(\yii\jui\SliderInput::classname(), [
'clientOptions' => [
'min' => 1,
'max' => 10,
],
]) ?>
См. также http://api.jqueryui.com/slider/.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $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 |
| $containerOptions | array | Атрибуты тега контейнера. | yii\jui\SliderInput |
| $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 | Атрибуты тега контейнера виджета. | 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\SliderInput |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __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\SliderInput |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| render() | Рендерит представление. | yii\base\Widget |
| renderFile() | Рендерит файл представления. | yii\base\Widget |
| run() | Выполняет виджет. | yii\jui\SliderInput |
| 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 = ['change' => 'slidechange', 'create' => 'slidecreate', 'slide' => 'slide', 'start' => 'slidestart', 'stop' => 'slidestop']
$containerOptions общественное свойство
Атрибуты HTML для тега контейнера.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как рендерятся атрибуты.
public array $containerOptions = []
Подробное описание методов
init() public method
Инициализирует виджет.
Если вы переопределяете этот метод, убедитесь, что сначала вызывается реализация родительского класса.
| public void init ( ) |
|---|
run() public method
Выполняет виджет.
| 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-sliderinput.html
