| org.sakaiproject.cheftool.api.MenuItem
All known Subclasses: org.sakaiproject.cheftool.menu.MenuDivider, org.sakaiproject.cheftool.menu.MenuEntry, org.sakaiproject.cheftool.menu.MenuField,
| MenuItem | | public interface MenuItem (Code) | |
MenuItem is the interface for all the objects that can live on a menu.
|
| Method Summary | |
| String | getAction()
Access the action string for this item; what to do when the user clicks. | | int | getChecked()
Access the checked status of this item. | | String | getForm()
Access the form name whose values will be used when this item is selected. | | String | getIcon()
Access the icon name for the item (or null if no icon). | | boolean | getIsContainer()
| | boolean | getIsDivider()
| | boolean | getIsEnabled()
Access the enabled flag for the item. | | boolean | getIsField()
Access the is-field (not a button) flag. | | MenuItem | getItem(int index)
Access one sub-items of the item. | | List | getItems()
Access the sub-items of the item. | | String | getTitle()
Access the display title for the item. | | String | getUrl()
Access the full URL string for this item; what to do when the user clicks. | | boolean | isEmpty()
Check if there are any sub-items. | | int | size()
Count the sub-items of the item. |
| CHECKED_FALSE | | final static int CHECKED_FALSE(Code) | | |
| CHECKED_NA | | final static int CHECKED_NA(Code) | | Checked status values.
|
| CHECKED_TRUE | | final static int CHECKED_TRUE(Code) | | |
| getAction | | String getAction()(Code) | | Access the action string for this item; what to do when the user clicks. Note: if getIsMenu(), there will not be an action string (will return "").
The action string for this item. |
| getChecked | | int getChecked()(Code) | | Access the checked status of this item. Possible values are (see above) CHECKED_NA, CHECKED_FALSE, CHECKED_TRUE
The the checked status of this item. |
| getForm | | String getForm()(Code) | | Access the form name whose values will be used when this item is selected.
The form name whose values will be used when this item is selected, or null if there is none. |
| getIcon | | String getIcon()(Code) | | Access the icon name for the item (or null if no icon).
The icon name for the item (or null if no icon). |
| getIsContainer | | boolean getIsContainer()(Code) | | Does this item act as a container for other items?
true if this MenuItem is a container for other items, false if not. |
| getIsDivider | | boolean getIsDivider()(Code) | | Is this item a divider ?
true if this MenuItem is a divider, false if not. |
| getIsEnabled | | boolean getIsEnabled()(Code) | | Access the enabled flag for the item.
True if the item is enabled, false if not. |
| getIsField | | boolean getIsField()(Code) | | Access the is-field (not a button) flag.
True if the item is a field, false if not. |
| getItem | | MenuItem getItem(int index)(Code) | | Access one sub-items of the item. Note: if !isContainer(), there will be no sub-items (will return null).
Parameters:
index - The index position (0 based) for the sub-item to get. The sub-item of the item. |
| getItems | | List getItems()(Code) | | Access the sub-items of the item. Note: if !isContainer(), there will be no sub-items (will return EmptyIterator).
The sub-items of the item. |
| getTitle | | String getTitle()(Code) | | Access the display title for the item.
The display title for the item. |
| getUrl | | String getUrl()(Code) | | Access the full URL string for this item; what to do when the user clicks. Note: this if defined overrides getAction() which should be "". Note: if getIsMenu(), there will not be a URL string (will return "").
The full URL string for this item. |
| isEmpty | | boolean isEmpty()(Code) | | Check if there are any sub-items. Note: if !isContainer(), this is empty.
true of there are no sub-items, false if there are. |
| size | | int size()(Code) | | Count the sub-items of the item. Note: if !isContainer(), the count is 0.
The count of sub-items of the item. |
|
|