Writes the common 'new' icon for the button bar
void
addNew
([string $task = 'new'], [string $alt = 'New'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes the common 'new' icon for the button bar.
Extended version of addNew() calling hideMainMenu() before submitbutton().
void
addNewX
([string $task = 'new'], [string $alt = 'New'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes a save button for a given option
Apply operation leads to a save action only (does not leave edit mode)
void
apply
([string $task = 'apply'], [string $alt = 'Apply'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes a common 'archive' button for a list of records
void
archiveList
([string $task = 'archive'], [string $alt = 'Archive'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes a common 'assign' button for a record
void
assign
([string $task = 'assign'], [string $alt = 'Assign'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes a cancel button that will go back to the previous page without doing
any other operation
void
back
([mixed $alt = 'Back'], [mixed $href = ''])
Writes a cancel button and invokes a cancel operation (eg a checkin)
void
cancel
([string $task = 'cancel'], [string $alt = 'Cancel'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
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
Writes a custom option and task button for the button bar.
Extended version of custom() calling hideMainMenu() before submitbutton().
void
customX
([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
Writes a common 'delete' button for a list of records
void
deleteList
([string $msg = ''], [string $task = 'remove'], [string $alt = '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
Writes a common 'delete' button for a list of records.
Extended version of deleteList() calling hideMainMenu() before submitbutton().
void
deleteListX
([string $msg = ''], [string $task = 'remove'], [string $alt = '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
Write a divider between menu buttons
void
divider
()
Writes a common 'edit' button for a template css
void
editCss
([string $task = 'edit_css'], [string $alt = 'Edit CSS'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes a common 'edit' button for a template css.
Extended version of editCss() calling hideMainMenu() before submitbutton().
void
editCssX
([string $task = 'edit_css'], [string $alt = 'Edit CSS'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes a common 'edit' button for a template html
void
editHtml
([string $task = 'edit_source'], [string $alt = 'Edit HTML'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes a common 'edit' button for a template html.
Extended version of editHtml() calling hideMainMenu() before submitbutton().
void
editHtmlX
([string $task = 'edit_source'], [string $alt = 'Edit HTML'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes a common 'edit' button for a list of records
void
editList
([string $task = 'edit'], [string $alt = 'Edit'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes a common 'edit' button for a list of records.
Extended version of editList() calling hideMainMenu() before submitbutton().
void
editListX
([string $task = 'edit'], [string $alt = 'Edit'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes the end of the menu bar table
void
endTable
()
Writes a preview button for a given option (opens a popup window)
void
help
(string $ref, [boolean $com = false])
-
string
$ref: The name of the popup file (excluding the file extension for an xml file)
-
boolean
$com: Use the help file in the component directory
Writes a common 'default' button for a record
void
makeDefault
([string $task = 'default'], [string $alt = 'Default'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes a media_manager button
void
media_manager
([string $directory = ''], [mixed $alt = 'Upload'])
-
string
$directory: The sub-drectory to upload the media to
Writes a preview button for a given option (opens a popup window)
void
preview
([string $popup = ''], [mixed $updateEditors = false])
-
string
$popup: The name of the popup file (excluding the file extension)
Writes a common 'publish' button
void
publish
([string $task = 'publish'], [string $alt = 'Publish'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes a common 'publish' button for a list of records
void
publishList
([string $task = 'publish'], [string $alt = 'Publish'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes a save button for a given option
Save operation leads to a save and then close action
void
save
([string $task = 'save'], [string $alt = 'Save'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes a save button for a given option (NOTE this is being deprecated)
void
saveedit
()
Writes a save button for a given option (NOTE this is being deprecated)
void
savenew
()
Writes a spacer cell
void
spacer
([string $width = ''])
-
string
$width: The width for the cell
Writes the start of the button bar table
void
startTable
()
Write a trash button that will move items to Trash Manager
void
trash
([mixed $task = 'remove'], [mixed $alt = 'Trash'])
Writes an unarchive button for a list of records
void
unarchiveList
([string $task = 'unarchive'], [string $alt = 'Unarchive'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes a common 'unpublish' button
void
unpublish
([string $task = 'unpublish'], [string $alt = 'Unpublish'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text
Writes a common 'unpublish' button for a list of records
void
unpublishList
([string $task = 'unpublish'], [string $alt = 'Unpublish'])
-
string
$task: An override for the task
-
string
$alt: An override for the alt text