org.eclipse.birt.chart.model.attribute
Enum ChartDimension

java.lang.Object
  extended by java.lang.Enum<ChartDimension>
      extended by org.eclipse.birt.chart.model.attribute.ChartDimension
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ChartDimension>, org.eclipse.emf.common.util.Enumerator

public enum ChartDimension
extends java.lang.Enum<ChartDimension>
implements org.eclipse.emf.common.util.Enumerator

A representation of the literals of the enumeration ' Chart Dimension', and utility methods for working with them. This type defines the allowed values for Chart dimensions. Any new Chart dimension type needs to be added here to be supported.

See Also:
AttributePackage.getChartDimension()

Enum Constant Summary
THREE_DIMENSIONAL_LITERAL
          The 'Three Dimensional' literal object.
TWO_DIMENSIONAL_LITERAL
          The 'Two Dimensional' literal object.
TWO_DIMENSIONAL_WITH_DEPTH_LITERAL
          The 'Two Dimensional With Depth' literal object.
 
Field Summary
static int THREE_DIMENSIONAL
          The 'Three Dimensional' literal value.
static int TWO_DIMENSIONAL
          The 'Two Dimensional' literal value.
static int TWO_DIMENSIONAL_WITH_DEPTH
          The 'Two Dimensional With Depth' literal value.
static java.util.List<ChartDimension> VALUES
          A public read-only list of all the 'Chart Dimension' enumerators.
 
Method Summary
static ChartDimension get(int value)
          Returns the 'Chart Dimension' literal with the specified integer value.
static ChartDimension get(java.lang.String literal)
          Returns the 'Chart Dimension' literal with the specified literal value.
static ChartDimension getByName(java.lang.String name)
          Returns the 'Chart Dimension' literal with the specified name.
 java.lang.String getLiteral()
           
 java.lang.String getName()
           
 int getValue()
           
 java.lang.String toString()
          Returns the literal value of the enumerator, which is its string representation.
static ChartDimension valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ChartDimension[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

TWO_DIMENSIONAL_LITERAL

public static final ChartDimension TWO_DIMENSIONAL_LITERAL
The 'Two Dimensional' literal object.

If the meaning of 'Two Dimensional' literal object isn't clear, there really should be more of a description here...

See Also:
TWO_DIMENSIONAL

TWO_DIMENSIONAL_WITH_DEPTH_LITERAL

public static final ChartDimension TWO_DIMENSIONAL_WITH_DEPTH_LITERAL
The 'Two Dimensional With Depth' literal object.

If the meaning of 'Two Dimensional With Depth' literal object isn't clear, there really should be more of a description here...

See Also:
TWO_DIMENSIONAL_WITH_DEPTH

THREE_DIMENSIONAL_LITERAL

public static final ChartDimension THREE_DIMENSIONAL_LITERAL
The 'Three Dimensional' literal object.

If the meaning of 'Three Dimensional' literal object isn't clear, there really should be more of a description here...

See Also:
THREE_DIMENSIONAL
Field Detail

TWO_DIMENSIONAL

public static final int TWO_DIMENSIONAL
The 'Two Dimensional' literal value.

See Also:
TWO_DIMENSIONAL_LITERAL, Constant Field Values

TWO_DIMENSIONAL_WITH_DEPTH

public static final int TWO_DIMENSIONAL_WITH_DEPTH
The 'Two Dimensional With Depth' literal value.

See Also:
TWO_DIMENSIONAL_WITH_DEPTH_LITERAL, Constant Field Values

THREE_DIMENSIONAL

public static final int THREE_DIMENSIONAL
The 'Three Dimensional' literal value.

See Also:
THREE_DIMENSIONAL_LITERAL, Constant Field Values

VALUES

public static final java.util.List<ChartDimension> VALUES
A public read-only list of all the 'Chart Dimension' enumerators.

Method Detail

values

public static final ChartDimension[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(ChartDimension c : ChartDimension.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static ChartDimension valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

get

public static ChartDimension get(java.lang.String literal)
Returns the 'Chart Dimension' literal with the specified literal value.


getByName

public static ChartDimension getByName(java.lang.String name)
Returns the 'Chart Dimension' literal with the specified name.


get

public static ChartDimension get(int value)
Returns the 'Chart Dimension' literal with the specified integer value.


getValue

public int getValue()

Specified by:
getValue in interface org.eclipse.emf.common.util.Enumerator

getName

public java.lang.String getName()

Specified by:
getName in interface org.eclipse.emf.common.util.Enumerator

getLiteral

public java.lang.String getLiteral()

Specified by:
getLiteral in interface org.eclipse.emf.common.util.Enumerator

toString

public java.lang.String toString()
Returns the literal value of the enumerator, which is its string representation.

Overrides:
toString in class java.lang.Enum<ChartDimension>


Copyright © 2005-2008 Actuate Corp. All rights reserved.