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

public final Class OldSheetRecord

extends Object
implements GenericRecord
Class Inheritance
All Implemented Interfaces
org.apache.poi.common.usermodel.GenericRecord
Imports
java.io.IOException, java.util.Map, java.util.function.Supplier, org.apache.poi.common.usermodel.GenericRecord, org.apache.poi.hssf.usermodel.HSSFWorkbook, org.apache.poi.util.GenericRecordJsonWriter, .GenericRecordUtil, .IOUtils, .RecordFormatException
Title: Bound Sheet Record (aka BundleSheet) (0x0085) for BIFF 5

Description: Defines a sheet within a workbook. Basically stores the sheet name and tells where the Beginning of file record is within the HSSF file.

Field Summary

Modifier and TypeField and Description
private CodepageRecord
codepage

private final int
field_1_position_of_BOF

private final int
field_2_visibility

private final int
field_3_type

private final byte[]
field_5_sheetname

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
OldSheetRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
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.

public int

Returns:

offset in bytes
getPositionOfBof()

get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file

public String

Returns:

sheetname the name of the sheet
getSheetname()

get the sheetname for this sheet.

public short
getSid()

public void
setCodePage(CodepageRecord codepage)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

codepageback to summary
private CodepageRecord codepage
field_1_position_of_BOFback to summary
private final int field_1_position_of_BOF
field_2_visibilityback to summary
private final int field_2_visibility
field_3_typeback to summary
private final int field_3_type
field_5_sheetnameback to summary
private final byte[] field_5_sheetname
sidback to summary
public static final short sid

Constructor Detail

OldSheetRecordback to summary
public OldSheetRecord(RecordInputStream in)

Method Detail

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.

Annotations
@Override
getPositionOfBofback to summary
public int getPositionOfBof()

get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file

Returns:int

offset in bytes

getSheetnameback to summary
public String getSheetname()

get the sheetname for this sheet. (this appears in the tabs at the bottom)

Returns:String

sheetname the name of the sheet

getSidback to summary
public short getSid()
setCodePageback to summary
public void setCodePage(CodepageRecord codepage)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object