Package org.sakaiproject.cheftool.api
Interface Menu
-
-
Field Summary
Fields Modifier and Type Field Description static StringCONTEXT_ACTIONstatic StringCONTEXT_MENUstatic StringSTATE_MENU-
Fields inherited from interface org.sakaiproject.cheftool.api.MenuItem
CHECKED_FALSE, CHECKED_NA, CHECKED_TRUE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description MenuItemadd(MenuItem item)Add a menu item to the bar.voidadjustDividers()Adjust by removing any dividers at the start or end.voidclear()Clear the menu of all items.booleangetShowdisabled()Access whether disabled items in this menu should be shown.MenusetShowdisabled(boolean value)Set whether disabled items in this menu should be shown.-
Methods inherited from interface org.sakaiproject.cheftool.api.MenuItem
getAccessibilityLabel, getAction, getChecked, getForm, getIcon, getIsContainer, getIsCurrent, getIsDivider, getIsEnabled, getIsField, getItem, getItems, getTitle, getUrl, isEmpty, size
-
-
-
-
Field Detail
-
CONTEXT_ACTION
static final String CONTEXT_ACTION
- See Also:
- Constant Field Values
-
CONTEXT_MENU
static final String CONTEXT_MENU
- See Also:
- Constant Field Values
-
STATE_MENU
static final String STATE_MENU
- See Also:
- Constant Field Values
-
-
Method Detail
-
add
MenuItem add(MenuItem item)
Add a menu item to the bar.- Parameters:
entry- The menu item to add.- Returns:
- the item.
-
clear
void clear()
Clear the menu of all items.
-
adjustDividers
void adjustDividers()
Adjust by removing any dividers at the start or end.
-
setShowdisabled
Menu setShowdisabled(boolean value)
Set whether disabled items in this menu should be shown.- Parameters:
value- True to show disabled items, False otherwise.- Returns:
- This, for convenience.
-
getShowdisabled
boolean getShowdisabled()
Access whether disabled items in this menu should be shown.- Returns:
- Current setting for show-disabled status (true to show disabled items, false to NOT show disabled items).
-
-