HasCheckboxesTrait Class Reference

Inheritance diagram for HasCheckboxesTrait:

Public Member Functions
	addInToolbar ($element, $callback=NULL)
	getHasCheckboxes ()
	setHasCheckboxes ($_hasCheckboxes)
	setCheckedMessage (array $_checkedMessage)
	Defines the message displayed when checkboxes are checked or unchecked with an associative array 0=>no selection,1=>one item selected, other=>{count} items selected.
	addCountCheckedInToolbar (array $checkedMessage=null, $callback=null)
	setCheckedClass ($_checkedClass)
	setCheckedCallback ($checkedCallback)
	Set the callback function that determines whether the checkbox should be checked for an object.

Protected Member Functions
	_runCheckboxes (JsUtils $js)
	_getCheckedChange (JsUtils $js=NULL)
	_getCheckedMessageFunction ()
	_getCheckedMessageCall (JsUtils $js=NULL)
	_generateMainCheckbox (&$captions)
	_setAllChecked ($checked)
	getCheckedMessage ()

Protected Attributes
	$_hasCheckboxes
	$_hasCheckedMessage =false
	$_checkedMessage
	$_checkedClass
	$_checkedCallback

Detailed Description

Definition at line 15 of file HasCheckboxesTrait.php.

Member Function Documentation

_generateMainCheckbox()

_generateMainCheckbox ( &  $captions )

protected

Definition at line 61 of file HasCheckboxesTrait.php.

_getCheckedChange()

_getCheckedChange ( JsUtils  $js = NULL )

protected

Definition at line 31 of file HasCheckboxesTrait.php.

_getCheckedMessageCall()

_getCheckedMessageCall ( JsUtils  $js = NULL )

protected

Definition at line 48 of file HasCheckboxesTrait.php.

_getCheckedMessageFunction()

_getCheckedMessageFunction ( )

protected

Definition at line 38 of file HasCheckboxesTrait.php.

_runCheckboxes()

_runCheckboxes ( JsUtils  $js )

protected

Definition at line 24 of file HasCheckboxesTrait.php.

_setAllChecked()

_setAllChecked (   $checked )

protected

Definition at line 72 of file HasCheckboxesTrait.php.

addCountCheckedInToolbar()

addCountCheckedInToolbar	(	array	$checkedMessage = null,
			$callback = null
	)

Parameters

array	$checkedMessage
callable	$callback

Definition at line 112 of file HasCheckboxesTrait.php.

addInToolbar()

addInToolbar (   $element,   $callback = NULL  )

abstract

getCheckedMessage()

getCheckedMessage ( )

protected

Definition at line 89 of file HasCheckboxesTrait.php.

getHasCheckboxes()

getHasCheckboxes

(

)

Definition at line 80 of file HasCheckboxesTrait.php.

setCheckedCallback()

setCheckedCallback

(

$checkedCallback

)

Set the callback function that determines whether the checkbox should be checked for an object.

Parameters

callable

$checkedCallback

a callback like function($object) that returns true or false

Definition at line 130 of file HasCheckboxesTrait.php.

setCheckedClass()

setCheckedClass

(

$_checkedClass

)

Definition at line 122 of file HasCheckboxesTrait.php.

setCheckedMessage()

setCheckedMessage

(

array

$_checkedMessage

)

Defines the message displayed when checkboxes are checked or unchecked with an associative array 0=>no selection,1=>one item selected, other=>{count} items selected.

Parameters

array

$_checkedMessage

Returns

\Ajax\semantic\widgets\datatable\DataTable

Definition at line 103 of file HasCheckboxesTrait.php.

setHasCheckboxes()

setHasCheckboxes

(

$_hasCheckboxes

)

Definition at line 84 of file HasCheckboxesTrait.php.

Field Documentation

$_checkedCallback

$_checkedCallback

protected

Definition at line 20 of file HasCheckboxesTrait.php.

$_checkedClass

$_checkedClass

protected

Definition at line 19 of file HasCheckboxesTrait.php.

$_checkedMessage

$_checkedMessage

protected

Definition at line 18 of file HasCheckboxesTrait.php.

$_hasCheckboxes

$_hasCheckboxes

protected

Definition at line 16 of file HasCheckboxesTrait.php.

$_hasCheckedMessage

$_hasCheckedMessage =false

protected

Definition at line 17 of file HasCheckboxesTrait.php.

---

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

• Ajax/semantic/widgets/datatable/HasCheckboxesTrait.php