Joomla! API

Writes the common 'new' icon for the button bar.

addNew(string task = 'add', string alt = 'JTOOLBAR_NEW', bool check = false) : void

static

since	1.5

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.
check: boolTrue if required to check that a standard list item is checked.

Writes a save button for a given option.

apply(string task = 'apply', string alt = 'JTOOLBAR_APPLY') : void

static

Apply operation leads to a save action only (does not leave edit mode).

since	1.5

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.

Writes a common 'archive' button for a list of records.

archiveList(string task = 'archive', string alt = 'JTOOLBAR_ARCHIVE') : void

static

since	1.5

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.

Writes a common 'assign' button for a record.

assign(string task = 'assign', string alt = 'JTOOLBAR_ASSIGN') : void

static

since	1.5

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.

Writes a cancel button that will go back to the previous page without doing any other operation.

back(string alt = 'JTOOLBAR_BACK', string href = 'javascript:history.back();') : void

static

since	1.5

Arguments

alt: stringAlternative text.
href: stringURL of the href attribute.

Writes a cancel button and invokes a cancel operation (eg a checkin).

cancel(string task = 'cancel', string alt = 'JTOOLBAR_CANCEL') : void

static

since	1.5

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.

Writes a checkin button for a given option.

checkin(string task = 'checkin', string alt = 'JTOOLBAR_CHECKIN', bool check = true) : void

static

since	1.7

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.
check: boolTrue if required to check that a standard list item is checked.

Writes a custom option and task button for the button bar.

custom(string task = '', string icon = '', string iconOver = '', string alt = '', bool listSelect = true, string formId = null) : void

static

since	1.5

Arguments

task: stringThe task to perform (picked up by the switch($task) blocks).
icon: stringThe image to display.
iconOver: string@deprecated 5.0
alt: stringThe alt text for the icon image.
listSelect: boolTrue if required to check that a standard list item is checked.
formId: stringThe id of action form.

Writes a common 'delete' button for a list of records.

deleteList(string msg = '', string task = 'remove', string alt = 'JTOOLBAR_DELETE') : void

static

since	1.5

Arguments

msg: stringPostscript for the 'are you sure' message.
task: stringAn override for the task.
alt: stringAn override for the alt text.

Writes a divider between menu buttons

divider() : void

static

since	1.5

Writes a common 'edit' button for a template css.

editCss(string task = 'edit_css', string alt = 'JTOOLBAR_EDIT_CSS') : void

static

since	1.5

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.

Writes a common 'edit' button for a template html.

editHtml(string task = 'edit_source', string alt = 'JTOOLBAR_EDIT_HTML') : void

static

since	1.5

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.

Writes a common 'edit' button for a list of records.

editList(string task = 'edit', string alt = 'JTOOLBAR_EDIT') : void

static

since	1.5

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.

Writes a help button for a given option (opens a popup window).

help(string ref, bool com = false, string override = null, string component = null) : void

static

since	1.5

Arguments

ref: stringThe name of the popup file (excluding the file extension for an xml file).
com: boolUse the help file in the component directory.
override: stringUse this URL instead of any other
component: stringName of component to get Help (null for current component)

Writes a help button for showing/hiding the inline help of a form

inlinehelp(string class = "hide-aware-inline-help") : void

static

since	4.1.0

Arguments

class: stringThe class used by the inline help items.

Writes a jooa11y accessibility checker button for a given option (opens a popup window).

jooa11y(string url = '', bool updateEditors = false, string icon = 'icon-universal-access', int bodyHeight = null, int modalWidth = null) : void

static

since	4.1.0

Arguments

url: stringThe url to open
updateEditors: boolUnused
icon: stringThe image to display.
bodyHeight: intThe body height of the preview popup
modalWidth: intThe modal width of the preview popup

Creates a button to redirect to a link

link(string url, string text, string name = 'link') : void

static

since	3.5

Arguments

url: stringThe link url
text: stringButton text
name: stringName to be used as apart of the id

Writes a common 'default' button for a record.

makeDefault(string task = 'default', string alt = 'JTOOLBAR_DEFAULT') : void

static

since	1.5

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.

Writes a media_manager button.

media_manager(string directory = '', string alt = 'JTOOLBAR_UPLOAD') : void

static

since	1.5

Arguments

directory: stringThe subdirectory to upload the media to.
alt: stringAn override for the alt text.

Displays a modal button

modal(string targetModalId, string icon, string alt, string class = 'btn-primary') : void

static

since	3.2

Arguments

targetModalId: stringID of the target modal box
icon: stringIcon class to show on modal button
alt: stringTitle for the modal button
class: stringThe button class

