API17:JHtmlJGrid::state
From Joomla! Documentation
JHtmlJGrid::state
Description
Returns a state on a grid.
Template:Description:JHtmlJGrid::state [Edit Descripton]
Since
Synopsis
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
The Html code
Defined in
libraries/joomla/html/html/jgrid.php
Referenced by
See also
Template:SeeAlso:JHtmlJGrid::state
Examples
<CodeExamplesForm />