Fonctions membres publiques

title ($title, $icon= 'generic.png')
spacer ($width= '')
divider ()
custom ($task= '', $icon= '', $iconOver= '', $alt= '', $listSelect=true, $x=false)
customX ($task= '', $icon= '', $iconOver= '', $alt= '', $listSelect=true)
preview ($url= '', $updateEditors=false)
help ($ref, $com=false)
back ($alt= 'Back', $href= 'javascript:history.back();')
media_manager ($folder= '', $alt= 'Upload')
addNew ($task= 'add', $alt= 'New')
addNewX ($task= 'add', $alt= 'New')
publish ($task= 'publish', $alt= 'Publish')
publishList ($task= 'publish', $alt= 'Publish')
makeDefault ($task= 'default', $alt= 'Default')
assign ($task= 'assign', $alt= 'Assign')
unpublish ($task= 'unpublish', $alt= 'Unpublish')
unpublishList ($task= 'unpublish', $alt= 'Unpublish')
archiveList ($task= 'archive', $alt= 'Archive')
unarchiveList ($task= 'unarchive', $alt= 'Unarchive')
editList ($task= 'edit', $alt= 'Edit')
editListX ($task= 'edit', $alt= 'Edit')
editHtml ($task= 'edit_source', $alt= 'Edit HTML')
editHtmlX ($task= 'edit_source', $alt= 'Edit HTML')
editCss ($task= 'edit_css', $alt= 'Edit CSS')
editCssX ($task= 'edit_css', $alt= 'Edit CSS')
deleteList ($msg= '', $task= 'remove', $alt= 'Delete')
deleteListX ($msg= '', $task= 'remove', $alt= 'Delete')
trash ($task= 'remove', $alt= 'Trash', $check=true)
apply ($task= 'apply', $alt= 'Apply')
save ($task= 'save', $alt= 'Save')
cancel ($task= 'cancel', $alt= 'Cancel')
preferences ($component, $height='150', $width='570', $alt= 'Preferences', $path= '')

Documentation des fonctions membres

JToolBarHelper::addNew	(	$	task = `'add'`,
		$	alt = `'New'`
	)

Writes the common 'new' icon for the button bar

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Référencé par MENU_Default::MENU_Default().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::addNewX	(	$	task = `'add'`,
		$	alt = `'New'`
	)

Writes the common 'new' icon for the button bar. Extended version of addNew() calling hideMainMenu() before submitbutton().

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Référencé par TOOLBAR_sections::_DEFAULT(), TOOLBAR_newsfeeds::_DEFAULT(), TOOLBAR_modules::_DEFAULT(), TOOLBAR_messages::_DEFAULT(), TOOLBAR_content::_DEFAULT(), TOOLBAR_contact::_DEFAULT(), TOOLBAR_categories::_DEFAULT(), MenusViewMenus::display(), MenusViewList::display(), BannersViewBanner::setBannersToolbar(), et BannersViewClients::setClientsToolbar().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::apply	(	$	task = `'apply'`,
		$	alt = `'Apply'`
	)

Writes a save button for a given option Apply operation leads to a save action only (does not leave edit mode)

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Référencé par TOOLBAR_config::_DEFAULT(), TOOLBAR_templates::_EDIT(), TOOLBAR_sections::_EDIT(), TOOLBAR_newsfeeds::_EDIT(), TOOLBAR_modules::_EDIT(), TOOLBAR_content::_EDIT(), TOOLBAR_contact::_EDIT(), TOOLBAR_categories::_EDIT(), TOOLBAR_templates::_EDIT_CSS(), TOOLBAR_templates::_EDIT_SOURCE(), MenusViewItem::edit(), BannersViewBanner::setBannerToolbar(), et BannersViewClients::setClientToolbar().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::archiveList	(	$	task = `'archive'`,
		$	alt = `'Archive'`
	)

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

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Référencé par TOOLBAR_content::_DEFAULT(), et viewFrontPage().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::assign	(	$	task = `'assign'`,
		$	alt = `'Assign'`
	)

Writes a common 'assign' button for a record

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::back	(	$	alt = `'Back'`,
		$	href = `'javascript:history.back();'`
	)

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

Depuis:: 1.0

Références $bar, et JToolBar::getInstance().

