BackgroundPattern (MPXJ 4.5.0-rc1 API)

java.lang.Object
- java.lang.Enum<BackgroundPattern>
- - net.sf.mpxj.mpp.BackgroundPattern

All Implemented Interfaces:

Serializable, Comparable<BackgroundPattern>, MpxjEnum
```
public enum BackgroundPattern
extends Enum<BackgroundPattern>
implements MpxjEnum
```
Represents the pattern used to fill a group.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BACKSLASH`
`CHECKERED`
`DENSEFORWARDSLASH`
`DOTTED`
`FORWARDSLASH`
`HEAVYDOTTED`
`HEAVYVERTICALSTRIPE`
`INVERSEBACKSLASH`
`INVERSECHECKERED`
`INVERSEFORWARDSLASH`
`LIGHTDOTTED`
`LIGHTVERTICALSTRIPE`
`SOLID`
`TRANSPARENT`

Method Summary

Methods
Modifier and Type	Method and Description
`static BackgroundPattern`	`getInstance(int type)` Retrieve an instance of the enum based on its int value.
`String`	`getName()` Retrieve the line style name.
`int`	`getValue()` Accessor method used to retrieve the numeric representation of the enum.
`String`	`toString()` Retrieve the String representation of this line style.
`static BackgroundPattern`	`valueOf(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(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    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 String getName()
```
    Retrieve the line style name. Currently this is not localised.
    
    Returns:
    style name
  - toString
```
public String toString()
```
    Retrieve the String representation of this line style.
    
    Overrides:
    
    toString in class Enum<BackgroundPattern>
    
    Returns:
    String representation of this line style

Enum BackgroundPattern

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

TRANSPARENT

SOLID

LIGHTDOTTED

DOTTED

HEAVYDOTTED

BACKSLASH

FORWARDSLASH

INVERSEBACKSLASH

INVERSEFORWARDSLASH

LIGHTVERTICALSTRIPE

HEAVYVERTICALSTRIPE

CHECKERED

DENSEFORWARDSLASH

INVERSECHECKERED

Method Detail

values

valueOf

getInstance

getValue

getName

toString