Package org.apache.poi.hwpf.model.types

Class SHD80AbstractType

java.lang.Object

org.apache.poi.hwpf.model.types.SHD80AbstractType

Direct Known Subclasses:

ShadingDescriptor80

@Internal
public abstract class SHD80AbstractType
extends Object

The Shd80 structure specifies the colors and pattern that are used for background shading. As an exception to the constraints that are specified by Ico and Ipat, a Shd80 can be set to Shd80Nil and specifies that no shading is applied.

Class and fields descriptions are quoted from Word (.doc) Binary File Format by Microsoft Corporation

NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/types/definitions.

This class is internal. It content or properties may change without notice due to changes in our knowledge of internal Microsoft Word binary structures.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
byte	getIcoBack()	Background color
byte	getIcoFore()	Foreground color
byte	getIpat()	Shading pattern
static int	getSize()	Size of record
short	getValue()	Get the value field for the SHD80 record.
int	hashCode()
byte[]	serialize()
void	serialize(byte[] data, int offset)
void	setIcoBack(byte value)	Sets the icoBack field value.
void	setIcoFore(byte value)	Sets the icoFore field value.
void	setIpat(byte value)	Sets the ipat field value.
void	setValue(short field_1_value)	Set the value field for the SHD80 record.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

serialize

public void serialize(byte[] data,
                      int offset)

serialize

public byte[] serialize()

getSize

public static int getSize()

Size of record

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getValue

@Internal
public short getValue()

Get the value field for the SHD80 record.

setValue

@Internal
public void setValue(short field_1_value)

Set the value field for the SHD80 record.

setIcoFore

@Internal
public void setIcoFore(byte value)

Sets the icoFore field value. Foreground color

getIcoFore

@Internal
public byte getIcoFore()

Foreground color

Returns:

the icoFore field value.

setIcoBack

@Internal
public void setIcoBack(byte value)

Sets the icoBack field value. Background color

getIcoBack

@Internal
public byte getIcoBack()

Background color

Returns:

the icoBack field value.

setIpat

@Internal
public void setIpat(byte value)

Sets the ipat field value. Shading pattern

getIpat

@Internal
public byte getIpat()

Shading pattern

Returns:

the ipat field value.