| java.lang.Object
 org.sakaiproject.cheftool.menu.MenuEntry
| MenuEntry | | public class MenuEntry implements MenuItem(Code) | |
MenuEntry is a clickable entry in a menu.
|
| Field Summary | |
| protected String | m_action
The action string for the entry. | | protected int | m_checked
The checked status (@see MenuItem for values). | | protected boolean | m_enabled
The enabled flag for the entry. | | protected String | m_form
The form name string for the entry. | | protected String | m_icon
The icon name for the entry. | | protected String | m_title
The display title for the entry. | | protected String | m_url
The full URL string for the entry. |
| Constructor Summary | |
| public | MenuEntry(String title, String icon, boolean enabled, int checked, String action, String form)
Construct a menu. | | public | MenuEntry(String title, String icon, boolean enabled, int checked, String action)
Construct a menu. | | public | MenuEntry(String title, boolean enabled, String action)
Construct a menu. | | public | MenuEntry(String title, String action)
Construct a menu. |
| 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 boolean | getIschecked()
Access the checked status of this item. | | 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 MenuEntry | setUrl(String url)
Set the full URL of the entry. | | public int | size()
Count the sub-items of the item. |
| m_action | | protected String m_action(Code) | | The action string for the entry.
|
| m_checked | | protected int m_checked(Code) | | The checked status (@see MenuItem for values).
|
| m_enabled | | protected boolean m_enabled(Code) | | The enabled flag for the entry.
|
| m_form | | protected String m_form(Code) | | The form name string for the entry.
|
| m_icon | | protected String m_icon(Code) | | The icon name for the entry.
|
| m_title | | protected String m_title(Code) | | The display title for the entry.
|
| m_url | | protected String m_url(Code) | | The full URL string for the entry.
|
| MenuEntry | | public MenuEntry(String title, String icon, boolean enabled, int checked, String action)(Code) | | Construct a menu.
|
| MenuEntry | | public MenuEntry(String title, boolean enabled, String action)(Code) | | Construct a menu.
|
| 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 ""). Note: if the entry is not enabled, this 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 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. |
| getIschecked | | public boolean getIschecked()(Code) | | Access the checked status of this item.
True if item is checked, false otherwise. |
| 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. |
| setUrl | | public MenuEntry setUrl(String url)(Code) | | Set the full URL of the entry. To create an entry with a URL, create one first with a "" action, then call this.
Parameters:
url - The full URL for the entry. This, for convenience. |
| 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. |
|
|