org.apache.poi.hwmf.record

Enum HwmfBrushStyle

java.lang.Object

java.lang.Enum<HwmfBrushStyle>

org.apache.poi.hwmf.record.HwmfBrushStyle

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HwmfBrushStyle>

public enum HwmfBrushStyle
extends java.lang.Enum<HwmfBrushStyle>

A 16-bit unsigned integer that defines the brush style. The legal values for this field are defined as follows: if the value is not BS_PATTERN, BS_DIBPATTERNPT MUST be assumed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BS_DIBPATTERN A pattern brush specified by a DIB.
BS_DIBPATTERN8X8 Not supported
BS_DIBPATTERNPT A pattern brush specified by a DIB.
BS_HATCHED A brush that paints a predefined simple pattern, or "hatch", onto a solid background.
BS_INDEXED Not supported
BS_LINEAR_GRADIENT (POI arbitrary:) EMF/EMF+ specific value for linear gradient paint
BS_MONOPATTERN Not supported
BS_NULL A brush that does nothing.
BS_PATTERN A brush that paints a pattern defined by a bitmap, which MAY be a Bitmap16 Object or a DeviceIndependentBitmap (DIB) Object.
BS_PATTERN8X8 Not supported
BS_SOLID A brush that paints a single, constant color, either solid or dithered.

Method Summary

Modifier and Type	Method and Description
static HwmfBrushStyle	valueOf(int flag)
static HwmfBrushStyle	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HwmfBrushStyle[]	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

BS_SOLID

public static final HwmfBrushStyle BS_SOLID

A brush that paints a single, constant color, either solid or dithered.

BS_NULL

public static final HwmfBrushStyle BS_NULL

A brush that does nothing. Using a BS_NULL brush in a graphics operation MUST have the same effect as using no brush at all.

BS_HATCHED

public static final HwmfBrushStyle BS_HATCHED

A brush that paints a predefined simple pattern, or "hatch", onto a solid background.

BS_PATTERN

public static final HwmfBrushStyle BS_PATTERN

A brush that paints a pattern defined by a bitmap, which MAY be a Bitmap16 Object or a DeviceIndependentBitmap (DIB) Object.

BS_INDEXED

public static final HwmfBrushStyle BS_INDEXED

Not supported

BS_DIBPATTERN

public static final HwmfBrushStyle BS_DIBPATTERN

A pattern brush specified by a DIB.

BS_DIBPATTERNPT

public static final HwmfBrushStyle BS_DIBPATTERNPT

A pattern brush specified by a DIB.

BS_PATTERN8X8

public static final HwmfBrushStyle BS_PATTERN8X8

Not supported

BS_DIBPATTERN8X8

public static final HwmfBrushStyle BS_DIBPATTERN8X8

Not supported

BS_MONOPATTERN

public static final HwmfBrushStyle BS_MONOPATTERN

Not supported

BS_LINEAR_GRADIENT

public static final HwmfBrushStyle BS_LINEAR_GRADIENT

(POI arbitrary:) EMF/EMF+ specific value for linear gradient paint

Method Detail

values

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

Returns:

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

valueOf

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

valueOf

public static HwmfBrushStyle valueOf(int flag)