loci.poi.ddf

Class EscherSplitMenuColorsRecord

java.lang.Object

loci.poi.ddf.EscherRecord

loci.poi.ddf.EscherSplitMenuColorsRecord

public class EscherSplitMenuColorsRecord
extends EscherRecord

A list of the most recently used colours for the drawings contained in this document.

Author:

Glen Stampoultzis (glens at apache.org)

Field Summary

Fields

Modifier and Type	Field and Description
static String	RECORD_DESCRIPTION
static short	RECORD_ID

Constructor Summary

Constructors

Constructor and Description
EscherSplitMenuColorsRecord()

Method Summary

Modifier and Type	Method and Description
int	fillFields(byte[] data, int offset, EscherRecordFactory recordFactory) This method deserializes the record from a byte array.
int	getColor1()
int	getColor2()
int	getColor3()
int	getColor4()
short	getRecordId() Return the current record id.
String	getRecordName() The short name for this record
int	getRecordSize() Returns the number of bytes that are required to serialize this record.
int	serialize(int offset, byte[] data, EscherSerializationListener listener) This method serializes this escher record into a byte array.
void	setColor1(int field_1_color1)
void	setColor2(int field_2_color2)
void	setColor3(int field_3_color3)
void	setColor4(int field_4_color4)
String	toString()

Methods inherited from class loci.poi.ddf.EscherRecord

clone, display, fillFields, getChild, getChildRecords, getInstance, getOptions, isContainerRecord, readHeader, serialize, serialize, setChildRecords, setOptions, setRecordId

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RECORD_ID

public static final short RECORD_ID

See Also:

Constant Field Values

RECORD_DESCRIPTION

public static final String RECORD_DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

EscherSplitMenuColorsRecord

public EscherSplitMenuColorsRecord()

Method Detail

fillFields

public int fillFields(byte[] data,
                      int offset,
                      EscherRecordFactory recordFactory)

This method deserializes the record from a byte array.

Specified by:

fillFields in class EscherRecord

Parameters:

data - The byte array containing the escher record information

offset - The starting offset into data.

recordFactory - May be null since this is not a container record.

Returns:

The number of bytes read from the byte array.

serialize

public int serialize(int offset,
                     byte[] data,
                     EscherSerializationListener listener)

This method serializes this escher record into a byte array.

Specified by:

serialize in class EscherRecord

Parameters:

offset - The offset into data to start writing the record data to.

data - The byte array to serialize to.

listener - A listener to retrieve start and end callbacks. Use a NullEscherSerailizationListener to ignore these events.

Returns:

The number of bytes written.

See Also:

NullEscherSerializationListener

getRecordSize

public int getRecordSize()

Returns the number of bytes that are required to serialize this record.

Specified by:

getRecordSize in class EscherRecord

Returns:

Number of bytes

getRecordId

public short getRecordId()

Description copied from class: EscherRecord

Return the current record id.

Overrides:

getRecordId in class EscherRecord

Returns:

the 16 bit identifer for this record.

getRecordName

public String getRecordName()

The short name for this record

Specified by:

getRecordName in class EscherRecord

toString

public String toString()

Overrides:

toString in class Object

Returns:

a string representation of this record.

getColor1

public int getColor1()

setColor1

public void setColor1(int field_1_color1)

getColor2

public int getColor2()

setColor2

public void setColor2(int field_2_color2)

getColor3

public int getColor3()

setColor3

public void setColor3(int field_3_color3)

getColor4

public int getColor4()

setColor4

public void setColor4(int field_4_color4)