|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IChoiceSet
Represents a set of choices on a predefined or user defined property type or property definition.
Method Summary | |
---|---|
boolean |
contains(java.lang.String choiceName)
Returns true if the choice set has a match for the given name. |
IChoice |
findChoice(java.lang.String name)
Finds a Choice in the ChoiceSet for the given choice name. |
IChoice |
findChoiceByDisplayName(java.lang.String name)
Finds a IChoice in the IChoiceSet for its display name. |
UserChoice |
findUserChoiceByDisplayName(org.eclipse.birt.report.model.core.Module module,
java.lang.String name)
Finds a UserChoice in the IChoiceSet for its display name. |
IChoice[] |
getChoices()
Returns an array containing the choices, the return choices are in their internal sequence. |
IChoice[] |
getChoices(java.util.Comparator c)
Returns an array containing the choices, the return choices are sorted according to the given comparator. |
java.lang.String |
getName()
Returns the name of this ChoiceSet. |
boolean |
isUserDefined()
Tests whether this is a user-defined choice set or not. |
Method Detail |
---|
boolean contains(java.lang.String choiceName)
choiceName
- the choice name to match
boolean isUserDefined()
true
if the choice set is defined by user.
Otherwise, false
.java.lang.String getName()
IChoice[] getChoices()
IChoice[] getChoices(java.util.Comparator c)
c
- the comparator that will be used to sort the choices. A
null value indicates that the choices are
natural ordered by their name.
IChoice findChoice(java.lang.String name)
ChoiceSet
for the given choice name.
name
- the name of a Choice.
null
if
choice not found.IChoice findChoiceByDisplayName(java.lang.String name)
IChoiceSet
for its display name. For
a user defined choice, the display name can be null
.
name
- display name of a IChoice.
null
if
choice is not found.UserChoice findUserChoiceByDisplayName(org.eclipse.birt.report.model.core.Module module, java.lang.String name)
IChoiceSet
for its display name. For
a user defined choice, the display name can be null
.
module
- the modulename
- display name of a UserChoice.
null
if
choice is not found.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |