mosMenuBar Class Reference

List of all members.

Static Public Member Functions

static startTable ()
static custom ($task='', $icon='', $iconOver='', $alt='', $listSelect=true, $prefix='')
static customX ($task='', $icon='', $iconOver='', $alt='', $listSelect=true)
static addToToolBar ($task, $alt, $name, $imagename, $extended=false, $listprompt='')
static addNew ($task='new', $alt=null)
static addNewX ($task='new', $alt=null)
static publish ($task='publish', $alt=null)
static publishList ($task='publish', $alt=null)
static makeDefault ($task='default', $alt=null)
static assign ($task='assign', $alt=null)
static unpublish ($task='unpublish', $alt=null)
static unpublishList ($task='unpublish', $alt=null)
static archiveList ($task='archive', $alt=null)
static unarchiveList ($task='unarchive', $alt=null)
static editList ($task='edit', $alt=null)
static editListX ($task='edit', $alt=null)
static editHtml ($task='edit_source', $alt=null)
static editHtmlX ($task='edit_source', $alt=null)
static editCss ($task='edit_css', $alt=null)
static editCssX ($task='edit_css', $alt=null)
static deleteList ($msg='', $task='remove', $alt=null)
static deleteListX ($msg='', $task='remove', $alt=null)
static trash ($task='remove', $alt=null)
static preview ($popup='', $updateEditors=false)
static help ($ref, $com=false)
static apply ($task='apply', $alt=null)
static save ($task='save', $alt=null)
static savenew ()
static saveedit ()
static cancel ($task='cancel', $alt=null)
static back ($alt=null, $href='')
static divider ()
static media_manager ($directory= '', $alt=null)
static spacer ($width='')
static endTable ()

Detailed Description

Utility class for the button bar

Definition at line 15 of file mosMenuBar.php.

Member Function Documentation

static mosMenuBar::startTable (  )  [static]

Writes the start of the button bar table

Definition at line 20 of file mosMenuBar.php.

00020                                         {
00021     }

static mosMenuBar::custom ( $  task = '',
$  icon = '',
$  iconOver = '',
$  alt = '',
$  listSelect = true,
$  prefix = '' 
) [static]

Writes a custom option and task button for the button bar

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

Definition at line 31 of file mosMenuBar.php.

References aliroAdminToolbar::getInstance().

Referenced by customX().

00031                                                                                                              {
00032         aliroAdminToolbar::getInstance()->custom ($task, $icon, $iconOver, $alt, $listSelect, $prefix);
00033     }

static mosMenuBar::customX ( $  task = '',
$  icon = '',
$  iconOver = '',
$  alt = '',
$  listSelect = true 
) [static]

Writes a custom option and task button for the button bar. Extended version of custom() calling hideMainMenu() before submitbutton().

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

Definition at line 44 of file mosMenuBar.php.

References custom().

00044                                                                                                   {
00045         mosMenuBar::custom ($task, $icon, $iconOver, $alt, $listSelect, 'hideMainMenu();');
00046     }

static mosMenuBar::addToToolBar ( $  task,
$  alt,
$  name,
$  imagename,
$  extended = false,
$  listprompt = '' 
) [static]

Standard routine for displaying toolbar icon

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

Definition at line 55 of file mosMenuBar.php.

References aliroAdminToolbar::getInstance().

Referenced by addNew(), addNewX(), apply(), archiveList(), assign(), cancel(), deleteList(), deleteListX(), editCss(), editCssX(), editHtml(), editHtmlX(), editList(), editListX(), makeDefault(), publish(), publishList(), save(), saveedit(), savenew(), trash(), unarchiveList(), unpublish(), and unpublishList().

00055                                                                                                           {
00056         aliroAdminToolbar::getInstance()->addToToolBar ($task, $alt, $name, $imagename, $extended, $listprompt);
00057     }

static mosMenuBar::addNew ( $  task = 'new',
$  alt = null 
) [static]

Writes the common 'new' icon for the button bar

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

Definition at line 64 of file mosMenuBar.php.

References addToToolBar().

00064                                                             {
00065         mosMenuBar::addToToolBar ($task, $alt, 'New', 'new');
00066     }

static mosMenuBar::addNewX ( $  task = 'new',
$  alt = null 
) [static]

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

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

Definition at line 74 of file mosMenuBar.php.

References addToToolBar().

00074                                                              {
00075         mosMenuBar::addToToolBar ($task, $alt, 'New', 'new', true);
00076     }

static mosMenuBar::publish ( $  task = 'publish',
$  alt = null 
) [static]

Writes a common 'publish' button

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

Definition at line 83 of file mosMenuBar.php.

References addToToolBar().

00083                                                                  {
00084         mosMenuBar::addToToolBar ($task, $alt, 'Publish', 'publish');
00085     }

static mosMenuBar::publishList ( $  task = 'publish',
$  alt = null 
) [static]

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

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

Definition at line 92 of file mosMenuBar.php.

