Docs For Class JToolbarHelper

JToolbarHelper

Description

Utility class for the button bar.

abstract:
since: 1.5

Located in /administrator/includes/toolbar.php (line 17)

Method Summary

static void addNew ([string $task = 'add'], [string $alt = 'JTOOLBAR_NEW'], [boolean $check = false])

static void apply ([string $task = 'apply'], [string $alt = 'JTOOLBAR_APPLY'])

static void archiveList ([string $task = 'archive'], [string $alt = 'JTOOLBAR_ARCHIVE'])

static void assign ([string $task = 'assign'], [string $alt = 'JTOOLBAR_ASSIGN'])

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

static void cancel ([string $task = 'cancel'], [string $alt = 'JTOOLBAR_CANCEL'])

static void checkin ([string $task = 'checkin'], [string $alt = 'JTOOLBAR_CHECKIN'], [boolean $check = true])

static void custom ([string $task = ''], [string $icon = ''], [string $iconOver = ''], [string $alt = ''], [bool $listSelect = true])

static void deleteList ([string $msg = ''], [string $task = 'remove'], [string $alt = 'JTOOLBAR_DELETE'])

static void divider ()

static void editCss ([string $task = 'edit_css'], [string $alt = 'JTOOLBAR_EDIT_CSS'])

static void editHtml ([string $task = 'edit_source'], [string $alt = 'JTOOLBAR_EDIT_HTML'])

static void editList ([string $task = 'edit'], [string $alt = 'JTOOLBAR_EDIT'])

static void help (string $ref, [bool $com = false], [string $override = null], [string $component = null])

static void makeDefault ([string $task = 'default'], [string $alt = 'JTOOLBAR_DEFAULT'])

static void media_manager ([string $directory = ''], [string $alt = 'JTOOLBAR_UPLOAD'])

static void modal (string $targetModalId, string $icon, string $alt)

static void preferences (string $component, [integer $height = '550'], [integer $width = '875'], [string $alt = 'JToolbar_Options'], [string $path = ''])

static void preview ([string $url = ''], [bool $updateEditors = false])

static void publish ([string $task = 'publish'], [string $alt = 'JTOOLBAR_PUBLISH'], [boolean $check = false])

static void publishList ([string $task = 'publish'], [string $alt = 'JTOOLBAR_PUBLISH'])

static void save ([string $task = 'save'], [string $alt = 'JTOOLBAR_SAVE'])

static void save2copy ([string $task = 'save2copy'], [string $alt = 'JTOOLBAR_SAVE_AS_COPY'])

static void save2new ([string $task = 'save2new'], [string $alt = 'JTOOLBAR_SAVE_AND_NEW'])

static void spacer ([string $width = ''])

static void title (string $title, [string $icon = 'generic.png'])

static void trash ([string $task = 'remove'], [string $alt = 'JTOOLBAR_TRASH'], [bool $check = true])

static void unarchiveList ([string $task = 'unarchive'], [string $alt = 'JTOOLBAR_UNARCHIVE'])

static void unpublish ([string $task = 'unpublish'], [string $alt = 'JTOOLBAR_UNPUBLISH'], [boolean $check = false])

static void unpublishList ([string $task = 'unpublish'], [string $alt = 'JTOOLBAR_UNPUBLISH'])

static void versions (string $typeAlias, integer $itemId, [integer $height = 800], [integer $width = 500], [string $alt = 'JTOOLBAR_VERSIONS'])

Methods

static addNew (line 220)

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

since: 1.5
access: public

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.

static apply (line 448)

Writes a save button for a given option.

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

since: 1.5
access: public

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.

static archiveList (line 312)

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

since: 1.5
access: public

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.

static assign (line 201)

Writes a common 'assign' button for a record.

since: 1.5
access: public

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.

static back (line 147)

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

since: 1.5
access: public

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

string $alt: Alternative text.
string $href: URL of the href attribute.

static cancel (line 543)

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

since: 1.5
access: public

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.

static checkin (line 525)

