Writes the common 'new' icon for the button bar.
static
void
addNew
([string $task = 'add'], [string $alt = 'JTOOLBAR_NEW'], [boolean $check = false])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
-
boolean
$check: True if required to check that a standard list item is checked.
Writes the common 'new' icon for the button bar.
Extended version of addNew() calling hideMainMenu() before Joomla.submitbutton().
static
void
addNewX
([string $task = 'add'], [string $alt = 'JTOOLBAR_NEW'])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a save button for a given option.
Apply operation leads to a save action only (does not leave edit mode).
static
void
apply
([string $task = 'apply'], [string $alt = 'JTOOLBAR_APPLY'])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a common 'archive' button for a list of records.
static
void
archiveList
([string $task = 'archive'], [string $alt = 'JTOOLBAR_ARCHIVE'])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a common 'assign' button for a record.
static
void
assign
([string $task = 'assign'], [string $alt = 'JTOOLBAR_ASSIGN'])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a cancel button that will go back to the previous page without doing any other operation.
static
void
back
([string $alt = 'JTOOLBAR_BACK'], [string $href = 'javascript:history.back();'])
-
string
$alt: Alternative text.
-
string
$href: URL of the href attribute.
Writes a cancel button and invokes a cancel operation (eg a checkin).
static
void
cancel
([string $task = 'cancel'], [string $alt = 'JTOOLBAR_CANCEL'])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a checkin button for a given option.
static
void
checkin
([string $task = 'checkin'], [string $alt = 'JTOOLBAR_CHECKIN'], [boolean $check = true])
-
string
$task
-
string
$alt
-
boolean
$check: True if required to check that a standard list item is checked.
Writes a custom option and task button for the button bar.
static
void
custom
([string $task = ''], [string $icon = ''], [string $iconOver = ''], [string $alt = ''], [bool $listSelect = true])
-
string
$task: The task to perform (picked up by the switch($task) blocks.
-
string
$icon: The image to display.
-
string
$iconOver: The image to display when moused over.
-
string
$alt: The alt text for the icon image.
-
bool
$listSelect: True if required to check that a standard list item is checked.
Writes a custom option and task button for the button bar.
static
void
customX
([string $task = ''], [string $icon = ''], [string $iconOver = ''], [string $alt = ''], [bool $listSelect = true])
-
string
$task: The task to perform (picked up by the switch($task) blocks.
-
string
$icon: The image to display.
-
string
$iconOver: The image to display when moused over.
-
string
$alt: The alt text for the icon image.
-
bool
$listSelect: True if required to check that a standard list item is checked.
Writes a common 'delete' button for a list of records.
static
void
deleteList
([string $msg = ''], [string $task = 'remove'], [string $alt = 'JTOOLBAR_DELETE'])
-
string
$msg: Postscript for the 'are you sure' message.
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a common 'delete' button for a list of records.
Extended version of deleteList() calling hideMainMenu() before Joomla.submitbutton().
static
void
deleteListX
([string $msg = ''], [string $task = 'remove'], [string $alt = 'JTOOLBAR_DELETE'])
-
string
$msg: Postscript for the 'are you sure' message.
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a divider between menu buttons
static
void
divider
()
Writes a common 'edit' button for a template css.
static
void
editCss
([string $task = 'edit_css'], [string $alt = 'JTOOLBAR_EDIT_CSS'])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a common 'edit' button for a template css.
Extended version of editCss() calling hideMainMenu() before Joomla.submitbutton().
static
void
editCssX
([string $task = 'edit_css'], [string $alt = 'JTOOLBAR_EDIT_CSS'])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a common 'edit' button for a template html.
static
void
editHtml
([string $task = 'edit_source'], [string $alt = 'JTOOLBAR_EDIT_HTML'])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a common 'edit' button for a template html.
Extended version of editHtml() calling hideMainMenu() before Joomla.submitbutton().
static
void
editHtmlX
([string $task = 'edit_source'], [string $alt = 'JTOOLBAR_EDIT_HTML'])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a common 'edit' button for a list of records.
static
void
editList
([string $task = 'edit'], [string $alt = 'JTOOLBAR_EDIT'])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a common 'edit' button for a list of records.
Extended version of editList() calling hideMainMenu() before Joomla.submitbutton().
static
void
editListX
([string $task = 'edit'], [string $alt = 'JTOOLBAR_EDIT'])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a preview button for a given option (opens a popup window).
static
void
help
(string $ref, [bool $com = false], [string $override = null], [string $component = null])
-
string
$ref: The name of the popup file (excluding the file extension for an xml file).
-
bool
$com: Use the help file in the component directory.
-
string
$override: Use this URL instead of any other
-
string
$component: Name of component to get Help (null for current component)
Writes a common 'default' button for a record.
static
void
makeDefault
([string $task = 'default'], [string $alt = 'JTOOLBAR_DEFAULT'])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a media_manager button.
static
void
media_manager
([string $directory = ''], [string $alt = 'JTOOLBAR_UPLOAD'])
-
string
$directory: The sub-drectory to upload the media to.
-
string
$alt: An override for the alt text.
Writes a configuration button and invokes a cancel operation (eg a checkin).
static
void
preferences
(string $component, [int $height = '550'], [int $width = '875'], [string $alt = 'JToolbar_Options'], [string $path = ''], [ $onClose = ''])
-
string
$component: The name of the component, eg, com_content.
-
int
$height: The height of the popup.
-
int
$width: The width of the popup.
-
string
$alt: The name of the button.
-
string
$path: An alternative path for the configuation xml relative to JPATH_SITE.
-
$onClose
Writes a preview button for a given option (opens a popup window).
static
void
preview
([string $url = ''], [bool $updateEditors = false])
-
string
$url: The name of the popup file (excluding the file extension)
-
bool
$updateEditors
Writes a common 'publish' button.
static
void
publish
([string $task = 'publish'], [string $alt = 'JTOOLBAR_PUBLISH'], [boolean $check = false])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
-
boolean
$check: True if required to check that a standard list item is checked.
Writes a common 'publish' button for a list of records.
static
void
publishList
([string $task = 'publish'], [string $alt = 'JTOOLBAR_PUBLISH'])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a save button for a given option.
Save operation leads to a save and then close action.
static
void
save
([string $task = 'save'], [string $alt = 'JTOOLBAR_SAVE'])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a save as copy button for a given option.
Save as copy operation leads to a save after clearing the key, then returns user to edit mode with new key.
static
void
save2copy
([string $task = 'save2copy'], [string $alt = 'JTOOLBAR_SAVE_AS_COPY'])
Writes a save and create new button for a given option.
Save and create operation leads to a save and then add action.
static
void
save2new
([string $task = 'save2new'], [string $alt = 'JTOOLBAR_SAVE_AND_NEW'])
Writes a spacer cell.
static
void
spacer
([string $width = ''])
-
string
$width: The width for the cell
Title cell.
For the title and toolbar to be rendered correctly, this title fucntion must be called before the starttable function and the toolbars icons this is due to the nature of how the css has been used to postion the title in respect to the toolbar.
static
void
title
(string $title, [string $icon = 'generic.png'])
-
string
$title: The title.
-
string
$icon: The space-separated names of the image.
Write a trash button that will move items to Trash Manager.
static
void
trash
([string $task = 'remove'], [string $alt = 'JTOOLBAR_TRASH'], [bool $check = true])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
-
bool
$check
Writes an unarchive button for a list of records.
static
void
unarchiveList
([string $task = 'unarchive'], [string $alt = 'JTOOLBAR_UNARCHIVE'])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
Writes a common 'unpublish' button.
static
void
unpublish
([string $task = 'unpublish'], [string $alt = 'JTOOLBAR_UNPUBLISH'], [boolean $check = false])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.
-
boolean
$check: True if required to check that a standard list item is checked.
Writes a common 'unpublish' button for a list of records.
static
void
unpublishList
([string $task = 'unpublish'], [string $alt = 'JTOOLBAR_UNPUBLISH'])
-
string
$task: An override for the task.
-
string
$alt: An override for the alt text.