Docs For Class JHtmlJGrid

JHtmlJGrid

Description

Utility class for creating HTML Grids

abstract:
since: 1.6

Located in /libraries/cms/html/jgrid.php (line 19)

Method Summary

static string action (integer $i, string $task, [string|array $prefix = ''], [string $text = ''], [string $active_title = ''], [string $inactive_title = ''], [boolean $tip = false], [string $active_class = ''], [string $inactive_class = ''], [boolean $enabled = true], [boolean $translate = true], [string $checkbox = 'cb'])

static string checkedout (integer $i, string $editorName, string $time, [string|array $prefix = ''], [boolean $enabled = false], [string $checkbox = 'cb'])

static string isdefault (integer $value, integer $i, [string|array $prefix = ''], [boolean $enabled = true], [string $checkbox = 'cb'])

static string orderDown (integer $i, [string $task = 'orderdown'], [string|array $prefix = ''], [string $text = 'JLIB_HTML_MOVE_DOWN'], [boolean $enabled = true], [string $checkbox = 'cb'])

static string orderUp (integer $i, [string $task = 'orderup'], [string|array $prefix = ''], [string $text = 'JLIB_HTML_MOVE_UP'], [boolean $enabled = true], [string $checkbox = 'cb'])

static string published (integer $value, integer $i, [string|array $prefix = ''], [boolean $enabled = true], [string $checkbox = 'cb'], [string $publish_up = null], [string $publish_down = null])

static string publishedOptions ([array $config = array()])

static string state (array $states, integer $value, integer $i, [string|array $prefix = ''], [boolean $enabled = true], [boolean $translate = true], [string $checkbox = 'cb'])

Methods

static action (line 41)

Returns an action on a grid

return: The HTML markup
since: 1.6
access: public

integer $i: The row index
string $task: The task to fire
string|array $prefix: An optional task prefix or an array of options
string $text: An optional text to display [unused - @deprecated 4.0]
string $active_title: An optional active tooltip to display if $enable is true
string $inactive_title: An optional inactive tooltip to display if $enable is true
boolean $tip: An optional setting for tooltip
string $active_class: An optional active HTML class
string $inactive_class: An optional inactive HTML class
boolean $enabled: An optional setting for access control on the action.
boolean $translate: An optional setting for translation.
string $checkbox: An optional prefix for checkboxes.

static checkedout (line 327)

Returns a checked-out icon

return: The HTML markup
since: 1.6
access: public

static string checkedout (integer $i, string $editorName, string $time, [string|array $prefix = ''], [boolean $enabled = false], [string $checkbox = 'cb'])

integer $i: The row index.
string $editorName: The name of the editor.
string $time: The time that the object was checked out.
string|array $prefix: An optional task prefix or an array of options
boolean $enabled: True to enable the action.
string $checkbox: An optional prefix for checkboxes.

static isdefault (line 250)

Returns a isDefault state on a grid

return: The HTML markup
see: JHtmlJGrid::state()
since: 1.6
access: public

static string isdefault (integer $value, integer $i, [string|array $prefix = ''], [boolean $enabled = true], [string $checkbox = 'cb'])

integer $value: The state value.
integer $i: The row index
string|array $prefix: An optional task prefix or an array of options
boolean $enabled: An optional setting for access control on the action.
string $checkbox: An optional prefix for checkboxes.

static orderDown (line 390)

Creates a order-down action icon.

return: The HTML markup
since: 1.6
access: public

static string orderDown (integer $i, [string $task = 'orderdown'], [string|array $prefix = ''], [string $text = 'JLIB_HTML_MOVE_DOWN'], [boolean $enabled = true], [string $checkbox = 'cb'])

integer $i: The row index.
string $task: An optional task to fire.
string|array $prefix: An optional task prefix or an array of options
string $text: An optional text to display
boolean $enabled: An optional setting for access control on the action.
string $checkbox: An optional prefix for checkboxes.

static orderUp (line 363)

Creates a order-up action icon.

return: The HTML markup
since: 1.6
access: public

static string orderUp (integer $i, [string $task = 'orderup'], [string|array $prefix = ''], [string $text = 'JLIB_HTML_MOVE_UP'], [boolean $enabled = true], [string $checkbox = 'cb'])

integer $i: The row index.
string $task: An optional task to fire.
string|array $prefix: An optional task prefix or an array of options
string $text: An optional text to display
boolean $enabled: An optional setting for access control on the action.
string $checkbox: An optional prefix for checkboxes.

static published (line 158)

Returns a published state on a grid

return: The HTML markup
see: JHtmlJGrid::state()
since: 1.6
access: public

static string published (integer $value, integer $i, [string|array $prefix = ''], [boolean $enabled = true], [string $checkbox = 'cb'], [string $publish_up = null], [string $publish_down = null])

integer $value: The state value.
integer $i: The row index
string|array $prefix: An optional task prefix or an array of options
boolean $enabled: An optional setting for access control on the action.
string $checkbox: An optional prefix for checkboxes.
string $publish_up: An optional start publishing date.
string $publish_down: An optional finish publishing date.

static publishedOptions (line 280)

Returns an array of standard published state filter options.

return: The HTML markup
since: 1.6
access: public

static string publishedOptions ([array $config = array()])

array $config: An array of configuration options. This array can contain a list of key/value pairs where values are boolean and keys can be taken from 'published', 'unpublished', 'archived', 'trash', 'all'. These pairs determine which values are displayed.

static state (line 117)

Returns a state on a grid

return: The HTML markup
since: 1.6
access: public

static string state (array $states, integer $value, integer $i, [string|array $prefix = ''], [boolean $enabled = true], [boolean $translate = true], [string $checkbox = 'cb'])

array $states: 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)
integer $value: The state value.
integer $i: The row index
string|array $prefix: An optional task prefix or an array of options
boolean $enabled: An optional setting for access control on the action.
boolean $translate: An optional setting for translation.
string $checkbox: An optional prefix for checkboxes.

Documentation generated on Tue, 19 Nov 2013 15:06:04 +0100 by phpDocumentor 1.4.3