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