net.sf.latexdraw.ui
Enum ScaleRuler.Unit

java.lang.Object
  extended by java.lang.Enum<ScaleRuler.Unit>
      extended by net.sf.latexdraw.ui.ScaleRuler.Unit
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ScaleRuler.Unit>
Enclosing class:
ScaleRuler

public static enum ScaleRuler.Unit
extends java.lang.Enum<ScaleRuler.Unit>

Defines the different possible units used by the rulers.


Enum Constant Summary
CM
          Centimetre
INCH
          Inch
 
Method Summary
abstract  java.lang.String getLabel()
           
static ScaleRuler.Unit getUnit(java.lang.String label)
           
static ScaleRuler.Unit valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ScaleRuler.Unit[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

CM

public static final ScaleRuler.Unit CM
Centimetre


INCH

public static final ScaleRuler.Unit INCH
Inch

Method Detail

values

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

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

valueOf

public static ScaleRuler.Unit 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
java.lang.NullPointerException - if the argument is null

getLabel

public abstract java.lang.String getLabel()
Returns:
The label of the unit.
Since:
3.0

getUnit

public static ScaleRuler.Unit getUnit(java.lang.String label)
Parameters:
label - The label to test.
Returns:
The unit corresponding to the given label, or null.
Since:
3.0