|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.metadata.Choice
org.eclipse.birt.report.model.api.metadata.UserChoice
public final class UserChoice
Describes the user defined choices for a user defined property. The internal name of a choice property is a string. The string maps to a display name shown to the user, and an XML name used in the xml design file. The display name is localized, the XML name is not.
Field Summary | |
---|---|
static java.lang.String |
DISPLAY_NAME_PROP
Name of the display name property. |
protected java.lang.String |
displayName
The choice's display name. |
protected java.lang.Object |
value
The user choice's value, it is required. |
static java.lang.String |
VALUE_PROP
Name of the choice value property. |
Fields inherited from class org.eclipse.birt.report.model.metadata.Choice |
---|
DISPLAY_NAME_ID_PROP, displayNameKey, name, NAME_PROP |
Constructor Summary | |
---|---|
UserChoice(java.lang.String name,
java.lang.String id)
Constructs a new User Choice by the given name and id. |
Method Summary | |
---|---|
java.lang.String |
getDisplayName()
Returns the property value of "displayName" for the choice. |
java.lang.Object |
getValue()
Gets the value of the user choice. |
void |
setDisplayName(java.lang.String name)
Returns the display name for the choice. |
void |
setValue(java.lang.Object theValue)
Sets the value of the user choice. |
Methods inherited from class org.eclipse.birt.report.model.metadata.Choice |
---|
clone, compareTo, copy, getDisplayNameKey, getName, setDisplayNameKey, setName, toString |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String VALUE_PROP
public static final java.lang.String DISPLAY_NAME_PROP
protected java.lang.String displayName
protected java.lang.Object value
Constructor Detail |
---|
public UserChoice(java.lang.String name, java.lang.String id)
name
- the choice nameid
- the message ID for the display nameMethod Detail |
---|
public java.lang.String getDisplayName()
getDisplayName
in interface IChoice
getDisplayName
in class org.eclipse.birt.report.model.metadata.Choice
public void setDisplayName(java.lang.String name)
name
- the display namepublic void setValue(java.lang.Object theValue)
theValue
- the value of the user choice to setpublic java.lang.Object getValue()
getValue
in interface IChoice
getValue
in class org.eclipse.birt.report.model.metadata.Choice
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |