Class mosToolBar

Description

Utility class for the button bar

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


	
			
Method Summary
void addNew ([string $task = 'new'], [string $alt = _CMN_NEW])
void archiveList ([string $task = 'archive'], [string $alt = _CMN_ARCHIVE])
void back ()
void cancel ([string $task = 'cancel'], [string $alt = _CMN_CANCEL])
void custom ([string $task = ''], [string $icon = ''], [string $iconOver = ''], [string $alt = ''], [boolean $listSelect = true])
void deleteList ([string $msg = ''], [string $task = 'remove'], [string $alt = _CMN_DELETE])
void divider ()
void editCss ([string $task = 'edit_css'], [string $alt = _CMN_EDIT_CSS])
void editHtml ([string $task = 'edit_source'], [string $alt = _CMN_EDIT_HTML])
void editList ([string $task = 'edit'], [string $alt = _E_EDIT])
void endTable ()
void media_manager ([string $directory = ''])
void preview ([string $popup = ''])
void publish ([string $task = 'publish'], [string $alt = _CMN_PUBLISHED])
void publishList ([string $task = 'publish'], [string $alt = _CMN_PUBLISHED])
void save ([string $task = 'save'], [string $alt = _CMN_SAVE])
void saveedit ()
void savenew ()
void spacer ([string $width = ''])
void startTable ()
void unarchiveList ([string $task = 'unarchive'], [string $alt = _CMN_UNARCHIVE])
void unpublish ([string $task = 'unpublish'], [string $alt = _CMN_UNPUBLISHED])
void unpublishList ([string $task = 'unpublish'], [string $alt = _CMN_UNPUBLISHED])
Methods
addNew (line 54)

Writes the common 'new' icon for the button bar

void addNew ([string $task = 'new'], [string $alt = _CMN_NEW])
  • string $task: An override for the task
  • string $alt: An override for the alt text
archiveList (line 139)

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

void archiveList ([string $task = 'archive'], [string $alt = _CMN_ARCHIVE])
  • string $task: An override for the task
  • string $alt: An override for the alt text
back (line 325)

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

any other operation

void back ()
cancel (line 309)

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

void cancel ([string $task = 'cancel'], [string $alt = _CMN_CANCEL])
  • string $task: An override for the task
  • string $alt: An override for the alt text
custom (line 34)

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 225)

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

void deleteList ([string $msg = ''], [string $task = 'remove'], [string $alt = _CMN_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
divider (line 340)

Write a divider between menu buttons

void divider ()
editCss (line 207)

Writes a common 'edit' button for a template css

void editCss ([string $task = 'edit_css'], [string $alt = _CMN_EDIT_CSS])
  • string $task: An override for the task
  • string $alt: An override for the alt text
editHtml (line 190)

Writes a common 'edit' button for a template html

void editHtml ([string $task = 'edit_source'], [string $alt = _CMN_EDIT_HTML])
  • string $task: An override for the task
  • string $alt: An override for the alt text
editList (line 173)

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

void editList ([string $task = 'edit'], [string $alt = _E_EDIT])
  • string $task: An override for the task
  • string $alt: An override for the alt text
endTable (line 385)

Writes the end of the menu bar table

void endTable ()
media_manager (line 353)

Writes a media_manager button

void media_manager ([string $directory = ''])
  • string $directory: The sub-drectory to upload the media to
preview (line 241)

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 71)

Writes a common 'publish' button

void publish ([string $task = 'publish'], [string $alt = _CMN_PUBLISHED])
  • string $task: An override for the task
  • string $alt: An override for the alt text
publishList (line 88)

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

void publishList ([string $task = 'publish'], [string $alt = _CMN_PUBLISHED])
  • string $task: An override for the task
  • string $alt: An override for the alt text
save (line 262)

Writes a save button for a given option

void save ([string $task = 'save'], [string $alt = _CMN_SAVE])
  • string $task: An override for the task
  • string $alt: An override for the alt text
saveedit (line 292)

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

void saveedit ()
savenew (line 277)

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

void savenew ()
spacer (line 369)

Writes a spacer cell

void spacer ([string $width = ''])
  • string $width: The width for the cell
startTable (line 19)

Writes the start of the button bar table

void startTable ()
unarchiveList (line 156)

Writes an unarchive button for a list of records

void unarchiveList ([string $task = 'unarchive'], [string $alt = _CMN_UNARCHIVE])
  • string $task: An override for the task
  • string $alt: An override for the alt text
unpublish (line 105)

Writes a common 'unpublish' button

void unpublish ([string $task = 'unpublish'], [string $alt = _CMN_UNPUBLISHED])
  • string $task: An override for the task
  • string $alt: An override for the alt text
unpublishList (line 122)

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

void unpublishList ([string $task = 'unpublish'], [string $alt = _CMN_UNPUBLISHED])
  • string $task: An override for the task
  • string $alt: An override for the alt text

Documentation generated on Fri, 4 Mar 2005 13:56:20 +1000 by phpDocumentor 1.3.0RC3