Référencé par TOOLBAR_templates::_VIEW().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::cancel	(	$	task = `'cancel'`,
		$	alt = `'Cancel'`
	)

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

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Référencé par TOOLBAR_templates::_CHOOSE_CSS(), TOOLBAR_messages::_CONFIG(), TOOLBAR_sections::_COPY(), TOOLBAR_content::_COPY(), TOOLBAR_categories::_COPY(), TOOLBAR_massmail::_DEFAULT(), TOOLBAR_config::_DEFAULT(), TOOLBAR_Trash::_DELETE(), TOOLBAR_templates::_EDIT(), TOOLBAR_sections::_EDIT(), TOOLBAR_newsfeeds::_EDIT(), TOOLBAR_modules::_EDIT(), TOOLBAR_messages::_EDIT(), TOOLBAR_content::_EDIT(), TOOLBAR_contact::_EDIT(), TOOLBAR_categories::_EDIT(), TOOLBAR_templates::_EDIT_CSS(), TOOLBAR_templates::_EDIT_SOURCE(), TOOLBAR_content::_MOVE(), TOOLBAR_categories::_MOVE(), TOOLBAR_modules::_NEW(), TOOLBAR_Trash::_RESTORE(), TOOLBAR_messages::_VIEW(), MenusViewMenus::copyForm(), MenusViewList::copyForm(), MenusViewMenus::deleteForm(), MenusViewItem::edit(), MenusViewMenus::editForm(), MenusViewList::moveForm(), BannersViewBanner::setBannerToolbar(), BannersViewClients::setClientToolbar(), et MenusViewItem::type().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::custom	(	$	task = `''`,
		$	icon = `''`,
		$	iconOver = `''`,
		$	alt = `''`,
		$	listSelect = `true`,
		$	x = `false`
	)

Writes a custom option and task button for the button bar

Paramètres:

