JHtmlJGrid::state
From Joomla! Documentation
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JHtmlJGrid::state[edit]
Description[edit]
Returns a state on a grid.
Template:Description:JHtmlJGrid::state [Edit Descripton]
Since[edit]
Synopsis[edit]
public static JHtmlJGrid::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[edit]
The Html code
Defined in[edit]
libraries/joomla/html/html/jgrid.php (line 84)
- see source code in BitBucket
Referenced by[edit]
See also[edit]
Template:SeeAlso:JHtmlJGrid::state
Examples[edit]
<CodeExamplesForm />