A C G I M O P S

A

add(String) - Method in interface org.sakaiproject.cheftool.api.Alert

Add a new alert line.

add(MenuItem) - Method in interface org.sakaiproject.cheftool.api.Menu

Add a menu item to the bar.

adjustDividers() - Method in interface org.sakaiproject.cheftool.api.Menu

Adjust by removing any dividers at the start or end.

Alert - Interface in org.sakaiproject.cheftool.api

Alert is a interface for a set of messages intended for user display in the user interface.

C

CHECKED_FALSE - Static variable in interface org.sakaiproject.cheftool.api.MenuItem

CHECKED_NA - Static variable in interface org.sakaiproject.cheftool.api.MenuItem

Checked status values.

CHECKED_TRUE - Static variable in interface org.sakaiproject.cheftool.api.MenuItem

clear() - Method in interface org.sakaiproject.cheftool.api.Alert

Remove any messages in the Alert.

clear() - Method in interface org.sakaiproject.cheftool.api.Menu

Clear the menu of all items.

CONTEXT_ACTION - Static variable in interface org.sakaiproject.cheftool.api.Menu

CONTEXT_MENU - Static variable in interface org.sakaiproject.cheftool.api.Menu

G

getAccessibilityLabel() - Method in interface org.sakaiproject.cheftool.api.MenuItem

Get the optional label that may be set by components to provide accessiblity information, eg alt tags, title attributes etc

getAction() - Method in interface org.sakaiproject.cheftool.api.MenuItem

Access the action string for this item; what to do when the user clicks.

getAlert() - Method in interface org.sakaiproject.cheftool.api.Alert

Access the alert message.

getChecked() - Method in interface org.sakaiproject.cheftool.api.MenuItem

Access the checked status of this item.

getForm() - Method in interface org.sakaiproject.cheftool.api.MenuItem

Access the form name whose values will be used when this item is selected.

getIcon() - Method in interface org.sakaiproject.cheftool.api.MenuItem

Access the icon name for the item (or null if no icon).

getIsContainer() - Method in interface org.sakaiproject.cheftool.api.MenuItem

Does this item act as a container for other items?

getIsCurrent() - Method in interface org.sakaiproject.cheftool.api.MenuItem

Access the is-current flag.

getIsDivider() - Method in interface org.sakaiproject.cheftool.api.MenuItem

Is this item a divider ?

getIsEnabled() - Method in interface org.sakaiproject.cheftool.api.MenuItem

Access the enabled flag for the item.

getIsField() - Method in interface org.sakaiproject.cheftool.api.MenuItem

Access the is-field (not a button) flag.

getItem(int) - Method in interface org.sakaiproject.cheftool.api.MenuItem

Access one sub-items of the item.

getItems() - Method in interface org.sakaiproject.cheftool.api.MenuItem

Access the sub-items of the item.

getShowdisabled() - Method in interface org.sakaiproject.cheftool.api.Menu

Access whether disabled items in this menu should be shown.

getTitle() - Method in interface org.sakaiproject.cheftool.api.MenuItem

Access the display title for the item.

getUrl() - Method in interface org.sakaiproject.cheftool.api.MenuItem

Access the full URL string for this item; what to do when the user clicks.

I

isEmpty() - Method in interface org.sakaiproject.cheftool.api.Alert

Check to see if the alert is empty, or has been populated.

isEmpty() - Method in interface org.sakaiproject.cheftool.api.MenuItem

Check if there are any sub-items.

M

Menu - Interface in org.sakaiproject.cheftool.api

Menu is an interface for an ordered list of MenuItems.

MenuItem - Interface in org.sakaiproject.cheftool.api

MenuItem is the interface for all the objects that can live on a menu.

O

org.sakaiproject.cheftool.api - package org.sakaiproject.cheftool.api

P

peekAlert() - Method in interface org.sakaiproject.cheftool.api.Alert

Access the alert message, but unlike getAlert(), do not clear the message.

S

setShowdisabled(boolean) - Method in interface org.sakaiproject.cheftool.api.Menu

Set whether disabled items in this menu should be shown.

size() - Method in interface org.sakaiproject.cheftool.api.MenuItem

Count the sub-items of the item.

STATE_MENU - Static variable in interface org.sakaiproject.cheftool.api.Menu

STATE_MENU - Static variable in interface org.sakaiproject.cheftool.api.MenuItem

A C G I M O P S