MPXJ: Microsoft Project Exchange

net.sf.mpxj.mpp
Enum BackgroundPattern

java.lang.Object
  extended by java.lang.Enum<BackgroundPattern>
      extended by net.sf.mpxj.mpp.BackgroundPattern
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<BackgroundPattern>, MpxjEnum

public enum BackgroundPattern
extends java.lang.Enum<BackgroundPattern>
implements MpxjEnum

Represents the pattern used to fill a group.


Enum Constant Summary
BACKSLASH
           
CHECKERED
           
DENSEFORWARDSLASH
           
DOTTED
           
FORWARDSLASH
           
HEAVYDOTTED
           
HEAVYVERTICALSTRIPE
           
INVERSEBACKSLASH
           
INVERSECHECKERED
           
INVERSEFORWARDSLASH
           
LIGHTDOTTED
           
LIGHTVERTICALSTRIPE
           
SOLID
           
TRANSPARENT
           
 
Method Summary
static BackgroundPattern getInstance(int type)
          Retrieve an instance of the enum based on its int value.
 java.lang.String getName()
          Retrieve the line style name.
 int getValue()
          Accessor method used to retrieve the numeric representation of the enum.
 java.lang.String toString()
          Retrieve the String representation of this line style.
static BackgroundPattern valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static BackgroundPattern[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

TRANSPARENT

public static final BackgroundPattern TRANSPARENT

SOLID

public static final BackgroundPattern SOLID

LIGHTDOTTED

public static final BackgroundPattern LIGHTDOTTED

DOTTED

public static final BackgroundPattern DOTTED

HEAVYDOTTED

public static final BackgroundPattern HEAVYDOTTED

BACKSLASH

public static final BackgroundPattern BACKSLASH

FORWARDSLASH

public static final BackgroundPattern FORWARDSLASH

INVERSEBACKSLASH

public static final BackgroundPattern INVERSEBACKSLASH

INVERSEFORWARDSLASH

public static final BackgroundPattern INVERSEFORWARDSLASH

LIGHTVERTICALSTRIPE

public static final BackgroundPattern LIGHTVERTICALSTRIPE

HEAVYVERTICALSTRIPE

public static final BackgroundPattern HEAVYVERTICALSTRIPE

CHECKERED

public static final BackgroundPattern CHECKERED

DENSEFORWARDSLASH

public static final BackgroundPattern DENSEFORWARDSLASH

INVERSECHECKERED

public static final BackgroundPattern INVERSECHECKERED
Method Detail

values

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

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

valueOf

public static BackgroundPattern 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

getInstance

public static BackgroundPattern getInstance(int type)
Retrieve an instance of the enum based on its int value.

Parameters:
type - int type
Returns:
enum instance

getValue

public int getValue()
Accessor method used to retrieve the numeric representation of the enum.

Specified by:
getValue in interface MpxjEnum
Returns:
int representation of the enum

getName

public java.lang.String getName()
Retrieve the line style name. Currently this is not localised.

Returns:
style name

toString

public java.lang.String toString()
Retrieve the String representation of this line style.

Overrides:
toString in class java.lang.Enum<BackgroundPattern>
Returns:
String representation of this line style


Copyright © 2000-2014 Packwood Software. All Rights Reserved.