API17:JHtmlJGrid::state

JHtmlJGrid::state

Description

Returns a state on a grid.

{{subst:Description:JHtmlJGrid::state}}

public static function state (
        $states
        $value
        $i
        $prefix= ''
        $enabled=true
        $translate=true
        $checkbox='cb'
)

Parameter	Type	Default	Description
$states	array		array of value/state. Each state is an array of the form (task, text, title,html active class, html inactive class) or ('task'=>task, 'text'=>text, 'active_title'=>active title, 'inactive_title'=>inactive title, 'tip'=>boolean, 'active_class'=>html active class, 'inactive_class'=>html inactive class)
$value	int		The state value.
$i	int		The row index
$prefix	array		An optional task prefix or an array of options
$enabled	boolean	true	An optional setting for access control on the action.
$translate	boolean	true	An optional setting for translation.
$checkbox	string	'cb'	An optional prefix for checkboxes.

• Returns The Html code
• Defined on line 84 of libraries/joomla/html/html/jgrid.php
• Since

See also

• JHtmlJGrid::state source code on BitBucket
• Class JHtmlJGrid
• Subpackage Html
• Other versions of JHtmlJGrid::state

{{subst:SeeAlso:JHtmlJGrid::state}}

User contributed notes

<CodeExamplesForm />