Actions

Difference between revisions of "JToolBarHelper"

From Joomla! Documentation

(New page: '''JToolbarHelper''' is not part of the Joomla API library. It can be understood as a helper class to simplify the creation of Toolbar titles, buttons, spacers and dividers in the Admin In...)
 
(3 intermediate revisions by one user not shown)
Line 1: Line 1:
'''JToolbarHelper''' is not part of the Joomla API library. It can be understood as a helper class to simplify the creation of Toolbar titles, buttons, spacers and dividers in the Admin Interface of the Joomla Backend. It can, however, also [[How to use the JToolBar class in the frontend|be used in the Joomla Frontend]].  
+
'''JToolbarHelper''' is not part of the Joomla API library. It can be understood as a helper class to simplify the creation of Toolbar titles, buttons, spacers and dividers in the Admin Interface of the Joomla Backend. You can, however, [[How to use the JToolBar class in the frontend|create your own Helper class for JToolBar]] for use in the frontend.  
  
 
===Defined in===
 
===Defined in===
Line 106: Line 106:
 
|Writes a configuration button and invokes a cancel operation (eg a checkin)
 
|Writes a configuration button and invokes a cancel operation (eg a checkin)
 
|}
 
|}
===Importing===
 
<source lang="php">jimport( 'joomla.error.error' );</source>
 
  
 
===See also===
 
===See also===
 
* [[JToolBar]]
 
* [[JToolBar]]
<noinclude>[[Category:Development]][[Category:Framework]][[Category:JToolBarHelper]]</noinclude>
+
<noinclude>[[Category:Development]][[Category:JToolBarHelper]]</noinclude>

Revision as of 04:14, 9 February 2009

JToolbarHelper is not part of the Joomla API library. It can be understood as a helper class to simplify the creation of Toolbar titles, buttons, spacers and dividers in the Admin Interface of the Joomla Backend. You can, however, create your own Helper class for JToolBar for use in the frontend.

Defined in

administrator/includes/toolbar.php

Methods

Method name Description
title Creates the title cell
spacer Writes a spacer cell
divider Write a divider between menu buttons
custom Writes a custom option and task button for the button bar
customX Writes a custom option and task button for the button bar. Extended version of custom() calling hideMainMenu() before submitbutton().
preview Writes a preview button for a given option (opens a popup window)
help Writes a help button
back Writes a cancel button that will go back to the previous page without doing
media_manager Writes a media_manager button
addNew Writes the common 'new' icon for the button bar
addNewX Writes the common 'new' icon for the button bar. Extended version of addNew() calling hideMainMenu() before submitbutton().
publish Writes a common 'publish' button
publishList Writes a common 'publish' button for a list of records
makeDefault Writes a common 'default' button for a record
assign Writes a common 'assign' button for a record
unpublish Writes a common 'unpublish' button
unpublishList Writes a common 'unpublish' button for a list of records
archiveList Writes a common 'archive' button for a list of records
unarchiveList Writes an unarchive button for a list of records
editList Writes a common 'edit' button for a list of records
editListX Writes a common 'edit' button for a list of records. Extended version of editList() calling hideMainMenu() before submitbutton().
editHtml Writes a common 'edit' button for a template html
editHtmlX Writes a common 'edit' button for a template html.
editCss Writes a common 'edit' button for a template css
editCssX Writes a common 'edit' button for a template css. Extended version of editCss() calling hideMainMenu() before submitbutton().
deleteList Writes a common 'delete' button for a list of records
deleteListX Writes a common 'delete' button for a list of records. Extended version of deleteList() calling hideMainMenu() before submitbutton().
trash Write a trash button that will move items to Trash Manager
apply Writes an apply button for a given option. Apply operation leads to a save action only (does not leave edit mode)
save Writes a save button for a given option. Save operation leads to a save and then close action
cancel Writes a cancel button and invokes a cancel operation (eg a checkin)
preferences Writes a configuration button and invokes a cancel operation (eg a checkin)

See also