| java.lang.Object org.sakaiproject.cheftool.menu.MenuDivider
MenuDivider | public class MenuDivider implements MenuItem(Code) | |
MenuDivider is a menu item that makes a visible divider in the menu.
|
Constructor Summary | |
public | MenuDivider() Construct a menu divider. |
Method Summary | |
public String | getAction() Access the action string for this item; what to do when the user clicks. | public int | getChecked() Access the checked status of this item. | public String | getForm() Access the form name whose values will be used when this item is selected. | public String | getIcon() Access the icon name for the item (or null if no icon). | public boolean | getIsContainer() | public boolean | getIsDivider() | public boolean | getIsEnabled() Access the enabled flag for the item. | public boolean | getIsField() Access the is-field (not a button) flag. | public MenuItem | getItem(int index) Access one sub-items of the item. | public List | getItems() Access the sub-items of the item. | public String | getTitle() Access the display title for the item. | public String | getUrl() Access the full URL string for this item; what to do when the user clicks. | public boolean | isEmpty() Check if there are any sub-items. | public int | size() Count the sub-items of the item. |
MenuDivider | public MenuDivider()(Code) | | Construct a menu divider.
|
getAction | public 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 | public int getChecked()(Code) | | Access the checked status of this item. Possible values:
See Also: MenuItem The the checked status of this item. |
getForm | public 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. |
getIcon | public 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 | public 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 | public boolean getIsDivider()(Code) | | Is this item a divider ?
true if this MenuItem is a divider, false if not. |
getIsEnabled | public boolean getIsEnabled()(Code) | | Access the enabled flag for the item.
True if the item is enabled, false if not. |
getIsField | public boolean getIsField()(Code) | | Access the is-field (not a button) flag.
True if the item is a field, false if not. |
getItem | public 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 | public 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 | public String getTitle()(Code) | | Access the display title for the item.
The display title for the item. |
getUrl | public 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 | public 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 | public 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. |
|
|