Class lispa\amos\core\forms\Tabs
Inheritance | lispa\amos\core\forms\Tabs » yii\bootstrap\Tabs » yii\bootstrap\Widget » yii\base\Widget » yii\base\Component » yii\base\Object |
---|---|
Implements | yii\base\Configurable, yii\base\ViewContextInterface |
Uses Traits | yii\bootstrap\BootstrapWidgetTrait |
Class Tabs
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 Bootstrap JS plugin. | yii\bootstrap\BootstrapWidgetTrait |
$clientOptions | array | The options for the underlying Bootstrap JS plugin. | yii\bootstrap\BootstrapWidgetTrait |
$counter | integer | A counter used to generate $id for widgets. | yii\base\Widget |
$dropdownClass | string | Name of a class to use for rendering dropdowns withing this widget. | yii\bootstrap\Tabs |
$encodeLabels | boolean | Whether the labels for header items should be HTML-encoded. | yii\bootstrap\Tabs |
$headerOptions | array | List of HTML attributes for the header container tags. | yii\bootstrap\Tabs |
$hideCwhTab | boolean | If true hide the cwh tab. | lispa\amos\core\forms\Tabs |
$hideReportTab | boolean | If true hide the report tab. | lispa\amos\core\forms\Tabs |
$hideTagsTab | boolean | If true hide the tags tab. | lispa\amos\core\forms\Tabs |
$id | string | ID of the widget. | yii\base\Widget |
$itemOptions | array | List of HTML attributes for the item container tags. | yii\bootstrap\Tabs |
$items | array | List of tabs in the tabs widget. | yii\bootstrap\Tabs |
$linkOptions | array | List of HTML attributes for the tab header link tags. | yii\bootstrap\Tabs |
$navType | string | Specifies the Bootstrap tab styling. | yii\bootstrap\Tabs |
$options | array | The HTML attributes for the widget container tag. | yii\bootstrap\Widget |
$renderTabContent | boolean | Whether to render the tab-content container and its content. |
yii\bootstrap\Tabs |
$stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget |
$tabContentOptions | array | List of HTML attributes for the tab-content container. |
yii\bootstrap\Tabs |
$view | yii\web\View | The view object that can be used to render views or view files. | yii\bootstrap\BootstrapWidgetTrait |
$viewPath | string | The directory containing the view files for this widget. | yii\base\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\Object |
__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\Object |
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() | yii\bootstrap\BootstrapWidgetTrait | |
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. | lispa\amos\core\forms\Tabs |
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 |
renderPanes() | Renders tab panes. | yii\bootstrap\Tabs |
run() | Renders the widget. | yii\bootstrap\Tabs |
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 |
---|---|---|
activateFirstVisibleTab() | Sets the first visible tab as active. | yii\bootstrap\Tabs |
hasActiveTab() | yii\bootstrap\Tabs | |
registerClientEvents() | Registers JS event handlers that are listed in $clientEvents. | yii\bootstrap\BootstrapWidgetTrait |
registerPlugin() | Registers a specific Bootstrap plugin and the related events | yii\bootstrap\BootstrapWidgetTrait |
renderDropdown() | Normalizes dropdown item options by removing tab specific keys content and contentOptions , and also
configure panes accordingly. |
yii\bootstrap\Tabs |
renderItems() | Renders tab items as specified on $items. | lispa\amos\core\forms\Tabs |
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
If true hide the cwh tab.
If true hide the report tab.
If true hide the tags tab.
Method Details
Initializes the widget.
public void init ( ) |
Renders tab items as specified on $items.
protected string renderItems ( ) | ||
return | string | The rendering result. |
---|---|---|
throws | \yii\bootstrap\InvalidConfigException. |