Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.GutsRecord

Modifier and Type	Field and Description
private short	field_1_left_row_gutter size of the row gutter to the left of the rows
private short	field_2_top_col_gutter size of the column gutter above the columns
private short	field_3_row_level_max maximum outline level for row gutters
private short	field_4_col_level_max maximum outline level for column gutters
public static final short	sid

Access	Constructor and Description
public	GutsRecord()
public	GutsRecord(GutsRecord other)
public	GutsRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
public GutsRecord	copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy.
public short	Returns: maximum outline level getColLevelMax() get the maximum outline level for the col gutter.
protected int	getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public HSSFRecordTypes	getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.
public short	Returns: gutter size in screen units getLeftRowGutter() get the size of the gutter that appears at the left of the rows
public short	Returns: maximum outline level getRowLevelMax() get the maximum outline level for the row gutter.
public short	getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record.
public short	Returns: gutter size in screen units getTopColGutter() get the size of the gutter that appears at the above the columns
public void	serialize(LittleEndianOutput the output object out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record.
public void	setColLevelMax(short maximum outline level max) set the maximum outline level for the col gutter.
public void	setLeftRowGutter(short gutter size in screen units gut) set the size of the gutter that appears at the left of the rows
public void	setRowLevelMax(short maximum outline level max) set the maximum outline level for the row gutter.
public void	setTopColGutter(short gutter size in screen units gut) set the size of the gutter that appears at the above the columns

Inherited from org.apache.poi.hssf.record.StandardRecord:: getRecordSize serialize

field_1_left_row_gutter	back to summary
private short field_1_left_row_gutter size of the row gutter to the left of the rows

field_2_top_col_gutter	back to summary
private short field_2_top_col_gutter size of the column gutter above the columns

field_3_row_level_max	back to summary
private short field_3_row_level_max maximum outline level for row gutters

field_4_col_level_max	back to summary
private short field_4_col_level_max maximum outline level for column gutters

sid	back to summary
public static final short sid

GutsRecord	back to summary
public GutsRecord()

GutsRecord	back to summary
public GutsRecord(GutsRecord other)

GutsRecord	back to summary
public GutsRecord(RecordInputStream in)

Method Detail

copy	back to summary
public GutsRecord copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:GutsRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public GutsRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

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

Returns:GutsRecord

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

a deep copy of the implementing class / instance

Annotations

@Override

getColLevelMax	back to summary
public short getColLevelMax() get the maximum outline level for the col gutter. Returns:short maximum outline level

getColLevelMax

back to summary

public short getColLevelMax()

get the maximum outline level for the col gutter.

Returns:short: maximum outline level

getDataSize	back to summary
protected int getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

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

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getGenericRecordType	back to summary
public HSSFRecordTypes getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType. Annotations @Override

getGenericRecordType

back to summary

public HSSFRecordTypes getGenericRecordType()

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

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations

@Override

getLeftRowGutter	back to summary
public short getLeftRowGutter() get the size of the gutter that appears at the left of the rows Returns:short gutter size in screen units

getLeftRowGutter

back to summary

public short getLeftRowGutter()

get the size of the gutter that appears at the left of the rows

Returns:short: gutter size in screen units

getRowLevelMax	back to summary
public short getRowLevelMax() get the maximum outline level for the row gutter. Returns:short maximum outline level

getRowLevelMax

back to summary

public short getRowLevelMax()

get the maximum outline level for the row gutter.

Returns:short: maximum outline level

getSid	back to summary
public short getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. Doc from org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record. Returns:short he id for this record

getSid

back to summary

public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

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

Returns:short: he id for this record

getTopColGutter	back to summary
public short getTopColGutter() get the size of the gutter that appears at the above the columns Returns:short gutter size in screen units

getTopColGutter

back to summary

public short getTopColGutter()

get the size of the gutter that appears at the above the columns

Returns:short: gutter size in screen units

serialize back to summary

serialize	back to summary
public void serialize(LittleEndianOutput out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Doc from org.apache.poi.hssf.record.StandardRecord.serialize. 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 `org.apache.poi.hssf.record.Record#getRecordSize()`} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass). Parameters out:LittleEndianOutput the output object

public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

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 org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters

out:LittleEndianOutput: the output object

setColLevelMax	back to summary
public void setColLevelMax(short max) set the maximum outline level for the col gutter. Parameters max:short maximum outline level

setColLevelMax

back to summary

public void setColLevelMax(short max)

set the maximum outline level for the col gutter.

Parameters

max:short: maximum outline level

setLeftRowGutter	back to summary
public void setLeftRowGutter(short gut) set the size of the gutter that appears at the left of the rows Parameters gut:short gutter size in screen units

setLeftRowGutter

back to summary

public void setLeftRowGutter(short gut)

set the size of the gutter that appears at the left of the rows

Parameters

gut:short: gutter size in screen units

setRowLevelMax	back to summary
public void setRowLevelMax(short max) set the maximum outline level for the row gutter. Parameters max:short maximum outline level

setRowLevelMax

back to summary

public void setRowLevelMax(short max)

set the maximum outline level for the row gutter.

Parameters

max:short: maximum outline level

setTopColGutter	back to summary
public void setTopColGutter(short gut) set the size of the gutter that appears at the above the columns Parameters gut:short gutter size in screen units

setTopColGutter

back to summary

public void setTopColGutter(short gut)

set the size of the gutter that appears at the above the columns

Parameters

gut:short: gutter size in screen units

public final Class GutsRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail