Package org.apache.poi.ddf

Class EscherOptRecord

java.lang.Object

org.apache.poi.ddf.EscherRecord

org.apache.poi.ddf.AbstractEscherOptRecord

org.apache.poi.ddf.EscherOptRecord

All Implemented Interfaces:

Duplicatable, GenericRecord

public class EscherOptRecord
extends AbstractEscherOptRecord

The opt record is used to store property values for a shape. It is the key to determining the attributes of a shape. Properties can be of two types: simple or complex. Simple types are fixed length. Complex properties are variable length.

Field Summary

Fields

Modifier and Type	Field	Description
static String	RECORD_DESCRIPTION
static short	RECORD_ID

Constructor Summary

Constructors

Constructor	Description
EscherOptRecord()
EscherOptRecord(EscherOptRecord other)

Method Summary

Modifier and Type	Method	Description
EscherOptRecord	copy()
Enum	getGenericRecordType()
short	getInstance()	Returns the instance part of the option record.
short	getOptions()	Automatically recalculate the correct option
String	getRecordName()	Subclasses should return the short name for this escher record.
short	getVersion()	Returns the version part of the option record.
void	setVersion(short value)	Sets the version part of record

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

addEscherProperty, fillFields, getEscherProperties, getEscherProperty, getGenericProperties, getRecordSize, lookup, lookup, removeEscherProperty, serialize, setEscherProperty, sortProperties

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

display, fillFields, getChild, getChildRecords, getGenericChildren, getRecordId, isContainerRecord, readHeader, readInstance, serialize, serialize, setChildRecords, setInstance, setOptions, setRecordId, 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

RECORD_DESCRIPTION

public static final String RECORD_DESCRIPTION

Constructor Detail

EscherOptRecord

public EscherOptRecord()

EscherOptRecord

public EscherOptRecord(EscherOptRecord other)

Method Detail

getInstance

public short getInstance()

Description copied from class: EscherRecord

Returns the instance part of the option record.

Overrides:

getInstance in class EscherRecord

Returns:

The instance part of the record

getOptions

@Internal
public short getOptions()

Automatically recalculate the correct option

Overrides:

getOptions in class EscherRecord

Returns:

The options field for this record. All records have one.

getRecordName

public 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

getVersion

public short getVersion()

Description copied from class: EscherRecord

Returns the version part of the option record.

Overrides:

getVersion in class EscherRecord

Returns:

The version part of the option record

setVersion

public void setVersion(short value)

Description copied from class: EscherRecord

Sets the version part of record

Overrides:

setVersion in class EscherRecord

Parameters:

value - version part value

getGenericRecordType

public Enum getGenericRecordType()

copy

public EscherOptRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class EscherRecord

Returns:

a deep copy of the implementing class / instance