JHtmlGrid
Utility class for creating HTML Grids
since |
1.5 |
---|---|
package |
Joomla.Libraries |
Methods
_checkedOut
Method to create a checked out icon with optional overlib in a grid.
_checkedOut( &$row, boolean $overlib = true) : string
since |
1.5 |
---|
Arguments
- $row
- $overlib
boolean
True if an overlib with checkout information should be created.
Response
string
HTMl for the icon and overlib
behavior
Method to build the behavior script and add it to the document head.
behavior() : void
since |
1.6 |
---|---|
deprecated |
4.0 This is only used in hathor and will be removed without replacement |
boolean
Display a boolean setting widget.
boolean(integer $i, integer $value, string $taskOn = null, string $taskOff = null) : string
since |
1.6 |
---|---|
deprecated |
4.0 This is only used in hathor and will be removed without replacement |
Arguments
- $i
integer
The row index.- $value
integer
The value of the boolean field.- $taskOn
string
Task to turn the boolean setting on.- $taskOff
string
Task to turn the boolean setting off.
Response
string
The boolean setting widget.
checkall
Method to check all checkboxes in a grid
checkall(string $name = 'checkall-toggle', string $tip = 'JGLOBAL_CHECK_ALL', string $action = 'Joomla.checkAll(this)') : string
since |
3.1.2 |
---|
Arguments
- $name
string
The name of the form element- $tip
string
The text shown as tooltip title instead of $tip- $action
string
The action to perform on clicking the checkbox
Response
string
checkedOut
Displays a checked out icon.
checkedOut( &$row, integer $i, string $identifier = 'id') : string
since |
1.5 |
---|
Arguments
- $row
- $i
integer
The index of the row.- $identifier
string
The property name of the primary key or index of the row.
Response
string
id
Method to create a checkbox for a grid row.
id(integer $rowNum, integer $recId, boolean $checkedOut = false, string $name = 'cid', string $stub = 'cb') : mixed
since |
1.5 |
---|
Arguments
- $rowNum
integer
The row index- $recId
integer
The record id- $checkedOut
boolean
True if item is checked out- $name
string
The name of the form element- $stub
string
The name of stub identifier
Response
mixed
String of html with a checkbox if item is not checked out, null if checked out.
order
Method to create an icon for saving a new ordering in a grid
order(array $rows, string $image = 'filesave.png', string $task = 'saveorder') : string
since |
1.5 |
---|
Arguments
- $rows
array
The array of rows of rows- $image
string
The image [UNUSED]- $task
string
The task to use, defaults to save order
Response
string
published
Method to create a clickable icon to change the state of an item
published(mixed $value, integer $i, string $img1 = 'tick.png', string $img0 = 'publish_x.png', string $prefix = '') : string
since |
1.5 |
---|
Arguments
- $value
mixed
Either the scalar value or an object (for backward compatibility, deprecated)- $i
integer
The index- $img1
string
Image for a positive or on value- $img0
string
Image for the empty or off value- $prefix
string
An optional prefix for the task
Response
string
sort
Method to sort a column in a grid
sort(string $title, string $order, string $direction = 'asc', string $selected = '', string $task = null, string $newDirection = 'asc', string $tip = '', string $form = null) : string
since |
1.5 |
---|
Arguments
- $title
string
The link title- $order
string
The order field for the column- $direction
string
The current direction- $selected
string
The selected ordering- $task
string
An optional task override- $newDirection
string
An optional direction for the new column- $tip
string
An optional text shown as tooltip title instead of $title- $form
string
An optional form selector
Response
string
state
Method to create a select list of states for filtering By default the filter shows only published and unpublished items
state(string $filterState = '*', string $published = 'JPUBLISHED', string $unpublished = 'JUNPUBLISHED', string $archived = null, string $trashed = null) : string
since |
1.5 |
---|
Arguments
- $filterState
string
The initial filter state- $published
string
The JText string for published- $unpublished
string
The JText string for Unpublished- $archived
string
The JText string for Archived- $trashed
string
The JText string for Trashed
Response
string