string	The task to perform (picked up by the switch($task) blocks
string	The image to display
string	The image to display when moused over
string	The alt text for the icon image
boolean	True if required to check that a standard list item is checked
boolean	True if required to include callinh hideMainMenu()

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Référencé par TOOLBAR_templates::_CHOOSE_CSS(), TOOLBAR_content::_COPY(), TOOLBAR_Trash::_DEFAULT(), TOOLBAR_modules::_DEFAULT(), TOOLBAR_messages::_DEFAULT(), TOOLBAR_massmail::_DEFAULT(), TOOLBAR_cache::_DEFAULT(), TOOLBAR_templates::_EDIT(), TOOLBAR_content::_MOVE(), TOOLBAR_cache::_PURGEADMIN(), MenusViewMenus::copyForm(), MenusViewList::copyForm(), MenusViewMenus::deleteForm(), SearchViewSearch::display(), MenusViewMenus::editForm(), MenusViewList::moveForm(), et viewFrontPage().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::customX	(	$	task = `''`,
		$	icon = `''`,
		$	iconOver = `''`,
		$	alt = `''`,
		$	listSelect = `true`
	)

Writes a custom option and task button for the button bar. Extended version of custom() calling hideMainMenu() before submitbutton().

Paramètres:

string	The task to perform (picked up by the switch($task) blocks
string	The image to display
string	The image to display when moused over
string	The alt text for the icon image
boolean	True if required to check that a standard list item is checked

Depuis:: 1.0 (NOTE this is being deprecated)

Références $bar, $task, et JToolBar::getInstance().

Référencé par TOOLBAR_sections::_DEFAULT(), TOOLBAR_content::_DEFAULT(), TOOLBAR_categories::_DEFAULT(), TOOLBAR_modules::_NEW(), TOOLBAR_messages::_VIEW(), MenusViewMenus::display(), MenusViewList::display(), et BannersViewBanner::setBannersToolbar().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::deleteList	(	$	msg = `''`,
		$	task = `'remove'`,
		$	alt = `'Delete'`
	)

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

Paramètres:

string	Postscript for the 'are you sure' message
string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Référencé par TOOLBAR_sections::_DEFAULT(), TOOLBAR_newsfeeds::_DEFAULT(), TOOLBAR_modules::_DEFAULT(), TOOLBAR_messages::_DEFAULT(), TOOLBAR_contact::_DEFAULT(), TOOLBAR_categories::_DEFAULT(), TOOLBAR_messages::_VIEW(), InstallerViewTemplates::display(), InstallerViewPlugins::display(), InstallerViewModules::display(), InstallerViewLanguages::display(), InstallerViewComponents::display(), MENU_Default::MENU_Default(), BannersViewBanner::setBannersToolbar(), et BannersViewClients::setClientsToolbar().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::deleteListX	(	$	msg = `''`,
		$	task = `'remove'`,
		$	alt = `'Delete'`
	)

Writes a common 'delete' button for a list of records. Extended version of deleteList() calling hideMainMenu() before submitbutton().

Paramètres:

string	Postscript for the 'are you sure' message
string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::divider ( )

Write a divider between menu buttons

Depuis:: 1.0

Références $bar, et JToolBar::getInstance().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::editCss	(	$	task = `'edit_css'`,
		$	alt = `'Edit CSS'`
	)

Writes a common 'edit' button for a template css

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::editCssX	(	$	task = `'edit_css'`,
		$	alt = `'Edit CSS'`
	)

Writes a common 'edit' button for a template css. Extended version of editCss() calling hideMainMenu() before submitbutton().

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::editHtml	(	$	task = `'edit_source'`,
		$	alt = `'Edit HTML'`
	)

Writes a common 'edit' button for a template html

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::editHtmlX	(	$	task = `'edit_source'`,
		$	alt = `'Edit HTML'`
	)

Writes a common 'edit' button for a template html. Extended version of editHtml() calling hideMainMenu() before submitbutton().

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::editList	(	$	task = `'edit'`,
		$	alt = `'Edit'`
	)

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

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Référencé par MENU_Default::MENU_Default().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::editListX	(	$	task = `'edit'`,
		$	alt = `'Edit'`
	)

Writes a common 'edit' button for a list of records. Extended version of editList() calling hideMainMenu() before submitbutton().

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Référencé par TOOLBAR_templates::_DEFAULT(), TOOLBAR_sections::_DEFAULT(), TOOLBAR_newsfeeds::_DEFAULT(), TOOLBAR_modules::_DEFAULT(), TOOLBAR_content::_DEFAULT(), TOOLBAR_contact::_DEFAULT(), TOOLBAR_categories::_DEFAULT(), MenusViewMenus::display(), MenusViewList::display(), BannersViewBanner::setBannersToolbar(), et BannersViewClients::setClientsToolbar().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::help	(	$	ref,
		$	com = `false`
	)

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

Paramètres:

string	The name of the popup file (excluding the file extension for an xml file)
boolean	Use the help file in the component directory

Depuis:: 1.0

Références $bar, et JToolBar::getInstance().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::makeDefault	(	$	task = `'default'`,
		$	alt = `'Default'`
	)

Writes a common 'default' button for a record

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Référencé par TOOLBAR_templates::_DEFAULT(), TOOLBAR_languages::_DEFAULT(), et MenusViewList::display().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::media_manager	(	$	folder = `''`,
		$	alt = `'Upload'`
	)

Writes a media_manager button

Paramètres:

string The sub-drectory to upload the media to

Depuis:: 1.0

Références $bar, et JToolBar::getInstance().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::preferences	(	$	component,
		$	height = `'150'`,
		$	width = `'570'`,
		$	alt = `'Preferences'`,
		$	path = `''`
	)

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

Paramètres:

string	The name of the component, eg, com_content
int	The height of the popup
int	The width of the popup
string	The name of the button
string	An alternative path for the configuation xml relative to JPATH_SITE

Depuis:: 1.0

Références $bar, $height, $path, $user, $width, JToolBar::getInstance(), et JFactory::getUser().

Référencé par TOOLBAR_newsfeeds::_DEFAULT(), TOOLBAR_massmail::_DEFAULT(), TOOLBAR_content::_DEFAULT(), TOOLBAR_contact::_DEFAULT(), SearchViewSearch::display(), et BannersViewBanner::setBannersToolbar().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::preview	(	$	url = `''`,
		$	updateEditors = `false`
	)

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

Paramètres:

string The name of the popup file (excluding the file extension)

Depuis:: 1.0

Références $bar, et JToolBar::getInstance().

Référencé par TOOLBAR_content::_EDIT().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::publish	(	$	task = `'publish'`,
		$	alt = `'Publish'`
	)

Writes a common 'publish' button

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::publishList	(	$	task = `'publish'`,
		$	alt = `'Publish'`
	)

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

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Référencé par TOOLBAR_sections::_DEFAULT(), TOOLBAR_newsfeeds::_DEFAULT(), TOOLBAR_modules::_DEFAULT(), TOOLBAR_content::_DEFAULT(), TOOLBAR_contact::_DEFAULT(), TOOLBAR_categories::_DEFAULT(), MenusViewList::display(), MENU_Default::MENU_Default(), BannersViewBanner::setBannersToolbar(), et viewFrontPage().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::save	(	$	task = `'save'`,
		$	alt = `'Save'`
	)

Writes a save button for a given option Save operation leads to a save and then close action

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Référencé par TOOLBAR_messages::_CONFIG(), TOOLBAR_sections::_COPY(), TOOLBAR_categories::_COPY(), TOOLBAR_config::_DEFAULT(), TOOLBAR_templates::_EDIT(), TOOLBAR_sections::_EDIT(), TOOLBAR_newsfeeds::_EDIT(), TOOLBAR_modules::_EDIT(), TOOLBAR_messages::_EDIT(), TOOLBAR_content::_EDIT(), TOOLBAR_contact::_EDIT(), TOOLBAR_categories::_EDIT(), TOOLBAR_templates::_EDIT_CSS(), TOOLBAR_templates::_EDIT_SOURCE(), TOOLBAR_categories::_MOVE(), MenusViewItem::edit(), BannersViewBanner::setBannerToolbar(), et BannersViewClients::setClientToolbar().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::spacer ( $ width = '' )

Writes a spacer cell

Paramètres:

string The width for the cell

Depuis:: 1.0

Références $bar, $width, et JToolBar::getInstance().

Référencé par MENU_Default::MENU_Default().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::title	(	$	title,
		$	icon = `'generic.png'`
	)

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

Paramètres:

string	The title
string	The name of the image

Depuis:: 1.5

Références $mainframe.

Référencé par TOOLBAR_templates::_CHOOSE_CSS(), TOOLBAR_messages::_CONFIG(), TOOLBAR_sections::_COPY(), TOOLBAR_content::_COPY(), TOOLBAR_categories::_COPY(), TOOLBAR_admin::_CPANEL(), TOOLBAR_Trash::_DEFAULT(), TOOLBAR_templates::_DEFAULT(), TOOLBAR_sections::_DEFAULT(), TOOLBAR_newsfeeds::_DEFAULT(), TOOLBAR_modules::_DEFAULT(), TOOLBAR_messages::_DEFAULT(), TOOLBAR_massmail::_DEFAULT(), TOOLBAR_languages::_DEFAULT(), TOOLBAR_cpanel::_DEFAULT(), TOOLBAR_content::_DEFAULT(), TOOLBAR_contact::_DEFAULT(), TOOLBAR_config::_DEFAULT(), TOOLBAR_checkin::_DEFAULT(), TOOLBAR_categories::_DEFAULT(), TOOLBAR_cache::_DEFAULT(), TOOLBAR_Trash::_DELETE(), TOOLBAR_templates::_EDIT(), TOOLBAR_sections::_EDIT(), TOOLBAR_newsfeeds::_EDIT(), TOOLBAR_modules::_EDIT(), TOOLBAR_messages::_EDIT(), TOOLBAR_content::_EDIT(), TOOLBAR_contact::_EDIT(), TOOLBAR_categories::_EDIT(), TOOLBAR_templates::_EDIT_CSS(), TOOLBAR_templates::_EDIT_SOURCE(), TOOLBAR_admin::_HELP(), TOOLBAR_content::_MOVE(), TOOLBAR_categories::_MOVE(), TOOLBAR_modules::_NEW(), TOOLBAR_admin::_PREVIEW(), TOOLBAR_cache::_PURGEADMIN(), TOOLBAR_Trash::_RESTORE(), MediaViewMedia::_setToolBar(), TOOLBAR_admin::_SYSINFO(), TOOLBAR_templates::_VIEW(), TOOLBAR_messages::_VIEW(), MenusViewMenus::copyForm(), MenusViewList::copyForm(), MenusViewMenus::deleteForm(), SearchViewSearch::display(), MenusViewMenus::display(), MenusViewList::display(), InstallerViewDefault::display(), MenusViewItem::edit(), MenusViewMenus::editForm(), MenusViewList::moveForm(), BannersViewBanner::setBannersToolbar(), BannersViewBanner::setBannerToolbar(), BannersViewClients::setClientsToolbar(), BannersViewClients::setClientToolbar(), MenusViewItem::type(), et viewFrontPage().

JToolBarHelper::trash	(	$	task = `'remove'`,
		$	alt = `'Trash'`,
		$	check = `true`
	)

Write a trash button that will move items to Trash Manager

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Référencé par TOOLBAR_content::_DEFAULT(), et MenusViewList::display().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::unarchiveList	(	$	task = `'unarchive'`,
		$	alt = `'Unarchive'`
	)

Writes an unarchive button for a list of records

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Référencé par TOOLBAR_content::_DEFAULT().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::unpublish	(	$	task = `'unpublish'`,
		$	alt = `'Unpublish'`
	)

Writes a common 'unpublish' button

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Voici le graphe d'appel pour cette fonction :

JToolBarHelper::unpublishList	(	$	task = `'unpublish'`,
		$	alt = `'Unpublish'`
	)

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

Paramètres:

string	An override for the task
string	An override for the alt text

Depuis:: 1.0

Références $bar, $task, et JToolBar::getInstance().

Référencé par TOOLBAR_sections::_DEFAULT(), TOOLBAR_newsfeeds::_DEFAULT(), TOOLBAR_modules::_DEFAULT(), TOOLBAR_content::_DEFAULT(), TOOLBAR_contact::_DEFAULT(), TOOLBAR_categories::_DEFAULT(), MenusViewList::display(), MENU_Default::MENU_Default(), BannersViewBanner::setBannersToolbar(), et viewFrontPage().

Voici le graphe d'appel pour cette fonction :

La documentation de cette classe a été générée à partir du fichier suivant :

administrator/includes/toolbar.php

Référence de la classe JToolBarHelper

Fonctions membres publiques

Documentation des fonctions membres