Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.birt.report.model.api.metadata
Class UserChoice

    java.lang.Object
      org.eclipse.birt.report.model.metadata.Choice
          org.eclipse.birt.report.model.api.metadata.UserChoice

All Implemented Interfaces:
  java.lang.Cloneable, java.lang.Comparable, IChoice

    public final class UserChoice

extends org.eclipse.birt.report.model.metadata.Choice

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

### VALUE_PROP

    public static final java.lang.String VALUE_PROP

  Name of the choice value property.

  See Also:
    Constant Field Values

### DISPLAY_NAME_PROP

    public static final java.lang.String DISPLAY_NAME_PROP

  Name of the display name property.

  See Also:
    Constant Field Values

### displayName

    protected java.lang.String displayName

  The choice's display name.

### value

    protected java.lang.Object value

  The user choice's value, it is required.

Constructor Detail

### UserChoice

    public UserChoice(java.lang.String name,
                      java.lang.String id)

  Constructs a new User Choice by the given name and id.

  Parameters:
    `name` - the choice name
    `id` - the message ID for the display name

Method Detail

### getDisplayName

    public java.lang.String getDisplayName()

  Returns the property value of "displayName" for the choice.

  Specified by:
    `getDisplayName` in interface `IChoice`
  Overrides:
    `getDisplayName` in class `org.eclipse.birt.report.model.metadata.Choice`
  Returns:
    the display name for the choice.

### setDisplayName

    public void setDisplayName(java.lang.String name)

  Returns the display name for the choice.

  Parameters:
    `name` - the display name

### setValue

    public void setValue(java.lang.Object theValue)

  Sets the value of the user choice.

  Parameters:
    `theValue` - the value of the user choice to set

### getValue

    public java.lang.Object getValue()

  Gets the value of the user choice.

  Specified by:
    `getValue` in interface `IChoice`
  Overrides:
    `getValue` in class `org.eclipse.birt.report.model.metadata.Choice`
  Returns:
    the value of the user choice

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 Actuate Corp. All rights reserved.