Properties

$grid

$grid : \TbGridView

Type

\TbGridView — The grid view object that owns this column.

$actionButtons

$actionButtons : array

Type

array — the configuration for action displays. Each array element specifies a single button which has the following format: <pre> 'actions' => array( array( 'context'=> 'primary', // '', 'primary', 'info', 'success', 'warning', 'danger' or 'inverse' 'size'=> 'large', // '', 'large', 'small', 'mini' 'label'=>'...', // text label of the button or dropdown label 'click'=> // the js function that will be called ) ), </pre> For more configuration options please @see TbButton Note that in order to display these additional buttons, the {@link template} property needs to be configured so that the corresponding button IDs appear as tokens in the template.

$checkBoxColumnConfig

$checkBoxColumnConfig : array

Type

array — the checkbox column configuration

$noCheckedMessage

$noCheckedMessage : string

Type

string

$align

$align : string

Type

string

$columnName

$columnName : string

Type

string — the column name of the checkbox column

$buttons

$buttons : array

Type

array — the bulk action buttons

$events

$events : array

Type

array — the life events to attach the buttons to

$_counter

$_counter : integer

Type

integer — the counter for generating implicit IDs.

$_id

$_id : string

Type

string — id of the widget.

Methods

getId()

getId(boolean $autoGenerate) : string

### .getId()

Returns the ID of the widget or generates a new one if requested.

Parameters

boolean $autoGenerate

whether to generate an ID if it is not set previously

Returns

string —

id of the widget.

__construct()

__construct(\CGridView $grid)

### .__construct()

Constructor.

Parameters

\CGridView $grid

the grid view that owns this column.

init()

init()

### .init()

Component's initialization method

initColumn()

initColumn() : bool

### .initColumn()

Returns

bool —

checks whether they are

initButtons()

initButtons()

### .initButtons()

initializes the buttons to be render

renderButtons()

renderButtons() : bool

### .renderButtons()

Returns

bool —

renders all initialized buttons

registerClientScript()

registerClientScript()

### .registerClientScript()

Registers client script

renderButton()

renderButton(array $actionButton)

### .renderButton()

Creates a TbButton and renders it

Parameters

array $actionButton

the configuration to create the TbButton

attachCheckBoxColumn()

attachCheckBoxColumn()

### .attachCheckBoxColumn()

Adds a checkbox column to the grid. It is called when

convertToTbButtonConfig()

convertToTbButtonConfig(mixed $action) : array

Parameters

mixed $action

Throws

\CException

Returns

array