References addToToolBar(), and T_().

00092                                                                      {
00093         $listprompt = T_('Please make a selection from the list to publish');
00094         mosMenuBar::addToToolBar ($task, $alt, 'Publish', 'publish', false, $listprompt);
00095     }

static mosMenuBar::makeDefault ( $  task = 'default',
$  alt = null 
) [static]

Writes a common 'default' button for a record

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

Definition at line 102 of file mosMenuBar.php.

References addToToolBar(), and T_().

00102                                                                      {
00103         $listprompt = T_('Please select an item to make default');
00104         mosMenuBar::addToToolBar ($task, $alt, 'Default', 'publish', false, $listprompt);
00105     }

static mosMenuBar::assign ( $  task = 'assign',
$  alt = null 
) [static]

Writes a common 'assign' button for a record

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

Definition at line 112 of file mosMenuBar.php.

References addToToolBar(), and T_().

00112                                                                {
00113         $listprompt = T_('Please select an item to assign');
00114         mosMenuBar::addToToolBar ($task, $alt, 'Assign', 'publish', false, $listprompt);
00115     }

static mosMenuBar::unpublish ( $  task = 'unpublish',
$  alt = null 
) [static]

Writes a common 'unpublish' button

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

Definition at line 122 of file mosMenuBar.php.

References addToToolBar().

00122                                                                      {
00123         mosMenuBar::addToToolBar ($task, $alt, 'Unpublish', 'unpublish');
00124     }

static mosMenuBar::unpublishList ( $  task = 'unpublish',
$  alt = null 
) [static]

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

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

Definition at line 131 of file mosMenuBar.php.

References addToToolBar(), and T_().

00131                                                                          {
00132         $listprompt = T_('Please make a selection from the list to unpublish');
00133         mosMenuBar::addToToolBar ($task, $alt, 'Unpublish', 'unpublish', false, $listprompt);
00134     }

static mosMenuBar::archiveList ( $  task = 'archive',
$  alt = null 
) [static]

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

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

Definition at line 141 of file mosMenuBar.php.

References addToToolBar(), and T_().

00141                                                                      {
00142         $listprompt = T_('Please make a selection from the list to archive');
00143         mosMenuBar::addToToolBar ($task, $alt, 'Archive', 'archive', false, $listprompt);
00144     }

static mosMenuBar::unarchiveList ( $  task = 'unarchive',
$  alt = null 
) [static]

Writes an unarchive button for a list of records

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

Definition at line 151 of file mosMenuBar.php.

References addToToolBar(), and T_().

00151                                                                          {
00152         $listprompt = T_('Please select a news story to unarchive');
00153         mosMenuBar::addToToolBar ($task, $alt, 'Unarchive', 'unarchive', false, $listprompt);
00154     }

static mosMenuBar::editList ( $  task = 'edit',
$  alt = null 
) [static]

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

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

Definition at line 161 of file mosMenuBar.php.

References addToToolBar(), and T_().

00161                                                                {
00162         $listprompt = T_('Please select an item from the list to edit');
00163         mosMenuBar::addToToolBar ($task, $alt, 'Edit', 'edit', false, $listprompt);
00164     }

static mosMenuBar::editListX ( $  task = 'edit',
$  alt = null 
) [static]

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

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

Definition at line 172 of file mosMenuBar.php.

References addToToolBar(), and T_().

00172                                                                 {
00173         $listprompt = T_('Please select an item from the list to edit');
00174         mosMenuBar::addToToolBar ($task, $alt, 'Edit', 'edit', true, $listprompt);
00175     }

static mosMenuBar::editHtml ( $  task = 'edit_source',
$  alt = null 
) [static]

Writes a common 'edit' button for a template html

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

Definition at line 182 of file mosMenuBar.php.

References addToToolBar(), and T_().

00182                                                                       {
00183         $listprompt = T_('Please select an item from the list to edit');
00184         mosMenuBar::addToToolBar ($task, $alt, 'Edit HTML', 'html', false, $listprompt);
00185     }

static mosMenuBar::editHtmlX ( $  task = 'edit_source',
$  alt = null 
) [static]

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

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

Definition at line 193 of file mosMenuBar.php.

References addToToolBar(), and T_().

00193                                                                        {
00194         $listprompt = T_('Please select an item from the list to edit');
00195         mosMenuBar::addToToolBar ($task, $alt, 'Edit HTML', 'html', true, $listprompt);
00196     }

static mosMenuBar::editCss ( $  task = 'edit_css',
$  alt = null 
) [static]

Writes a common 'edit' button for a template css

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

Definition at line 203 of file mosMenuBar.php.

References addToToolBar(), and T_().

00203                                                                   {
00204         $listprompt = T_('Please select an item from the list to edit');
00205         mosMenuBar::addToToolBar ($task, $alt, 'Edit CSS', 'css', false, $listprompt);
00206     }

static mosMenuBar::editCssX ( $  task = 'edit_css',
$  alt = null 
) [static]

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

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

