org.sakaiproject.cheftool.menu

Class MenuField

java.lang.Object

org.sakaiproject.cheftool.menu.MenuField

All Implemented Interfaces:

MenuItem

public class MenuField
extends Object
implements MenuItem

MenuField is a text entry field in a menu / toolbar.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	m_accessibilityLabel Optional accessibility info that can be set
protected String	m_action The action to perform.
protected String	m_form The form name string for the entry.
protected String	m_name The form field name.
protected String	m_value The value to display in the field.

Fields inherited from interface org.sakaiproject.cheftool.api.MenuItem

CHECKED_FALSE, CHECKED_NA, CHECKED_TRUE, STATE_MENU

Constructor Summary

Constructors

Constructor and Description
MenuField(String name, String form, String action, String value) Construct.
MenuField(String name, String form, String action, String value, String accessibilityLabel) Construct.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAccessibilityLabel()
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() Does this item act as a container for other items?
boolean	getIsDivider() Is this item a divider ?
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 - this is really the form field name.
String	getUrl() Access the full URL string for this item; what to do when the user clicks.
String	getValue() Access the value string for this item - the initial value.
boolean	isEmpty() Check if there are any sub-items.
MenuField	setUrl(String url) Set the full URL of the entry.
int	size() Count the sub-items of the item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_name

protected String m_name

The form field name.

m_form

protected String m_form

The form name string for the entry.

m_value

protected String m_value

The value to display in the field.

m_action

protected String m_action

The action to perform.

m_accessibilityLabel

protected String m_accessibilityLabel

Optional accessibility info that can be set

Constructor Detail

MenuField

public MenuField(String name,
         String form,
         String action,
         String value,
         String accessibilityLabel)

Construct.

MenuField

public MenuField(String name,
         String form,
         String action,
         String value)

Construct.

Method Detail

setUrl

public MenuField setUrl(String url)

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.

Returns:

This, for convenience.

getIsContainer

public boolean getIsContainer()

Does this item act as a container for other items?

Specified by:

getIsContainer in interface MenuItem

Returns:

true if this MenuItem is a container for other items, false if not.

getIsDivider

public boolean getIsDivider()

Is this item a divider ?

Specified by:

getIsDivider in interface MenuItem

Returns:

true if this MenuItem is a divider, false if not.

getTitle

public String getTitle()

Access the display title for the item - this is really the form field name.

Specified by:

getTitle in interface MenuItem

Returns:

The display title for the item - but really, the form field name.

getIcon

public String getIcon()

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

Specified by:

getIcon in interface MenuItem

Returns:

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

getIsEnabled

public boolean getIsEnabled()

Access the enabled flag for the item.

Specified by:

getIsEnabled in interface MenuItem

Returns:

True if the item is enabled, false if not.

getValue

public String getValue()

Access the value string for this item - the initial value.

Returns:

The value string for this item - the initial value.

getAction

public String getAction()

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 "".

Specified by:

getAction in interface MenuItem

Returns:

The action string for this item.

getUrl

public String getUrl()

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 "").

Specified by:

getUrl in interface MenuItem

Returns:

The full URL string for this item.

getForm

public String getForm()

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

Specified by:

getForm in interface MenuItem

Returns:

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

getItems

public List getItems()

Access the sub-items of the item. Note: if !isContainer(), there will be no sub-items (will return EmptyIterator).

Specified by:

getItems in interface MenuItem

Returns:

The sub-items of the item.

getItem

public MenuItem getItem(int index)

Access one sub-items of the item. Note: if !isContainer(), there will be no sub-items (will return null).

Specified by:

getItem in interface MenuItem

Parameters:

index - The index position (0 based) for the sub-item to get.

Returns:

The sub-item of the item.

getChecked

public int getChecked()

Access the checked status of this item. Possible values:

Specified by:

getChecked in interface MenuItem

Returns:

The the checked status of this item.

See Also:

MenuItem

size

public int size()

Count the sub-items of the item. Note: if !isContainer(), the count is 0.

Specified by:

size in interface MenuItem

Returns:

The count of sub-items of the item.

isEmpty

public boolean isEmpty()

Check if there are any sub-items. Note: if !isContainer(), this is empty.

Specified by:

isEmpty in interface MenuItem

Returns:

true of there are no sub-items, false if there are.

getIsField

public boolean getIsField()

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

Specified by:

getIsField in interface MenuItem

Returns:

True if the item is a field, false if not.

getAccessibilityLabel

public String getAccessibilityLabel()

Specified by:

getAccessibilityLabel in interface MenuItem