Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class PaneRecord

extends StandardRecord
Class Inheritance
Static Imports
org.apache.poi.util.GenericRecordUtil.getEnumBitsAsString
Describes the frozen and unfrozen panes.

Field Summary

Modifier and TypeField and Description
public static final short
ACTIVE_PANE_LOWER_LEFT

public static final short
ACTIVE_PANE_LOWER_RIGHT

public static final short
ACTIVE_PANE_UPPER_LEFT

public static final short
ACTIVE_PANE_UPPER_RIGHT

private short
field_1_x

private short
field_2_y

private short
field_3_topRow

private short
field_4_leftColumn

private short
field_5_activePane

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
PaneRecord()

public
PaneRecord(PaneRecord other)

public
PaneRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public PaneRecord
copy()

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

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

public short

Returns:

One of ACTIVE_PANE_LOWER_RIGHT ACTIVE_PANE_UPPER_RIGHT ACTIVE_PANE_LOWER_LEFT ACTIVE_PANE_UPPER_LEFT
getActivePane()

Get the active pane field for the Pane record.

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:

the left column
getLeftColumn()

Get the left column field for the Pane record.

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:

the top row
getTopRow()

Get the top row field for the Pane record.

public short

Returns:

the x value
getX()

Get the x field for the Pane record.

public short

Returns:

the y value
getY()

Get the y field for the Pane record.

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
setActivePane(short
One of ACTIVE_PANE_LOWER_RIGHT ACTIVE_PANE_UPPER_RIGHT ACTIVE_PANE_LOWER_LEFT ACTIVE_PANE_UPPER_LEFT
field_5_activePane)

Set the active pane field for the Pane record.

public void
setLeftColumn(short
the left column
field_4_leftColumn)

Set the left column field for the Pane record.

public void
setTopRow(short
the top row
field_3_topRow)

Set the top row field for the Pane record.

public void
setX(short
the x value
field_1_x)

Set the x field for the Pane record.

public void
setY(short
the y value
field_2_y)

Set the y field for the Pane record.

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

ACTIVE_PANE_LOWER_LEFTback to summary
public static final short ACTIVE_PANE_LOWER_LEFT
ACTIVE_PANE_LOWER_RIGHTback to summary
public static final short ACTIVE_PANE_LOWER_RIGHT
ACTIVE_PANE_UPPER_LEFTback to summary
public static final short ACTIVE_PANE_UPPER_LEFT
ACTIVE_PANE_UPPER_RIGHTback to summary
public static final short ACTIVE_PANE_UPPER_RIGHT
field_1_xback to summary
private short field_1_x
field_2_yback to summary
private short field_2_y
field_3_topRowback to summary
private short field_3_topRow
field_4_leftColumnback to summary
private short field_4_leftColumn
field_5_activePaneback to summary
private short field_5_activePane
sidback to summary
public static final short sid

Constructor Detail

PaneRecordback to summary
public PaneRecord()
PaneRecordback to summary
public PaneRecord(PaneRecord other)
PaneRecordback to summary
public PaneRecord(RecordInputStream in)

Method Detail

copyback to summary
public PaneRecord copy()

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

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

Returns:PaneRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getActivePaneback to summary
public short getActivePane()

Get the active pane field for the Pane record.

Returns:short

One of ACTIVE_PANE_LOWER_RIGHT ACTIVE_PANE_UPPER_RIGHT ACTIVE_PANE_LOWER_LEFT ACTIVE_PANE_UPPER_LEFT

getDataSizeback to summary
protected int getDataSize()

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

Annotations
@Override
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

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

Annotations
@Override
getGenericRecordTypeback 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
getLeftColumnback to summary
public short getLeftColumn()

Get the left column field for the Pane record.

Returns:short

the left column

getSidback 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

Annotations
@Override
getTopRowback to summary
public short getTopRow()

Get the top row field for the Pane record.

Returns:short

the top row

getXback to summary
public short getX()

Get the x field for the Pane record.

Returns:short

the x value

getYback to summary
public short getY()

Get the y field for the Pane record.

Returns:short

the y value

serializeback 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

Annotations
@Override
setActivePaneback to summary
public void setActivePane(short field_5_activePane)

Set the active pane field for the Pane record.

Parameters
field_5_activePane:short

One of ACTIVE_PANE_LOWER_RIGHT ACTIVE_PANE_UPPER_RIGHT ACTIVE_PANE_LOWER_LEFT ACTIVE_PANE_UPPER_LEFT

setLeftColumnback to summary
public void setLeftColumn(short field_4_leftColumn)

Set the left column field for the Pane record.

Parameters
field_4_leftColumn:short

the left column

setTopRowback to summary
public void setTopRow(short field_3_topRow)

Set the top row field for the Pane record.

Parameters
field_3_topRow:short

the top row

setXback to summary
public void setX(short field_1_x)

Set the x field for the Pane record.

Parameters
field_1_x:short

the x value

setYback to summary
public void setY(short field_2_y)

Set the y field for the Pane record.

Parameters
field_2_y:short

the y value