Package org.apache.poi.ddf
Class EscherSplitMenuColorsRecord
java.lang.Object
org.apache.poi.ddf.EscherRecord
org.apache.poi.ddf.EscherSplitMenuColorsRecord
- All Implemented Interfaces:
Cloneable
A list of the most recently used colours for the drawings contained in
this document.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
fillFields
(byte[] data, int offset, EscherRecordFactory recordFactory) The contract of this method is to deserialize an escher record including it's children.protected Object[][]
For the purpose of providing toString() and toXml() a subclass can either override those methods or provide a Object[][] array in the form{ { "Attribute Name (Header)", value, "optional attribute", value }, ... }
.int
Gets the fill colorint
Gets the line colorint
Gets the shadow colorint
Gets the 3-D colorshort
Return the current record id.Subclasses should return the short name for this escher record.int
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 colorvoid
setColor2
(int field_2_color2) Sets the line colorvoid
setColor3
(int field_3_color3) Sets the shadow colorvoid
setColor4
(int field_4_color4) Sets the 3-D colorMethods inherited from class org.apache.poi.ddf.EscherRecord
clone, display, fillFields, getChild, getChildRecords, getInstance, getOptions, getVersion, isContainerRecord, readHeader, readInstance, serialize, serialize, setChildRecords, setInstance, setOptions, setRecordId, setVersion, toString, toXml, toXml
-
Field Details
-
RECORD_ID
public static final short RECORD_ID- See Also:
-
RECORD_DESCRIPTION
- See Also:
-
-
Constructor Details
-
EscherSplitMenuColorsRecord
public EscherSplitMenuColorsRecord()
-
-
Method Details
-
fillFields
Description copied from class:EscherRecord
The contract of this method is to deserialize an escher record including it's children.- Specified by:
fillFields
in classEscherRecord
- 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
Description copied from class:EscherRecord
Serializes the record to an existing byte array.- Specified by:
serialize
in classEscherRecord
- Parameters:
offset
- the offset within the byte arraydata
- the data array to serialize tolistener
- 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 classEscherRecord
- Returns:
- number of bytes
-
getRecordId
public short getRecordId()Description copied from class:EscherRecord
Return the current record id.- Overrides:
getRecordId
in classEscherRecord
- Returns:
- The 16 bit record id.
-
getRecordName
Description copied from class:EscherRecord
Subclasses should return the short name for this escher record.- Specified by:
getRecordName
in classEscherRecord
- 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
-
getAttributeMap
Description copied from class:EscherRecord
For the purpose of providing toString() and toXml() a subclass can either override those methods or provide a Object[][] array in the form{ { "Attribute Name (Header)", value, "optional attribute", value }, ... }
.Null values won't be printed.
The attributes record, version, instance, options must not be returned.
- Specified by:
getAttributeMap
in classEscherRecord
- Returns:
- the attribute map
-