Документация по Joomla 1.7

Joomla.Administrator\JToolBarHelper
administrator/includes/toolbar.php at line 19

Class JToolBarHelper

JToolBarHelper

public abstract class JToolBarHelper

Utility class for the button bar.

Subpackage:
Application

Method Summary
static void

title(string title, string icon)

Title cell.

static void

spacer(string width)

Writes a spacer cell.

static void

divider()

Writes a divider between menu buttons

static void

custom(string task, string icon, string iconOver, string alt, bool listSelect)

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

static void

customX(string task, string icon, string iconOver, string alt, bool listSelect)

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

static void

preview(string url, bool updateEditors)

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

static void

help(string ref, bool com, string override, string component)

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

static void

back(string alt, string href)

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

static void

media_manager(string directory, string alt)

Writes a media_manager button.

static void

makeDefault(string task, string alt)

Writes a common 'default' button for a record.

static void

assign(string task, string alt)

Writes a common 'assign' button for a record.

static void

addNew(string task, string alt, boolean check)

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

static void

addNewX(string task, string alt)

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

static void

publish(string task, string alt, boolean check)

Writes a common 'publish' button.

static void

publishList(string task, string alt)

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

static void

unpublish(string task, string alt, boolean check)

Writes a common 'unpublish' button.

static void

unpublishList(string task, string alt)

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

static void

archiveList(string task, string alt)

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

static void

unarchiveList(string task, string alt)

Writes an unarchive button for a list of records.

static void

editList(string task, string alt)

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

static void

editListX(string task, string alt)

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

static void

editHtml(string task, string alt)

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

static void

editHtmlX(string task, string alt)

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

static void

editCss(string task, string alt)

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

static void

editCssX(string task, string alt)

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

static void

deleteList(string msg, string task, string alt)

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

static void

deleteListX(string msg, string task, string alt)

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

static void

trash(string task, string alt, bool check)

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

static void

apply(string task, string alt)

Writes a save button for a given option.

static void

save(string task, string alt)

Writes a save button for a given option.

static void

save2new(string task, string alt)

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

static void

save2copy(string task, string alt)

Writes a save as copy button for a given option.

static void

checkin(string task, string alt, boolean check)

Writes a checkin button for a given option.

static void

cancel(string task, string alt)

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

static void

preferences(string component, int height, int width, string alt, string path, str onClose)

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

Method Detail

administrator/includes/toolbar.php at line 31

title

public static void title(string title, string icon)

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.

Parameters:
title - The title.
icon - The space-separated names of the image.
Since:
1.5

administrator/includes/toolbar.php at line 51

spacer

public static void spacer(string width)

Writes a spacer cell.

Parameters:
width - The width for the cell
Since:
1.0

administrator/includes/toolbar.php at line 63

divider

public static void divider()

Writes a divider between menu buttons

Since:
1.0

administrator/includes/toolbar.php at line 80

custom

public static void custom(string task, string icon, string iconOver, string alt, bool listSelect)

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

