Constants

CTX_DEFAULT

CTX_DEFAULT

CTX_PRIMARY

CTX_PRIMARY

CTX_SUCCESS

CTX_SUCCESS

CTX_INFO

CTX_INFO

CTX_WARNING

CTX_WARNING

CTX_DANGER

CTX_DANGER

CTX_DEFAULT_CLASS

CTX_DEFAULT_CLASS

CTX_PRIMARY_CLASS

CTX_PRIMARY_CLASS

CTX_SUCCESS_CLASS

CTX_SUCCESS_CLASS

CTX_INFO_CLASS

CTX_INFO_CLASS

CTX_WARNING_CLASS

CTX_WARNING_CLASS

CTX_DANGER_CLASS

CTX_DANGER_CLASS

Properties

$context

$context : string

easily make a widget more meaningful to a particular context by adding any of the contextual state classes

Type

string

$title

$title : mixed

Type

mixed — Panel title If set to false, a panel with no title is rendered

$headerIcon

$headerIcon : string

Type

string — The class icon to display in the header title of the panel.

$content

$content : string

Type

string — Panel Content optional, the content of this attribute is echoed as the panel content

$padContent

$padContent

$htmlOptions

$htmlOptions : array

Type

array — panel HTML additional attributes

$headerHtmlOptions

$headerHtmlOptions : array

Type

array — panel header HTML additional attributes

$contentHtmlOptions

$contentHtmlOptions : array

Type

array — panel content HTML additional attributes

$headerButtons

$headerButtons : array

Type

array — the configuration for additional header buttons. Each array element specifies a single button which has the following format: <pre> array( array( 'class' => 'booster.widgets.TbButton', 'label' => '...', 'size' => '...', ... ), array( 'class' => 'booster.widgets.TbButtonGroup', 'buttons' => array( ... ), 'size' => '...', ), ... ) </pre>

Methods

init()

init()

### .init()

Widget initialization

run()

run()

### .run()

Widget run - used for closing procedures

renderHeader()

renderHeader()

### .renderHeader()

Renders the header of the panel with the header control (button to show/hide the panel)

renderButtons()

renderButtons()

### .renderButtons()

Renders a header buttons to display the configured actions

renderContentBegin()

renderContentBegin()

renderContentEnd()

renderContentEnd()

registerClientScript()

registerClientScript()

### .registerClientScript()

Registers required script files (CSS in this case)

addCssClass()

addCssClass(array $htmlOptions, string $class)

Utility function for appending class names for a generic $htmlOptions array.

Parameters

array $htmlOptions
string $class

isValidContext()

isValidContext( $cotext)

Parameters

$cotext

getContextClass()

getContextClass(string $context)

Parameters

string $context