net.sf.latexdraw.glib.ui
Enum LMagneticGrid.GridStyle

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

public static enum LMagneticGrid.GridStyle
extends java.lang.Enum<LMagneticGrid.GridStyle>

This enumeration contains the different style of a magnetic grid.


Enum Constant Summary
CUSTOMISED
           
NONE
           
STANDARD
           
 
Method Summary
abstract  java.lang.String getLabel()
           
static LMagneticGrid.GridStyle getStyleFromLabel(java.lang.String label)
          Searches the style which label matches the given label.
static LMagneticGrid.GridStyle getStylefromName(java.lang.String name)
          Searches the style which label matches the given name.
static LMagneticGrid.GridStyle valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static LMagneticGrid.GridStyle[] 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

CUSTOMISED

public static final LMagneticGrid.GridStyle CUSTOMISED

STANDARD

public static final LMagneticGrid.GridStyle STANDARD

NONE

public static final LMagneticGrid.GridStyle NONE
Method Detail

values

public static LMagneticGrid.GridStyle[] 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 (LMagneticGrid.GridStyle c : LMagneticGrid.GridStyle.values())
    System.out.println(c);

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

valueOf

public static LMagneticGrid.GridStyle 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 style.
Since:
3.0

getStylefromName

public static LMagneticGrid.GridStyle getStylefromName(java.lang.String name)
Searches the style which label matches the given name.

Parameters:
name - The name of the style to find.
Returns:
The found style or null.
Since:
3.0

getStyleFromLabel

public static LMagneticGrid.GridStyle getStyleFromLabel(java.lang.String label)
Searches the style which label matches the given label. Warning, labels change depending on the language.

Parameters:
label - The label of the style to find.
Returns:
The found style or null.
Since:
3.0