org.apache.poi.ddf

Class EscherSplitMenuColorsRecord

java.lang.Object

org.apache.poi.ddf.EscherRecord

org.apache.poi.ddf.EscherSplitMenuColorsRecord

All Implemented Interfaces:

Duplicatable, GenericRecord

public class EscherSplitMenuColorsRecord
extends EscherRecord

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

Field Summary

Fields

Modifier and Type	Field and Description
static short	RECORD_ID

Constructor Summary

Constructors

Constructor and Description
EscherSplitMenuColorsRecord()
EscherSplitMenuColorsRecord(EscherSplitMenuColorsRecord other)

Method Summary

Modifier and Type	Method and Description
EscherSplitMenuColorsRecord	copy()
int	fillFields(byte[] data, int offset, EscherRecordFactory recordFactory) The contract of this method is to deserialize an escher record including it's children.
int	getColor1() Gets the fill color
int	getColor2() Gets the line color
int	getColor3() Gets the shadow color
int	getColor4() Gets the 3-D color
java.util.Map<java.lang.String,java.util.function.Supplier<?>>	getGenericProperties()
java.lang.Enum	getGenericRecordType()
short	getRecordId() Return the current record id.
java.lang.String	getRecordName() Subclasses should return the short name for this escher record.
int	getRecordSize() Subclasses should effeciently return the number of bytes required to serialize the record.
int	serialize(int offset, byte[] data, EscherSerializationListener listener) Serializes the record to an existing byte array.
void	setColor1(int field_1_color1) Sets the fill color
void	setColor2(int field_2_color2) Sets the line color
void	setColor3(int field_3_color3) Sets the shadow color
void	setColor4(int field_4_color4) Sets the 3-D color

Methods inherited from class org.apache.poi.ddf.EscherRecord

display, fillFields, getChild, getChildRecords, getGenericChildren, getInstance, getOptions, getVersion, isContainerRecord, readHeader, readInstance, serialize, serialize, setChildRecords, setInstance, setOptions, setRecordId, setVersion, toString, toXml, toXml

Methods inherited from class java.lang.Object

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

Field Detail

RECORD_ID

public static final short RECORD_ID

Constructor Detail

EscherSplitMenuColorsRecord

public EscherSplitMenuColorsRecord()

EscherSplitMenuColorsRecord

public EscherSplitMenuColorsRecord(EscherSplitMenuColorsRecord other)

Method Detail

fillFields

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

Description copied from class: EscherRecord

The contract of this method is to deserialize an escher record including it's children.

Specified by:

fillFields in class EscherRecord

Parameters:

data - The byte array containing the serialized escher records.

offset - The offset into the byte array.

recordFactory - A factory for creating new escher records.

Returns:

The number of bytes written.

serialize

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

Description copied from class: EscherRecord

Serializes the record to an existing byte array.

Specified by:

serialize in class EscherRecord

Parameters:

offset - the offset within the byte array

data - the data array to serialize to

listener - a listener for begin and end serialization events. This is useful because the serialization is hierarchical/recursive and sometimes you need to be able break into that.

Returns:

the number of bytes written.

getRecordSize

public int getRecordSize()

Description copied from class: EscherRecord

Subclasses should effeciently return the number of bytes required to serialize the 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 record id.

getRecordName

public java.lang.String getRecordName()

Description copied from class: EscherRecord

Subclasses should return the short name for this escher record.

Specified by:

getRecordName in class EscherRecord

Returns:

the short name for this escher record

getColor1

public int getColor1()

Gets the fill color

Returns:

the fill color

setColor1

public void setColor1(int field_1_color1)

Sets the fill color

Parameters:

field_1_color1 - the fill color

getColor2

public int getColor2()

Gets the line color

Returns:

the line color

setColor2

public void setColor2(int field_2_color2)

Sets the line color

Parameters:

field_2_color2 - the line color

getColor3

public int getColor3()

Gets the shadow color

Returns:

the shadow color

setColor3

public void setColor3(int field_3_color3)

Sets the shadow color

Parameters:

field_3_color3 - the shadow color

getColor4

public int getColor4()

Gets the 3-D color

Returns:

the 3-D color

setColor4

public void setColor4(int field_4_color4)

Sets the 3-D color

Parameters:

field_4_color4 - the 3-D color

getGenericProperties

public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()

Specified by:

getGenericProperties in interface GenericRecord

Overrides:

getGenericProperties in class EscherRecord

getGenericRecordType

public java.lang.Enum getGenericRecordType()

copy

public EscherSplitMenuColorsRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class EscherRecord

Returns:

a deep copy of the implementing class / instance