TbToggleColumn Class Reference

Inheritance diagram for TbToggleColumn:

Collaboration diagram for TbToggleColumn:

Public Member Functions
	init ()
Public Member Functions inherited from TbDataColumn
	renderFilterCell ()

Public Attributes
	$value
	$name
	$htmlOptions = array('class' => 'toggle-column')
	$headerHtmlOptions = array('class' => 'toggle-column')
	$footerHtmlOptions = array('class' => 'toggle-column')
	$checkedButtonLabel
	$uncheckedButtonLabel
	$emptyButtonLabel
	$checkedIcon = 'ok-circle'
	$uncheckedIcon = 'remove-sign'
	$emptyIcon = 'question-sign'
	$displayText = false
	$sortable = true
	$filter
	$toggleAction = 'toggle'
	$afterToggle
	$uniqueClassSuffix = ''
Public Attributes inherited from TbDataColumn
	$filterInputOptions

Protected Member Functions
	initButton ()
	registerClientScript ()
	renderDataCellContent ($row, $data)
Protected Member Functions inherited from TbDataColumn
	renderHeaderCellContent ()
	renderFilterCellContent ()

Protected Attributes
	$button = array()

Private Member Functions
	getButtonLabel ($value)

Detailed Description

Definition at line 17 of file TbToggleColumn.php.

Member Function Documentation

TbToggleColumn::getButtonLabel (   $value )

private

Definition at line 261 of file TbToggleColumn.php.

Here is the caller graph for this function:

TbToggleColumn::init

(

)

Initializes the column. This method registers necessary client script for the button column.

Definition at line 144 of file TbToggleColumn.php.

Here is the call graph for this function:

TbToggleColumn::initButton ( )

protected

Initializes the default buttons (toggle).

Reimplemented in TbJsonToggleColumn.

Definition at line 161 of file TbToggleColumn.php.

Here is the caller graph for this function:

TbToggleColumn::registerClientScript ( )

protected

Registers the client scripts for the button column.

Definition at line 212 of file TbToggleColumn.php.

Here is the caller graph for this function:

TbToggleColumn::renderDataCellContent (   $row,   $data  )

protected

Renders the data cell content. This method renders the view, update and toggle buttons in the data cell.

Parameters

integer	$row	the row number (zero-based)
mixed	$data	the data associated with the row

Definition at line 233 of file TbToggleColumn.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

TbToggleColumn::$afterToggle

Definition at line 128 of file TbToggleColumn.php.

TbToggleColumn::$button = array()

protected

Definition at line 138 of file TbToggleColumn.php.

TbToggleColumn::$checkedButtonLabel

Definition at line 48 of file TbToggleColumn.php.

TbToggleColumn::$checkedIcon = 'ok-circle'

Definition at line 66 of file TbToggleColumn.php.

TbToggleColumn::$displayText = false

Definition at line 82 of file TbToggleColumn.php.

TbToggleColumn::$emptyButtonLabel

Definition at line 60 of file TbToggleColumn.php.

TbToggleColumn::$emptyIcon = 'question-sign'

Definition at line 77 of file TbToggleColumn.php.

TbToggleColumn::$filter

Definition at line 102 of file TbToggleColumn.php.

TbToggleColumn::$footerHtmlOptions = array('class' => 'toggle-column')

Definition at line 42 of file TbToggleColumn.php.

TbToggleColumn::$headerHtmlOptions = array('class' => 'toggle-column')

Definition at line 37 of file TbToggleColumn.php.

TbToggleColumn::$htmlOptions = array('class' => 'toggle-column')

Definition at line 32 of file TbToggleColumn.php.

TbToggleColumn::$name

Definition at line 27 of file TbToggleColumn.php.

TbToggleColumn::$sortable = true

Definition at line 90 of file TbToggleColumn.php.

TbToggleColumn::$toggleAction = 'toggle'

Definition at line 108 of file TbToggleColumn.php.

TbToggleColumn::$uncheckedButtonLabel

Definition at line 54 of file TbToggleColumn.php.

TbToggleColumn::$uncheckedIcon = 'remove-sign'

Definition at line 72 of file TbToggleColumn.php.

TbToggleColumn::$uniqueClassSuffix = ''

Definition at line 133 of file TbToggleColumn.php.

TbToggleColumn::$value

Definition at line 19 of file TbToggleColumn.php.

---

The documentation for this class was generated from the following file:

• app/protected/extensions/booster/widgets/TbToggleColumn.php