org.apache.poi.hssf.record.chart

Class FrameRecord

java.lang.Object

org.apache.poi.hssf.record.RecordBase

org.apache.poi.hssf.record.Record

org.apache.poi.hssf.record.StandardRecord

org.apache.poi.hssf.record.chart.FrameRecord

All Implemented Interfaces:

Duplicatable

public final class FrameRecord
extends StandardRecord

The frame record indicates whether there is a border around the displayed text of a chart.

Field Summary

Fields

Modifier and Type	Field and Description
static short	BORDER_TYPE_REGULAR
static short	BORDER_TYPE_SHADOW
static short	sid

Constructor Summary

Constructors

Constructor and Description
FrameRecord()
FrameRecord(FrameRecord other)
FrameRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
FrameRecord	clone() Deprecated.
FrameRecord	copy()
short	getBorderType() Get the border type field for the Frame record.
protected int	getDataSize()
short	getOptions() Get the options field for the Frame record.
short	getSid() return the non static version of the id for this record.
boolean	isAutoPosition() excel calculates the position automatically
boolean	isAutoSize() excel calculates the size automatically if true
void	serialize(LittleEndianOutput out) Write the data content of this BIFF record.
void	setAutoPosition(boolean value) Sets the auto position field value.
void	setAutoSize(boolean value) Sets the auto size field value.
void	setBorderType(short field_1_borderType) Set the border type field for the Frame record.
void	setOptions(short field_2_options) Set the options field for the Frame record.
java.lang.String	toString() get a string representation of the record (for biffview/debugging)

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

getRecordSize, serialize

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

cloneViaReserialise, serialize

Methods inherited from class java.lang.Object

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

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

BORDER_TYPE_REGULAR

public static final short BORDER_TYPE_REGULAR

See Also:

Constant Field Values

BORDER_TYPE_SHADOW

public static final short BORDER_TYPE_SHADOW

See Also:

Constant Field Values

Constructor Detail

FrameRecord

public FrameRecord()

FrameRecord

public FrameRecord(FrameRecord other)

FrameRecord

public FrameRecord(RecordInputStream in)

Method Detail

toString

public java.lang.String toString()

Description copied from class: Record

get a string representation of the record (for biffview/debugging)

Overrides:

toString in class Record

serialize

public void serialize(LittleEndianOutput out)

Description copied from class: StandardRecord

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by RecordBase.getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Specified by:

serialize in class StandardRecord

Parameters:

out - the output object

getDataSize

protected int getDataSize()

Specified by:

getDataSize in class StandardRecord

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

clone

@Deprecated
 @Removal(version="5.0.0")
public FrameRecord clone()

Deprecated.

Overrides:

clone in class java.lang.Object

copy

public FrameRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class StandardRecord

Returns:

a deep copy of the implementing class / instance

getBorderType

public short getBorderType()

Get the border type field for the Frame record.

Returns:

One of BORDER_TYPE_REGULAR BORDER_TYPE_SHADOW

setBorderType

public void setBorderType(short field_1_borderType)

Set the border type field for the Frame record.

Parameters:

field_1_borderType - One of BORDER_TYPE_REGULAR BORDER_TYPE_SHADOW

getOptions

public short getOptions()

Get the options field for the Frame record.

setOptions

public void setOptions(short field_2_options)

Set the options field for the Frame record.

setAutoSize

public void setAutoSize(boolean value)

Sets the auto size field value. excel calculates the size automatically if true

isAutoSize

public boolean isAutoSize()

excel calculates the size automatically if true

Returns:

the auto size field value.

setAutoPosition

public void setAutoPosition(boolean value)

Sets the auto position field value. excel calculates the position automatically

isAutoPosition

public boolean isAutoPosition()

excel calculates the position automatically

Returns:

the auto position field value.