Definition at line 214 of file mosMenuBar.php.

References addToToolBar(), and T_().

00214                                                                    {
00215         $listprompt = T_('Please select an item from the list to edit');
00216         mosMenuBar::addToToolBar ($task, $alt, 'Edit CSS', 'css', true, $listprompt);
00217     }

static mosMenuBar::deleteList ( $  msg = '',
$  task = 'remove',
$  alt = null 
) [static]

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

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

Definition at line 225 of file mosMenuBar.php.

References addToToolBar(), and T_().

00225                                                                             {
00226         $listprompt = T_('Please make a selection from the list to delete');
00227         mosMenuBar::addToToolBar ($task, $alt, 'Delete', 'delete', false, $listprompt);
00228     }

static mosMenuBar::deleteListX ( $  msg = '',
$  task = 'remove',
$  alt = null 
) [static]

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

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

Definition at line 237 of file mosMenuBar.php.

References addToToolBar(), and T_().

00237                                                                              {
00238         $listprompt = T_('Please make a selection from the list to delete');
00239         mosMenuBar::addToToolBar ($task, $alt, T_('Delete'), 'delete', true, $listprompt);
00240     }

static mosMenuBar::trash ( $  task = 'remove',
$  alt = null 
) [static]

Write a trash button that will move items to Trash Manager

Definition at line 245 of file mosMenuBar.php.

References addToToolBar().

00245                                                               {
00246         mosMenuBar::addToToolBar ($task, $alt, 'Trash', 'delete');
00247     }

static mosMenuBar::preview ( $  popup = '',
$  updateEditors = false 
) [static]

Definition at line 250 of file mosMenuBar.php.

00250                                                                       {
00251     }

static mosMenuBar::help ( $  ref,
$  com = false 
) [static]

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

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

Definition at line 258 of file mosMenuBar.php.

References aliroAdminToolbar::getInstance().

00258                                                    {
00259         aliroAdminToolbar::getInstance()->help ($ref, $com);
00260     }

static mosMenuBar::apply ( $  task = 'apply',
$  alt = null 
) [static]

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

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

Definition at line 268 of file mosMenuBar.php.

References addToToolBar(), and T_().

00268                                                              {
00269         mosMenuBar::addToToolBar ($task, $alt, T_('Apply'), 'apply');
00270     }

static mosMenuBar::save ( $  task = 'save',
$  alt = null 
) [static]

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

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

Definition at line 278 of file mosMenuBar.php.

References addToToolBar(), and T_().

00278                                                            {
00279         mosMenuBar::addToToolBar ($task, $alt, T_('Save'), 'save');
00280     }

static mosMenuBar::savenew (  )  [static]

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

Definition at line 285 of file mosMenuBar.php.

References addToToolBar(), and T_().

00285                                      {
00286         mosMenuBar::addToToolBar ('savenew', null, T_('Save'), 'save');
00287     }

static mosMenuBar::saveedit (  )  [static]

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

Definition at line 292 of file mosMenuBar.php.

References addToToolBar(), and T_().

00292                                       {
00293         mosMenuBar::addToToolBar ('saveedit', null, T_('Save'), 'save');
00294     }

static mosMenuBar::cancel ( $  task = 'cancel',
$  alt = null 
) [static]

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

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

Definition at line 301 of file mosMenuBar.php.

References addToToolBar(), and T_().

00301                                                                {
00302         mosMenuBar::addToToolBar ($task, $alt, T_('Cancel'), 'cancel');
00303     }

static mosMenuBar::back ( $  alt = null,
$  href = '' 
) [static]

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

Definition at line 309 of file mosMenuBar.php.

References aliroAdminToolbar::getInstance().

00309                                                        {
00310         aliroAdminToolbar::getInstance()->back ($alt, $href);
00311     }

static mosMenuBar::divider (  )  [static]

Write a divider between menu buttons

Definition at line 316 of file mosMenuBar.php.

References aliroAdminToolbar::getInstance().

00316                                      {
00317         aliroAdminToolbar::getInstance()->divider ();
00318     }

static mosMenuBar::media_manager ( $  directory = '',
$  alt = null 
) [static]

Writes a media_manager button

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

Definition at line 324 of file mosMenuBar.php.

References aliroAdminToolbar::getInstance().

00324                                                                        {
00325         aliroAdminToolbar::getInstance()->mediaManager($directory, $alt);
00326     }

static mosMenuBar::spacer ( $  width = ''  )  [static]

Writes a spacer cell

Parameters:
string The width for the cell

Definition at line 332 of file mosMenuBar.php.

00332                                                {
00333     }

static mosMenuBar::endTable (  )  [static]

Writes the end of the menu bar table

Definition at line 338 of file mosMenuBar.php.

00338                                       {
00339     }

The documentation for this class was generated from the following file:
Generated on Thu Apr 17 13:03:34 2008 for ALIRO by  doxygen 1.5.5