Writes a configuration button and invokes a cancel operation (eg a checkin).

preferences(string component, int height = 550, int width = 875, string alt = 'JTOOLBAR_OPTIONS', string path = '') : void

static

since	1.5

Arguments

component: stringThe name of the component, eg, com_content.
height: intThe height of the popup. [UNUSED]
width: intThe width of the popup. [UNUSED]
alt: stringThe name of the button.
path: stringAn alternative path for the configuration xml relative to JPATH_SITE.

Writes a preview button for a given option (opens a popup window).

preview(string url = '', bool updateEditors = false, string icon = 'preview', int bodyHeight = null, int modalWidth = null) : void

static

since	1.5

Arguments

url: stringThe name of the popup file (excluding the file extension)
updateEditors: boolUnused
icon: stringThe image to display.
bodyHeight: intThe body height of the preview popup
modalWidth: intThe modal width of the preview popup

Writes a common 'publish' button.

publish(string task = 'publish', string alt = 'JTOOLBAR_PUBLISH', bool check = false) : void

static

since	1.5

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.
check: boolTrue if required to check that a standard list item is checked.

Writes a common 'publish' button for a list of records.

publishList(string task = 'publish', string alt = 'JTOOLBAR_PUBLISH') : void

static

since	1.5

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.

Writes a save button for a given option.

save(string task = 'save', string alt = 'JTOOLBAR_SAVE') : void

static

Save operation leads to a save and then close action.

since	1.5

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.

Writes a save as copy button for a given option.

save2copy(string task = 'save2copy', string alt = 'JTOOLBAR_SAVE_AS_COPY') : void

static

Save as copy operation leads to a save after clearing the key, then returns user to edit mode with new key.

since	1.6

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.

Writes a save and create new button for a given option.

save2new(string task = 'save2new', string alt = 'JTOOLBAR_SAVE_AND_NEW') : void

static

Save and create operation leads to a save and then add action.

since	1.6

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.

Writes a save button for a given option, with an additional dropdown

saveGroup(array buttons = array(), string class = 'btn-success') : void

static

since	4.0.0

Arguments

buttons: arrayAn array of buttons
class: stringThe button class

Writes a spacer cell.

spacer(string width = '') : void

static

since	1.5

Arguments

width: stringThe width for the cell

Title cell.

title(string title, string icon = 'generic.png') : void

static

For the title and toolbar to be rendered correctly, this title function 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 position the title in respect to the toolbar.

since	1.5

Arguments

title: stringThe title.
icon: stringThe space-separated names of the image.

Writes a common 'trash' button for a list of records.

trash(string task = 'remove', string alt = 'JTOOLBAR_TRASH', bool check = true) : void

static

since	1.5

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.
check: boolTrue to allow lists.

Writes an unarchive button for a list of records.

unarchiveList(string task = 'unarchive', string alt = 'JTOOLBAR_UNARCHIVE') : void

static

since	1.5

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.

Writes a common 'unpublish' button.

unpublish(string task = 'unpublish', string alt = 'JTOOLBAR_UNPUBLISH', bool check = false) : void

static

since	1.5

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.
check: boolTrue if required to check that a standard list item is checked.

Writes a common 'unpublish' button for a list of records.

unpublishList(string task = 'unpublish', string alt = 'JTOOLBAR_UNPUBLISH') : void

static

since	1.5

Arguments

task: stringAn override for the task.
alt: stringAn override for the alt text.

Writes a version history

versions(string typeAlias, int itemId, int height = 800, int width = 500, string alt = 'JTOOLBAR_VERSIONS') : void

static

since	3.2

Arguments

typeAlias: stringThe component and type, for example 'com_content.article'
itemId: intThe id of the item, for example the article id.
height: intThe height of the popup.
width: intThe width of the popup.
alt: stringThe name of the button.

since	1.5
package	Joomla CMS

ToolbarHelper

Methods

addNew

Arguments

apply

Arguments

archiveList

Arguments

assign

Arguments

back

Arguments

cancel

Arguments

checkin

Arguments

custom

Arguments

deleteList

Arguments

divider

editCss

Arguments

editHtml

Arguments

editList

Arguments

help

Arguments

inlinehelp

Arguments

jooa11y

Arguments

link

Arguments

makeDefault

Arguments

media_manager

Arguments

modal

Arguments

preferences

Arguments

preview

Arguments

publish

Arguments

publishList

Arguments

save

Arguments

save2copy

Arguments

save2new

Arguments

saveGroup

Arguments

spacer

Arguments

title

Arguments

trash

Arguments

unarchiveList

Arguments

unpublish

Arguments

unpublishList

Arguments

versions

Arguments