org.eclipse.birt.report.model.api.metadata
Interface IChoice

All Known Implementing Classes:
org.eclipse.birt.report.model.metadata.Choice

public interface IChoice

Describes the options for a property value. A choice has a display name and an internal name (XML name). The display name is localized, the XML name is not.


Method Summary
 IChoice copy()
          Creates a deep copy of this choice.
 java.lang.String getDisplayName()
          Returns the localized display name for the choice.
 java.lang.String getDisplayNameKey()
          Returns the display name resource key for the choice.
 java.lang.String getName()
          Returns the choice name that appears in the XML design file.
 java.lang.Object getValue()
          Returns the value of the choice.
 

Method Detail

getDisplayName

public java.lang.String getDisplayName()
Returns the localized display name for the choice.

Returns:
the localized display name for the choice.

getDisplayNameKey

public java.lang.String getDisplayNameKey()
Returns the display name resource key for the choice.

Returns:
the display name resource key

getName

public java.lang.String getName()
Returns the choice name that appears in the XML design file.

Returns:
the choice name used in the XML design file

getValue

public java.lang.Object getValue()
Returns the value of the choice. The returned value equals to the internal name of the system choice.

Returns:
the value of the choice

copy

public IChoice copy()
Creates a deep copy of this choice.

Returns:
a copy of this choice.


Copyright © 2005 Actuate Corp. All rights reserved.