Class yii\jui\Widget
| Inheritance | yii\jui\Widget » yii\base\Widget » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable, yii\base\ViewContextInterface |
| Subclasses | yii\jui\Accordion, yii\jui\AutoComplete, yii\jui\DatePicker, yii\jui\Dialog, yii\jui\Draggable, yii\jui\Droppable, yii\jui\InputWidget, yii\jui\ProgressBar, yii\jui\Resizable, yii\jui\Selectable, yii\jui\Slider, yii\jui\SliderInput, yii\jui\Sortable, yii\jui\Spinner, yii\jui\Tabs |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-jui/blob/master/Widget.php |
\yii\jui\Widget is the base class for all jQuery UI widgets.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $autoIdPrefix | string | The prefix to the automatically generated widget IDs. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component. | yii\base\Component |
| $clientEvents | array | The event handlers for the underlying jQuery UI widget. | yii\jui\Widget |
| $clientOptions | array | The options for the underlying jQuery UI widget. | yii\jui\Widget |
| $counter | integer | A counter used to generate $id for widgets. | yii\base\Widget |
| $id | string|null | ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details. | yii\base\Widget |
| $options | array | The HTML attributes for the widget container tag. | yii\jui\Widget |
| $stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget |
| $view | yii\web\View | The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See getView() and setView() for details. | yii\base\Widget |
| $viewPath | string | The directory containing the view files for this widget. | yii\base\Widget |
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $clientEventMap | array | Event names mapped to what should be specified in `. | yii\jui\Widget |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| afterRun() | This method is invoked right after a widget is executed. | yii\base\Widget |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| beforeRun() | This method is invoked right before the widget is executed. | yii\base\Widget |
| begin() | Begins a widget. | yii\base\Widget |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| end() | Ends a widget. | yii\base\Widget |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getId() | Returns the ID of the widget. | yii\base\Widget |
| getView() | Returns the view object that can be used to render views or view files. | yii\base\Widget |
| getViewPath() | Returns the directory containing the view files for this widget. | yii\base\Widget |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Initializes the widget. | yii\jui\Widget |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| render() | Renders a view. | yii\base\Widget |
| renderFile() | Renders a view file. | yii\base\Widget |
| run() | Executes the widget. | yii\base\Widget |
| setId() | Sets the ID of the widget. | yii\base\Widget |
| setView() | Sets the view object to be used by this widget. | yii\base\Widget |
| trigger() | Triggers an event. | yii\base\Component |
| widget() | Creates a widget instance and runs it. | yii\base\Widget |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| registerClientEvents() | Registers a specific jQuery UI widget events | yii\jui\Widget |
| registerClientOptions() | Registers a specific jQuery UI widget options | yii\jui\Widget |
| registerWidget() | Registers a specific jQuery UI widget asset bundle, initializes it with client options and registers related events | yii\jui\Widget |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | An event raised right after executing a widget. (available since version 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | An event raised right before executing a widget. (available since version 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) | yii\base\Widget |
Property Details
Event names mapped to what should be specified in .on().
If empty, it is assumed that event passed to clientEvents is prefixed with widget name.
The event handlers for the underlying jQuery UI widget.
Please refer to the corresponding jQuery UI widget Web page for possible events.
For example, this page shows
how to use the "Accordion" widget and the supported events (e.g. "create").
Keys are the event names and values are javascript code that is passed to the .on() function
as the event handler.
For example you could write the following in your widget configuration:
'clientEvents' => [
'change' => 'function () { alert('event "change" occured.'); }'
],
The options for the underlying jQuery UI widget. Please refer to the corresponding jQuery UI widget Web page for possible options. For example, this page shows how to use the "Accordion" widget and the supported options (e.g. "header").
The HTML attributes for the widget container tag.
See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
Method Details
Initializes the widget.
If you override this method, make sure you call the parent implementation first.
| public void init ( ) |
Registers a specific jQuery UI widget events
| protected void registerClientEvents ( $name, $id ) | ||
| $name | string | The name of the jQuery UI widget |
| $id | string | The ID of the widget |
Registers a specific jQuery UI widget options
| protected void registerClientOptions ( $name, $id ) | ||
| $name | string | The name of the jQuery UI widget |
| $id | string | The ID of the widget |
Registers a specific jQuery UI widget asset bundle, initializes it with client options and registers related events
| protected void registerWidget ( $name, $id = null ) | ||
| $name | string | The name of the jQuery UI widget |
| $id | string | The ID of the widget. If null, it will use the |