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

Class AxisLineFormatRecord

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

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class AxisLineFormatRecord
extends StandardRecord

The axis line format record defines the axis type details.

Field Summary

Fields

Modifier and Type	Field	Description
static short	AXIS_TYPE_AXIS_LINE
static short	AXIS_TYPE_MAJOR_GRID_LINE
static short	AXIS_TYPE_MINOR_GRID_LINE
static short	AXIS_TYPE_WALLS_OR_FLOOR
static short	sid

Constructor Summary

Constructors

Constructor	Description
AxisLineFormatRecord()
AxisLineFormatRecord(AxisLineFormatRecord other)
AxisLineFormatRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method	Description
AxisLineFormatRecord	copy()
short	getAxisType()	Get the axis type field for the AxisLineFormat record.
protected int	getDataSize()
Map<String,Supplier<?>>	getGenericProperties()
HSSFRecordTypes	getGenericRecordType()
short	getSid()	return the non static version of the id for this record.
void	serialize(LittleEndianOutput out)	Write the data content of this BIFF record.
void	setAxisType(short field_1_axisType)	Set the axis type field for the AxisLineFormat record.

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

clone, 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

AXIS_TYPE_AXIS_LINE

public static final short AXIS_TYPE_AXIS_LINE

See Also:

Constant Field Values

AXIS_TYPE_MAJOR_GRID_LINE

public static final short AXIS_TYPE_MAJOR_GRID_LINE

See Also:

Constant Field Values

AXIS_TYPE_MINOR_GRID_LINE

public static final short AXIS_TYPE_MINOR_GRID_LINE

See Also:

Constant Field Values

AXIS_TYPE_WALLS_OR_FLOOR

public static final short AXIS_TYPE_WALLS_OR_FLOOR

See Also:

Constant Field Values

Constructor Detail

AxisLineFormatRecord

public AxisLineFormatRecord()

AxisLineFormatRecord

public AxisLineFormatRecord(AxisLineFormatRecord other)

AxisLineFormatRecord

public AxisLineFormatRecord(RecordInputStream in)

Method Detail

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

getAxisType

public short getAxisType()

Get the axis type field for the AxisLineFormat record.

Returns:

One of AXIS_TYPE_AXIS_LINE AXIS_TYPE_MAJOR_GRID_LINE AXIS_TYPE_MINOR_GRID_LINE AXIS_TYPE_WALLS_OR_FLOOR

setAxisType

public void setAxisType(short field_1_axisType)

Set the axis type field for the AxisLineFormat record.

Parameters:

field_1_axisType - One of AXIS_TYPE_AXIS_LINE AXIS_TYPE_MAJOR_GRID_LINE AXIS_TYPE_MINOR_GRID_LINE AXIS_TYPE_WALLS_OR_FLOOR

copy

public AxisLineFormatRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class StandardRecord

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

getGenericProperties

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