Class JToolBarHelper

Description

Utility class for the button bar.

  • abstract:

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


	
			
Method Summary
static void addNew ([string $task = 'add'], [string $alt = 'JTOOLBAR_NEW'], [boolean $check = false])
static void addNewX ([string $task = 'add'], [string $alt = 'JTOOLBAR_NEW'])
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 customX ([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 deleteListX ([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 editCssX ([string $task = 'edit_css'], [string $alt = 'JTOOLBAR_EDIT_CSS'])
static void editHtml ([string $task = 'edit_source'], [string $alt = 'JTOOLBAR_EDIT_HTML'])
static void editHtmlX ([string $task = 'edit_source'], [string $alt = 'JTOOLBAR_EDIT_HTML'])
static void editList ([string $task = 'edit'], [string $alt = 'JTOOLBAR_EDIT'])
static void editListX ([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 preferences (string $component, [int $height = '550'], [int $width = '875'], [string $alt = 'JToolbar_Options'], [string $path = ''], [ $onClose = ''])
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'])
Methods
static method addNew (line 201)

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

  • since: 1.0
  • 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 method addNewX (line 217)

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

Extended version of addNew() calling hideMainMenu() before Joomla.submitbutton().

  • deprecated:
  • since: 1.0
  • access: public
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.
static method apply (line 449)

Writes a save button for a given option.

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

  • since: 1.0
  • 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 method archiveList (line 287)

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

  • since: 1.0
  • 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 method assign (line 186)

Writes a common 'assign' button for a record.

  • since: 1.0
  • 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 method back (line 144)

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

  • since: 1.0
  • 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 method cancel (line 524)

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

  • since: 1.0
  • 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 method checkin (line 510)

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
  • string $alt
  • boolean $check: True if required to check that a standard list item is checked.
static method custom (line 79)

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

  • since: 1.0
  • 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 method customX (line 101)

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

  • deprecated:
  • since: 1.0
  • access: public
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.
static method deleteList (line 400)

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

  • since: 1.0
  • 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 method deleteListX (line 421)

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

Extended version of deleteList() calling hideMainMenu() before Joomla.submitbutton().

  • deprecated:
  • since: 1.0
  • access: public
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.
static method divider (line 62)

Writes a divider between menu buttons

  • since: 1.0
  • access: public
static void divider ()
static method editCss (line 371)

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

  • since: 1.0
  • 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 method editCssX (line 387)

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

Extended version of editCss() calling hideMainMenu() before Joomla.submitbutton().

  • deprecated:
  • since: 1.0
  • access: public
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.
static method editHtml (line 343)

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

  • since: 1.0
  • 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 method editHtmlX (line 359)

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

Extended version of editHtml() calling hideMainMenu() before Joomla.submitbutton().

  • deprecated:
  • since: 1.0
  • access: public
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.
static method editList (line 315)

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

  • since: 1.0
  • 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 method editListX (line 331)

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

Extended version of editList() calling hideMainMenu() before Joomla.submitbutton().

  • deprecated:
  • since: 1.0
  • access: public
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.
static method help (line 129)

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

  • since: 1.0
  • 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 method makeDefault (line 172)

Writes a common 'default' button for a record.

  • since: 1.0
  • 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 method media_manager (line 158)

Writes a media_manager button.

  • since: 1.0
  • access: public
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.
static method preferences (line 541)

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

  • since: 1.0
  • access: public
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
static method preview (line 113)

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

  • since: 1.0
  • access: public
static void preview ([string $url = ''], [bool $updateEditors = false])
  • string $url: The name of the popup file (excluding the file extension)
  • bool $updateEditors
static method publish (line 230)

Writes a common 'publish' button.

  • since: 1.0
  • 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 method publishList (line 244)

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

  • since: 1.0
  • 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 method save (line 464)

Writes a save button for a given option.

Save operation leads to a save and then close action.

  • since: 1.0
  • 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 method save2copy (line 495)

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
  • string $alt
static method save2new (line 479)

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
  • string $alt
static method spacer (line 50)

Writes a spacer cell.

  • since: 1.0
  • access: public
static void spacer ([string $width = ''])
  • string $width: The width for the cell
static method title (line 30)

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 method trash (line 434)

Write a trash button that will move items to Trash Manager.

  • since: 1.0
  • 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
static method unarchiveList (line 301)

Writes an unarchive button for a list of records.

  • since: 1.0
  • 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 method unpublish (line 259)

Writes a common 'unpublish' button.

  • since: 1.0
  • 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 method unpublishList (line 273)

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

  • since: 1.0
  • 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.

Documentation generated on Mon, 25 Jun 2012 14:00:13 -0500 by phpDocumentor 1.4.4