Документация по Joomla 1.7

Joomla.Platform\JHtmlJGrid
libraries/joomla/html/html/jgrid.php at line 19

Class JHtmlJGrid

JHtmlJGrid

public abstract class JHtmlJGrid

Utility class for creating HTML Grids

Subpackage:
HTML
Since:
11.1

Method Summary
static string

action(integer i, string task, string|array prefix, string text, string active_title, string inactive_title, boolean tip, string active_class, string inactive_class, boolean enabled, boolean translate, string checkbox)

Returns an action on a grid

static string

state(array states, integer value, integer i, string|array prefix, boolean enabled, boolean translate, string checkbox)

Returns a state on a grid

static string

published(integer value, integer i, string|array prefix, boolean enabled, string checkbox, string publish_up, string publish_down)

Returns a published state on a grid

static The

isdefault(integer value, integer i, string|array prefix, boolean enabled, string checkbox)

Returns a isDefault state on a grid

static string

publishedOptions(array An, mixed config)

Returns an array of standard published state filter options.

static string

checkedout(integer i, string editorName, string time, string|array prefix, string text, boolean enabled, str checkbox)

Returns a checked-out icon

static string

orderUp(integer i, string task, string|array prefix, string text, boolean enabled, string checkbox)

Creates a order-up action icon.

static string

orderDown(integer i, string task, string|array prefix, string text, boolean enabled, string checkbox)

Creates a order-down action icon.

Method Detail

libraries/joomla/html/html/jgrid.php at line 41

action

public static string action(integer i, string task, string|array prefix, string text, string active_title, string inactive_title, boolean tip, string active_class, string inactive_class, boolean enabled, boolean translate, string checkbox)

Returns an action on a grid

Parameters:
i - The row index
task - The task to fire
prefix - An optional task prefix or an array of options
text - An optional text to display
active_title - An optional active tooltip to display if $enable is true
inactive_title - An optional inactive tooltip to display if $enable is true
tip - An optional setting for tooltip
active_class - An optional active HTML class
inactive_class - An optional inactive HTML class
enabled - An optional setting for access control on the action.
translate - An optional setting for translation.
checkbox - An optional prefix for checkboxes.
Returns:
The Html code
Since:
11.1

libraries/joomla/html/html/jgrid.php at line 97

state

public static string state(array states, integer value, integer i, string|array prefix, boolean enabled, boolean translate, string checkbox)

Returns a state on a grid

Parameters:
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)
value - The state value.
i - The row index
prefix - An optional task prefix or an array of options
enabled - An optional setting for access control on the action.
translate - An optional setting for translation.
checkbox - An optional prefix for checkboxes.
Returns:
The Html code
Since:
11.1

libraries/joomla/html/html/jgrid.php at line 135

published

public static string published(integer value, integer i, string|array prefix, boolean enabled, string checkbox, string publish_up, string publish_down)

Returns a published state on a grid

Parameters:
value - The state value.
i - The row index
prefix - An optional task prefix or an array of options
enabled - An optional setting for access control on the action.
checkbox - An optional prefix for checkboxes.
publish_up - An optional start publishing date.
publish_down - An optional finish publishing date.
Returns:
The Html code
See Also:
JHtmlJGrid::state
Since:
11.1

libraries/joomla/html/html/jgrid.php at line 216

isdefault

public static The isdefault(integer value, integer i, string|array prefix, boolean enabled, string checkbox)

Returns a isDefault state on a grid

Parameters:
value - The state value.
i - The row index
prefix - An optional task prefix or an array of options
enabled - An optional setting for access control on the action.
checkbox - An optional prefix for checkboxes.
Returns:
Html code
Since:
11.1
See Also:
JHtmlJGrid::state

libraries/joomla/html/html/jgrid.php at line 242

publishedOptions

public static string publishedOptions(array An, mixed config)

Returns an array of standard published state filter options.

Parameters:
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.
Returns:
The HTML code for the select tag
Since:
11.1

libraries/joomla/html/html/jgrid.php at line 278

checkedout

public static string checkedout(integer i, string editorName, string time, string|array prefix, string text, boolean enabled, str checkbox)

Returns a checked-out icon

Parameters:
i - The row index.
editorName - The name of the editor.
time - The time that the object was checked out.
prefix - An optional task prefix or an array of options
text - The text to display
enabled - True to enable the action.
Returns:
The required HTML.
Since:
11.1

libraries/joomla/html/html/jgrid.php at line 309

orderUp

public static string orderUp(integer i, string task, string|array prefix, string text, boolean enabled, string checkbox)

Creates a order-up action icon.

Parameters:
i - The row index.
task - An optional task to fire.
prefix - An optional task prefix or an array of options
text - An optional text to display
enabled - An optional setting for access control on the action.
checkbox - An optional prefix for checkboxes.
Returns:
The required HTML.
Since:
11.1

libraries/joomla/html/html/jgrid.php at line 335

orderDown

public static string orderDown(integer i, string task, string|array prefix, string text, boolean enabled, string checkbox)

Creates a order-down action icon.

Parameters:
i - The row index.
task - An optional task to fire.
prefix - An optional task prefix or an array of options
text - An optional text to display
enabled - An optional setting for access control on the action.
checkbox - An optional prefix for checkboxes.
Returns:
The required HTML.
Since:
11.1

Документация по Joomla 1.7