Parameters:
task - The task to perform (picked up by the switch($task) blocks.
icon - The image to display.
iconOver - The image to display when moused over.
alt - The alt text for the icon image.
listSelect - True if required to check that a standard list item is checked.
Since:
1.0

administrator/includes/toolbar.php at line 102

customX

public static void customX(string task, string icon, string iconOver, string alt, bool listSelect)

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

Parameters:
task - The task to perform (picked up by the switch($task) blocks.
icon - The image to display.
iconOver - The image to display when moused over.
alt - The alt text for the icon image.
listSelect - True if required to check that a standard list item is checked.
Since:
1.0
Deprecated.

administrator/includes/toolbar.php at line 114

preview

public static void preview(string url, bool updateEditors)

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

Parameters:
url - The name of the popup file (excluding the file extension)
Since:
1.0

administrator/includes/toolbar.php at line 130

help

public static void help(string ref, bool com, string override, string component)

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

Parameters:
ref - The name of the popup file (excluding the file extension for an xml file).
com - Use the help file in the component directory.
override - Use this URL instead of any other
component - Name of component to get Help (null for current component)
Since:
1.0

administrator/includes/toolbar.php at line 145

back

public static void back(string alt, string href)

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

Parameters:
alt - Alternative text.
href - URL of the href attribute.
Since:
1.0

administrator/includes/toolbar.php at line 159

media_manager

public static void media_manager(string directory, string alt)

Writes a media_manager button.

Parameters:
directory - The sub-drectory to upload the media to.
alt - An override for the alt text.
Since:
1.0

administrator/includes/toolbar.php at line 173

makeDefault

public static void makeDefault(string task, string alt)

Writes a common 'default' button for a record.

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0

administrator/includes/toolbar.php at line 187

assign

public static void assign(string task, string alt)

Writes a common 'assign' button for a record.

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0

administrator/includes/toolbar.php at line 202

addNew

public static void addNew(string task, string alt, boolean check)

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

Parameters:
task - An override for the task.
alt - An override for the alt text.
check - True if required to check that a standard list item is checked.
Since:
1.0

administrator/includes/toolbar.php at line 218

addNewX

public static void addNewX(string task, string alt)

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

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0
Deprecated.

administrator/includes/toolbar.php at line 231

publish

public static void publish(string task, string alt, boolean check)

Writes a common 'publish' button.

Parameters:
task - An override for the task.
alt - An override for the alt text.
check - True if required to check that a standard list item is checked.
Since:
1.0

administrator/includes/toolbar.php at line 245

publishList

public static void publishList(string task, string alt)

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

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0

administrator/includes/toolbar.php at line 260

unpublish

public static void unpublish(string task, string alt, boolean check)

Writes a common 'unpublish' button.

Parameters:
task - An override for the task.
alt - An override for the alt text.
check - True if required to check that a standard list item is checked.
Since:
1.0

administrator/includes/toolbar.php at line 274

unpublishList

public static void unpublishList(string task, string alt)

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

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0

administrator/includes/toolbar.php at line 288

archiveList

public static void archiveList(string task, string alt)

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

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0

administrator/includes/toolbar.php at line 302

unarchiveList

public static void unarchiveList(string task, string alt)

Writes an unarchive button for a list of records.

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0

administrator/includes/toolbar.php at line 316

editList

public static void editList(string task, string alt)

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

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0

administrator/includes/toolbar.php at line 332

editListX

public static void editListX(string task, string alt)

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

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0
Deprecated.

administrator/includes/toolbar.php at line 344

editHtml

public static void editHtml(string task, string alt)

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

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0

administrator/includes/toolbar.php at line 360

editHtmlX

public static void editHtmlX(string task, string alt)

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

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0
Deprecated.

administrator/includes/toolbar.php at line 372

editCss

public static void editCss(string task, string alt)

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

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0

administrator/includes/toolbar.php at line 388

editCssX

public static void editCssX(string task, string alt)

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

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0
Deprecated.

administrator/includes/toolbar.php at line 401

deleteList

public static void deleteList(string msg, string task, string alt)

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

Parameters:
msg - Postscript for the 'are you sure' message.
task - An override for the task.
alt - An override for the alt text.
Since:
1.0

administrator/includes/toolbar.php at line 422

deleteListX

public static void deleteListX(string msg, string task, string alt)

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

Parameters:
msg - Postscript for the 'are you sure' message.
task - An override for the task.
alt - An override for the alt text.
Since:
1.0
Deprecated.

administrator/includes/toolbar.php at line 435

trash

public static void trash(string task, string alt, bool check)

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

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0

administrator/includes/toolbar.php at line 450

apply

public static void apply(string task, string alt)

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

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0

administrator/includes/toolbar.php at line 465

save

public static void save(string task, string alt)

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

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0

administrator/includes/toolbar.php at line 480

save2new

public static void save2new(string task, string alt)

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

administrator/includes/toolbar.php at line 496

save2copy

public static void save2copy(string task, string alt)

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

administrator/includes/toolbar.php at line 511

checkin

public static void checkin(string task, string alt, boolean check)

Writes a checkin button for a given option.

Parameters:
check - True if required to check that a standard list item is checked.
Since:
1.7

administrator/includes/toolbar.php at line 525

cancel

public static void cancel(string task, string alt)

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

Parameters:
task - An override for the task.
alt - An override for the alt text.
Since:
1.0

administrator/includes/toolbar.php at line 542

preferences

public static void preferences(string component, int height, int width, string alt, string path, str onClose)

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

Parameters:
component - The name of the component, eg, com_content.
height - The height of the popup.
width - The width of the popup.
alt - The name of the button.
path - An alternative path for the configuation xml relative to JPATH_SITE.
Since:
1.0

Документация по Joomla 1.7