|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SelectionList
A list of values from which one can be selected by the end-user.
This SelectionList consists of ListItems.
Method Summary | |
---|---|
void |
addToFieldTypeXml(org.outerx.daisy.x10.SelectionListDocument.SelectionList selectionListXml)
|
ListItem[] |
getItems()
Gets the selection list items. |
ListItem[] |
getItems(long branchId,
long languageId,
java.util.Locale locale)
Gets the selection list items. |
java.lang.String |
getLabel(java.lang.Object value,
java.util.Locale locale)
Returns the label defined in the selection list for the given value, or null if not available. |
Method Detail |
---|
ListItem[] getItems()
By preference, you should use the method getItems(long, long, java.util.Locale)
.
This method will fail if the selection list implementation requires a branch
and language.
ListItem[] getItems(long branchId, long languageId, java.util.Locale locale)
Some selection list implementations might want to filter the items based on the branch and language of the context in which this selection list is used (= typically the document that is being edited). Therefore, it is important that the branch and language or specified.
branchId
- the branch of the document that is being editedlanguageId
- the language of the document that is being editedjava.lang.String getLabel(java.lang.Object value, java.util.Locale locale)
void addToFieldTypeXml(org.outerx.daisy.x10.SelectionListDocument.SelectionList selectionListXml)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |