Package de.xima.fc.gui.model

Class SelectItemStatus

java.lang.Object

de.xima.fc.gui.model.SelectItemStatus

All Implemented Interfaces:

Serializable

public final class SelectItemStatus
extends Object
implements Serializable

Since:

8.5.4

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
static SelectItemStatus	forSelectItem(javax.faces.model.SelectItem item, Collection<String> groupNames)
String	getDescription()	Gets the description of the select item, or an empty string if the description is null.
List<String>	getGroupNames()	Gets the list of labels of all parent groups of the select item, starting with the outermost group and ending with the innermost group.
String	getLabel()	Gets the label of the select item, or an empty string if the label is null.
boolean	isDisabled()	Checks if the select item is disabled.
boolean	isEscape()	Checks if the select item's label or description should be escaped (or interpreted as HTML).
boolean	isNoSelectionOption()	Checks if the select item is a no selection option ("please select" option).

Methods inherited from class java.lang.Object

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

Method Detail

forSelectItem

public static SelectItemStatus forSelectItem(javax.faces.model.SelectItem item,
                                             Collection<String> groupNames)

getDescription

public String getDescription()

Gets the description of the select item, or an empty string if the description is null.

Returns:

The description of the select item, or an empty string if the description is null.

getGroupNames

public List<String> getGroupNames()

Gets the list of labels of all parent groups of the select item, starting with the outermost group and ending with the innermost group. If the select item is not located inside any group, this list is empty

Returns:

All group labels of all parent groups that contain the select item.

getLabel

public String getLabel()

Gets the label of the select item, or an empty string if the label is null.

Returns:

The label of the select item, or an empty string if the label is null.

isDisabled

public boolean isDisabled()

Checks if the select item is disabled.

Returns:

True if the select item is disabled, false otherwise.

isEscape

public boolean isEscape()

Checks if the select item's label or description should be escaped (or interpreted as HTML).

Returns:

True if the label or description should be escaped, false otherwise.

isNoSelectionOption

public boolean isNoSelectionOption()

Checks if the select item is a no selection option ("please select" option).

Returns:

True if the select item is a no selection option, false otherwise.