[ Index ]

PHP Cross Reference of Mambo 4.6.5

[ Variables ]     [ Functions ]     [ Classes ]     [ Constants ]     [ Statistics ]

title

Body

[close]

/administrator/includes/ -> menubar.html.php (summary)

(no description)

Author: Mambo Foundation Inc see README.php
Copyright: (C) 2000 - 2009 Mambo Foundation Inc.
License: GNU/GPL Version 2, see LICENSE.php
File Size: 527 lines (19 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

mosMenuBar:: (39 methods):
  startTable()
  MM_swapImgRestore()
  custom()
  customX()
  addToToolBar()
  makeJavaScript()
  getTemplate()
  addNew()
  addNewX()
  publish()
  publishList()
  makeDefault()
  assign()
  unpublish()
  unpublishList()
  archiveList()
  unarchiveList()
  editList()
  editListX()
  editHtml()
  editHtmlX()
  editCss()
  editCssX()
  deleteList()
  deleteListX()
  trash()
  preview()
  popup()
  help()
  apply()
  save()
  savenew()
  saveedit()
  cancel()
  back()
  divider()
  media_manager()
  spacer()
  endTable()


Class: mosMenuBar  - X-Ref

Utility class for the button bar

startTable()   X-Ref
Writes the start of the button bar table


MM_swapImgRestore()   X-Ref
No description

custom( $task='', $icon='', $iconOver='', $alt='', $listSelect=true, $prefix='' )   X-Ref
Writes a custom option and task button for the button bar

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

customX( $task='', $icon='', $iconOver='', $alt='', $listSelect=true )   X-Ref
Writes a custom option and task button for the button bar.
Extended version of custom() calling hideMainMenu() before submitbutton().

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

addToToolBar($task, $alt, $name, $imagename, $extended=false, $listprompt='')   X-Ref
Standard routine for displaying toolbar icon

param: string An override for the task
param: string An override for the alt text
param: string The name to be used as a legend and as the image name
param:

makeJavaScript($task, $extended, $listprompt='')   X-Ref
No description

getTemplate()   X-Ref
No description

addNew( $task='new', $alt=null )   X-Ref
Writes the common 'new' icon for the button bar

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

addNewX( $task='new', $alt=null )   X-Ref
Writes the common 'new' icon for the button bar.
Extended version of addNew() calling hideMainMenu() before submitbutton().

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

publish( $task='publish', $alt=null )   X-Ref
Writes a common 'publish' button

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

publishList( $task='publish', $alt=null )   X-Ref
Writes a common 'publish' button for a list of records

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

makeDefault( $task='default', $alt=null )   X-Ref
Writes a common 'default' button for a record

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

assign( $task='assign', $alt=null )   X-Ref
Writes a common 'assign' button for a record

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

unpublish( $task='unpublish', $alt=null )   X-Ref
Writes a common 'unpublish' button

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

unpublishList( $task='unpublish', $alt=null )   X-Ref
Writes a common 'unpublish' button for a list of records

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

archiveList( $task='archive', $alt=null )   X-Ref
Writes a common 'archive' button for a list of records

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

unarchiveList( $task='unarchive', $alt=null )   X-Ref
Writes an unarchive button for a list of records

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

editList( $task='edit', $alt=null )   X-Ref
Writes a common 'edit' button for a list of records

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

editListX( $task='edit', $alt=null )   X-Ref
Writes a common 'edit' button for a list of records.
Extended version of editList() calling hideMainMenu() before submitbutton().

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

editHtml( $task='edit_source', $alt=null )   X-Ref
Writes a common 'edit' button for a template html

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

editHtmlX( $task='edit_source', $alt=null )   X-Ref
Writes a common 'edit' button for a template html.
Extended version of editHtml() calling hideMainMenu() before submitbutton().

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

editCss( $task='edit_css', $alt=null )   X-Ref
Writes a common 'edit' button for a template css

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

editCssX( $task='edit_css', $alt=null )   X-Ref
Writes a common 'edit' button for a template css.
Extended version of editCss() calling hideMainMenu() before submitbutton().

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

deleteList( $msg='', $task='remove', $alt=null )   X-Ref
Writes a common 'delete' button for a list of records

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

deleteListX( $msg='', $task='remove', $alt=null )   X-Ref
Writes a common 'delete' button for a list of records.
Extended version of deleteList() calling hideMainMenu() before submitbutton().

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

trash( $task='remove', $alt=null )   X-Ref
Write a trash button that will move items to Trash Manager


preview( $popup='', $updateEditors=false )   X-Ref
Writes a preview button for a given option (opens a popup window)

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

popup()   X-Ref
No description

help( $ref, $com=false )   X-Ref
Writes a preview button for a given option (opens a popup window)

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

apply( $task='apply', $alt=null )   X-Ref
Writes a save button for a given option
Apply operation leads to a save action only (does not leave edit mode)

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

save( $task='save', $alt=null )   X-Ref
Writes a save button for a given option
Save operation leads to a save and then close action

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

savenew()   X-Ref
Writes a save button for a given option (NOTE this is being deprecated)


saveedit()   X-Ref
Writes a save button for a given option (NOTE this is being deprecated)


cancel( $task='cancel', $alt=null )   X-Ref
Writes a cancel button and invokes a cancel operation (eg a checkin)

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

back( $alt=null, $href='' )   X-Ref
Writes a cancel button that will go back to the previous page without doing
any other operation


divider()   X-Ref
Write a divider between menu buttons


media_manager( $directory = '', $alt=null )   X-Ref
Writes a media_manager button

param: string The sub-drectory to upload the media to

spacer( $width='' )   X-Ref
Writes a spacer cell

param: string The width for the cell

endTable()   X-Ref
Writes the end of the menu bar table