API17:JHtmlJGrid::action
From Joomla! Documentation
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.
JHtmlJGrid::action
Description
Returns an action on a grid.
Description:JHtmlJGrid::action [Edit Descripton]
Since
Synopsis
public static JHtmlJGrid::action ($i, $task, $prefix='', $text='', $active_title='', $inactive_title='', $tip=false, $active_class='', $inactive_class='', $enabled=true, $translate=true, $checkbox='cb')
| Parameter | Type | Default | Description |
|---|---|---|---|
| $i | int | The row index | |
| $task | string | The task to fire | |
| $prefix | array | An optional task prefix or an array of options | |
| $text | string | An optional text to display | |
| $active_title | string | An optional active tooltip to display if $enable is true | |
| $inactive_title | string | An optional inactive tooltip to display if $enable is true | |
| $tip | boolean | false | An optional setting for tooltip |
| $active_class | string | An optional active html class | |
| $inactive_class | string | An optional inactive html class | |
| $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 (line 42)
- see source code in BitBucket
Referenced by
See also
Examples
<CodeExamplesForm />
