Package org.apache.poi.hssf.record.chart

Class LineRecord

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.LineRecord

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class LineRecord
extends StandardRecord

The line record is used to define a line chart.

Author:

henrichen@zkoss.org

Field Summary

Fields

Modifier and Type	Field	Description
static short	sid

Constructor Summary

Constructors

Constructor	Description
LineRecord()
LineRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method	Description
Object	clone()
LineRecord	copy()
protected int	getDataSize()
short	getFormatFlags()	Get the format flags field for the Pie record.
Map<String,Supplier<?>>	getGenericProperties()
HSSFRecordTypes	getGenericRecordType()
short	getSid()	return the non static version of the id for this record.
boolean	isPercent()	whether to show data points as a percentage of the sum of all data point in a category.
boolean	isShadow()	display a shadow for the chart
boolean	isStacked()	whether stack data points in a category.
void	serialize(LittleEndianOutput out)	Write the data content of this BIFF record.
void	setFormatFlags(short field_3_formatFlags)	Set the format flags field for the Pie record.
void	setPercent(boolean value)	Sets percent field value.
void	setShadow(boolean value)	Sets the shadow field value.
void	setStacked(boolean value)	Sets the stacked field value.

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

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

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

LineRecord

public LineRecord()

LineRecord

public LineRecord(RecordInputStream in)

Method Detail

getDataSize

protected int getDataSize()

Specified by:

getDataSize in class StandardRecord

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

copy

public LineRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class StandardRecord

Returns:

a deep copy of the implementing class / instance

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

getGenericRecordType

public HSSFRecordTypes getGenericRecordType()

Specified by:

getGenericRecordType in interface GenericRecord

Specified by:

getGenericRecordType in class Record

clone

public Object clone()

Overrides:

clone in class Object

getFormatFlags

public short getFormatFlags()

Get the format flags field for the Pie record.

setFormatFlags

public void setFormatFlags(short field_3_formatFlags)

Set the format flags field for the Pie record.

setPercent

public void setPercent(boolean value)

Sets percent field value. whether to show data points as a percentage of the sum of all data point in a category.

isPercent

public boolean isPercent()

whether to show data points as a percentage of the sum of all data point in a category.

Returns:

the percent field value.

setStacked

public void setStacked(boolean value)

Sets the stacked field value. whether stack data points in a category.

isStacked

public boolean isStacked()

whether stack data points in a category.

Returns:

the stacked field value.

setShadow

public void setShadow(boolean value)

Sets the shadow field value. display a shadow for the chart

isShadow

public boolean isShadow()

display a shadow for the chart

Returns:

the shadow field value.

getGenericProperties

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