Docs For Class mosToolBar

mosToolBar

Description

Utility class for the button bar

Located in /includes/HTML_toolbar.php (line 18)

Method Summary

void addNew ([string $task = 'new'], [string $alt = null])

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

void back ()

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

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

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

void divider ()

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

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

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

void endTable ()

void media_manager ([string $directory = ''])

void preview ([string $popup = ''])

void publish ([string $task = 'publish'], [string $alt = null])

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

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

void saveedit ()

void savenew ()

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

void startTable ()

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

void unpublish ([string $task = 'unpublish'], [string $alt = null])

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

Methods

addNew (line 58)

Writes the common 'new' icon for the button bar

void addNew ([string $task = 'new'], [string $alt = null])

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

archiveList (line 158)

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

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

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

back (line 366)

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

any other operation

void back ()

cancel (line 347)

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

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

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

custom (line 38)

Writes a custom option and task button for the button bar

void custom ([string $task = ''], [string $icon = ''], [string $iconOver = ''], [string $alt = ''], [boolean $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
boolean $listSelect: True if required to check that a standard list item is checked

deleteList (line 257)

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

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

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

divider (line 381)

Write a divider between menu buttons

void divider ()

editCss (line 237)

Writes a common 'edit' button for a template css

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

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

editHtml (line 218)

Writes a common 'edit' button for a template html

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

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

editList (line 198)

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

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

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

endTable (line 426)

Writes the end of the menu bar table

void endTable ()

media_manager (line 394)

Writes a media_manager button

void media_manager ([string $directory = ''])

string $directory: The sub-drectory to upload the media to

preview (line 276)

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

void preview ([string $popup = ''])

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

publish (line 78)

Writes a common 'publish' button

void publish ([string $task = 'publish'], [string $alt = null])

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

publishList (line 98)

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

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

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

save (line 297)

Writes a save button for a given option

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

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

saveedit (line 330)

Writes a save button for a given option (NOTE this is being deprecated)

void saveedit ()

savenew (line 315)

Writes a save button for a given option (NOTE this is being deprecated)

void savenew ()

spacer (line 410)

Writes a spacer cell

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

string $width: The width for the cell

startTable (line 23)

Writes the start of the button bar table

void startTable ()

unarchiveList (line 178)

Writes an unarchive button for a list of records

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

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

unpublish (line 118)

Writes a common 'unpublish' button

void unpublish ([string $task = 'unpublish'], [string $alt = null])

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

unpublishList (line 138)

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

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

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

Documentation generated on Mon, 05 May 2008 16:20:16 +0400 by phpDocumentor 1.4.0