Top Description Fields Constructors Methods
org.apache.poi.ddf

public Class EscherOptRecord

extends AbstractEscherOptRecord
Class Inheritance
Imports
org.apache.poi.util.Internal
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

Modifier and TypeField and Description
public static final String
RECORD_DESCRIPTION

public static final short
RECORD_ID

Constructor Summary

AccessConstructor and Description
public
EscherOptRecord()

public
EscherOptRecord(EscherOptRecord other)

Method Summary

Modifier and TypeMethod and Description
public EscherOptRecord
copy()

Implements abstract org.apache.poi.ddf.EscherRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

public Enum<E extends Enum<E>>
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

public short
getInstance()

Overrides org.apache.poi.ddf.EscherRecord.getInstance.

Returns the instance part of the option record.

public short
getOptions()

Overrides org.apache.poi.ddf.EscherRecord.getOptions.

Automatically recalculate the correct option

public String
getRecordName()

Implements abstract org.apache.poi.ddf.EscherRecord.getRecordName.

Subclasses should return the short name for this escher record.

public short
getVersion()

Overrides org.apache.poi.ddf.EscherRecord.getVersion.

Returns the version part of the option record.

public void
setVersion(short
version part value
value)

Overrides org.apache.poi.ddf.EscherRecord.setVersion.

Sets the version part of record

Inherited from org.apache.poi.ddf.AbstractEscherOptRecord:
addEscherPropertyfillFieldsgetEscherPropertiesgetEscherPropertygetGenericPropertiesgetRecordSizelookuplookupremoveEscherPropertyserializesetEscherPropertysortProperties

Field Detail

RECORD_DESCRIPTIONback to summary
public static final String RECORD_DESCRIPTION
RECORD_IDback to summary
public static final short RECORD_ID

Constructor Detail

EscherOptRecordback to summary
public EscherOptRecord()
EscherOptRecordback to summary
public EscherOptRecord(EscherOptRecord other)

Method Detail

copyback to summary
public EscherOptRecord copy()

Implements abstract org.apache.poi.ddf.EscherRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:EscherOptRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getGenericRecordTypeback to summary
public Enum<E extends Enum<E>> getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Annotations
@Override
getInstanceback to summary
public short getInstance()

Overrides org.apache.poi.ddf.EscherRecord.getInstance.

Doc from org.apache.poi.ddf.EscherRecord.getInstance.

Returns the instance part of the option record.

Returns:short

The instance part of the record

Annotations
@Override
getOptionsback to summary
public short getOptions()

Overrides org.apache.poi.ddf.EscherRecord.getOptions.

Automatically recalculate the correct option

Returns:short

Doc from org.apache.poi.ddf.EscherRecord.getOptions.

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

Annotations
@Override
@Internal
getRecordNameback to summary
public String getRecordName()

Implements abstract org.apache.poi.ddf.EscherRecord.getRecordName.

Doc from org.apache.poi.ddf.EscherRecord.getRecordName.

Subclasses should return the short name for this escher record.

Returns:String

the short name for this escher record

Annotations
@Override
getVersionback to summary
public short getVersion()

Overrides org.apache.poi.ddf.EscherRecord.getVersion.

Doc from org.apache.poi.ddf.EscherRecord.getVersion.

Returns the version part of the option record.

Returns:short

The version part of the option record

Annotations
@Override
setVersionback to summary
public void setVersion(short value)

Overrides org.apache.poi.ddf.EscherRecord.setVersion.

Doc from org.apache.poi.ddf.EscherRecord.setVersion.

Sets the version part of record

Parameters
value:short

version part value

Annotations
@Override