PHP Class WhBox

Author: Antonio Ramirez ([email protected])
Inheritance: extends CWidget
Show file Open project: 2amigos/yiiwheels

Public Properties

Property Type Description
$content string Box Content optional, the content of this attribute is echoed as the box content
$headerButtons the configuration for additional header buttons. Each array element specifies a single button which has the following format: 
    array(
     TbHtml::button('Primary', array('color' => TbHtml::BUTTON_COLOR_PRIMARY))
     ...
)
$headerIcon string The class icon to display in the header title of the box.
$htmlContentOptions array box content HTML additional attributes
$htmlHeaderOptions array box header HTML additional attributes
$htmlOptions array box HTML additional attributes
$title mixed Box title If set to false, a box with no title is rendered

Public Methods

Method Description
init ( ) ### .init()
registerClientScript ( ) ### .registerClientScript()
renderButtons ( ) ### .renderButtons()
renderContentBegin ( ) * ### .renderContentBegin()
renderContentEnd ( ) * ### .renderContentEnd()
renderHeader ( ) ### .renderHeader()
run ( ) ### .run()

Method Details

init() public method

Widget initialization
public init ( )

registerClientScript() public method

Registers required script files (CSS in this case)
public registerClientScript ( )

renderButtons() public method

Renders a header buttons to display the configured actions
public renderButtons ( )

renderContentBegin() public method

Renders the opening of the content element and the optional content
public renderContentBegin ( )

renderContentEnd() public method

Closes the content element
public renderContentEnd ( )

renderHeader() public method

Renders the header of the box with the header control (button to show/hide the box)
public renderHeader ( )

run() public method

Widget run - used for closing procedures
public run ( )

Property Details

$content public property

Box Content optional, the content of this attribute is echoed as the box content
public string $content
return string

$headerButtons public property

the configuration for additional header buttons. Each array element specifies a single button which has the following format: 
    array(
     TbHtml::button('Primary', array('color' => TbHtml::BUTTON_COLOR_PRIMARY))
     ...
)
public $headerButtons

$headerIcon public property

The class icon to display in the header title of the box.
See also:
public string $headerIcon
return string

$htmlContentOptions public property

box content HTML additional attributes
public array $htmlContentOptions
return array

$htmlHeaderOptions public property

box header HTML additional attributes
public array $htmlHeaderOptions
return array

$htmlOptions public property

box HTML additional attributes
public array $htmlOptions
return array

$title public property

Box title If set to false, a box with no title is rendered
public mixed $title
return mixed