Writes a checkin button for a given option.

since: 1.7
access: public

static void checkin ([string $task = 'checkin'], [string $alt = 'JTOOLBAR_CHECKIN'], [boolean $check = true])

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.

static custom (line 87)

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

since: 1.5
access: public

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.

static deleteList (line 403)

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

since: 1.5
access: public

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.

static divider (line 66)

Writes a divider between menu buttons

since: 1.5
access: public

static void divider ()

static editCss (line 384)

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

since: 1.5
access: public

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.

static editHtml (line 366)

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

since: 1.5
access: public

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.

static editList (line 348)

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

since: 1.5
access: public

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.

static help (line 128)

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

since: 1.5
access: public

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)

static makeDefault (line 183)

Writes a common 'default' button for a record.

since: 1.5
access: public

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.

static media_manager (line 165)

Writes a media_manager button.

since: 1.5
access: public

static void media_manager ([string $directory = ''], [string $alt = 'JTOOLBAR_UPLOAD'])

string $directory: The sub-directory to upload the media to.
string $alt: An override for the alt text.

static modal (line 627)

Displays a modal button

since: 3.2
access: public

static void modal (string $targetModalId, string $icon, string $alt)

string $targetModalId: ID of the target modal box
string $icon: Icon class to show on modal button
string $alt: Title for the modal button

static preferences (line 564)

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

since: 1.5
access: public

static void preferences (string $component, [integer $height = '550'], [integer $width = '875'], [string $alt = 'JToolbar_Options'], [string $path = ''])

string $component: The name of the component, eg, com_content.
integer $height: The height of the popup. [UNUSED]
integer $width: The width of the popup. [UNUSED]
string $alt: The name of the button.
string $path: An alternative path for the configuation xml relative to JPATH_SITE.

static preview (line 108)

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

since: 1.5
access: public

static void preview ([string $url = ''], [bool $updateEditors = false])

string $url: The name of the popup file (excluding the file extension)
bool $updateEditors: Unused

static publish (line 239)

Writes a common 'publish' button.

since: 1.5
access: public

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.

static publishList (line 257)

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

since: 1.5
access: public

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.

static save (line 467)

Writes a save button for a given option.

Save operation leads to a save and then close action.

since: 1.5
access: public

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.

static save2copy (line 506)

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.

since: 1.6
access: public

static void save2copy ([string $task = 'save2copy'], [string $alt = 'JTOOLBAR_SAVE_AS_COPY'])

string $task: An override for the task.
string $alt: An override for the alt text.

static save2new (line 486)

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

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

since: 1.6
access: public

static void save2new ([string $task = 'save2new'], [string $alt = 'JTOOLBAR_SAVE_AND_NEW'])

string $task: An override for the task.
string $alt: An override for the alt text.

static spacer (line 51)

Writes a spacer cell.

since: 1.5
access: public

static void spacer ([string $width = ''])

string $width: The width for the cell

static title (line 32)

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.

since: 1.5
access: public

static void title (string $title, [string $icon = 'generic.png'])

string $title: The title.
string $icon: The space-separated names of the image.

static trash (line 429)

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

since: 1.5
access: public

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: True to allow lists.

static unarchiveList (line 330)

Writes an unarchive button for a list of records.

since: 1.5
access: public

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.

static unpublish (line 276)

Writes a common 'unpublish' button.

since: 1.5
access: public

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.

static unpublishList (line 294)

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

since: 1.5
access: public

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.

static versions (line 595)

Writes a version history

since: 3.2
access: public

static void versions (string $typeAlias, integer $itemId, [integer $height = 800], [integer $width = 500], [string $alt = 'JTOOLBAR_VERSIONS'])

string $typeAlias: The component and type, for example 'com_content.article'
integer $itemId: The id of the item, for example the article id.
integer $height: The height of the popup.
integer $width: The width of the popup.
string $alt: The name of the button.

Documentation generated on Tue, 19 Nov 2013 15:15:54 +0100 by phpDocumentor 1.4.3