Package org.apache.poi.hssf.record

Class ThemeRecord

java.lang.Object

org.apache.poi.hssf.record.RecordBase

org.apache.poi.hssf.record.Record

org.apache.poi.hssf.record.cont.ContinuableRecord

org.apache.poi.hssf.record.ThemeRecord

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class ThemeRecord
extends ContinuableRecord

The theme used in this workbook. see [MS-XLS].pdf 2.4.326 Theme page 573

Since:

3.9.5

Author:

henrichen@zkoss.org

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_THEME
static short	sid

Constructor Summary

Constructors

Constructor	Description
ThemeRecord()
ThemeRecord(RecordInputStream in)	construct a HeaderFooterRecord record.

Method Summary

Modifier and Type	Method	Description
Object	clone()
ThemeRecord	copy()
Map<String,Supplier<?>>	getGenericProperties()
HSSFRecordTypes	getGenericRecordType()
short	getSid()	return the non static version of the id for this record.
byte[]	getThemeData()
int	getVersion()	If this header belongs to a specific sheet view , the sheet view?s GUID will be saved here.
protected void	serialize(ContinuableRecordOutput out)	Serializes this record's content to the supplied data output.
void	setVersion(int version)	Set to 0 if use custom theme; or DEFAULT_THEME.

Methods inherited from class org.apache.poi.hssf.record.cont.ContinuableRecord

getRecordSize, serialize

Methods inherited from class org.apache.poi.hssf.record.Record

cloneViaReserialise, serialize, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren

Field Detail

DEFAULT_THEME

public static final int DEFAULT_THEME

See Also:

Constant Field Values

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

ThemeRecord

public ThemeRecord()

ThemeRecord

public ThemeRecord(RecordInputStream in)

construct a HeaderFooterRecord record. No fields are interpreted and the record will be serialized in its original form more or less

Parameters:

in - the RecordInputstream to read the record from

Method Detail

getSid

public short getSid()

Description copied from class: Record

return the non static version of the id for this record.

Specified by:

getSid in class Record

Returns:

he id for this record

copy

public ThemeRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class Record

Returns:

a deep copy of the implementing class / instance

getGenericRecordType

public HSSFRecordTypes getGenericRecordType()

Specified by:

getGenericRecordType in interface GenericRecord

Specified by:

getGenericRecordType in class Record

getVersion

public int getVersion()

If this header belongs to a specific sheet view , the sheet view?s GUID will be saved here.

If it is zero, it means the current sheet. Otherwise, this field MUST match the guid field of the preceding UserSViewBegin record.

Returns:

the sheet view?s GUID

setVersion

public void setVersion(int version)

Set to 0 if use custom theme; or DEFAULT_THEME.

Parameters:

version -

getThemeData

public byte[] getThemeData()

clone

public Object clone()

Overrides:

clone in class Object

serialize

protected void serialize(ContinuableRecordOutput out)

Description copied from class: ContinuableRecord

Serializes this record's content to the supplied data output.

The standard BIFF header (ushort sid, ushort size) has been handled by the superclass, so only BIFF data should be written by this method. Simple data types can be written with the standard LittleEndianOutput methods. Methods from ContinuableRecordOutput can be used to serialize strings (with ContinueRecords being written as required). If necessary, implementors can explicitly start ContinueRecords (regardless of the amount of remaining space).

Specified by:

serialize in class ContinuableRecord

Parameters:

out - a data output stream

getGenericProperties

public Map<String,Supplier<?>> getGenericProperties()