Home » openjdk-7 » net.sourceforge.poi » hssf » record »

net.sourceforge.poi.hssf.record

Sub Packages:

net.sourceforge.poi.hssf.record.aggregates    
net.sourceforge.poi.hssf.record.formula    

Interfaces:

CellValueRecordInterface   The cell value record interface is implemented by all classes of type Record that contain cell values.  code | html

Abstract Classes:

Record   Title: Record Description: All HSSF Records inherit from this class.  code | html

Classes:

BOFRecord   Title: Beginning Of File

Description: Somewhat of a misnomer, its used for the beginning of a set of records that have a particular pupose or subject. 

code | html
BackupRecord   Title: Backup Record

Description: Boolean specifying whether the GUI should store a backup of the file.

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
BlankRecord   Title: Blank cell record

Description: Represents a column in a row with no value but with styling.

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
BookBoolRecord   Title: Save External Links record (BookBool)

Description: Contains a flag specifying whether the Gui should save externally linked values from other workbooks. 

code | html
BoundSheetRecord   Title: Bound Sheet Record (aka BundleSheet)

Description: Defines a sheet within a workbook. 

code | html
CalcCountRecord   Title: Calc Count Record Description: Specifies the maximum times the gui should perform a formula recalculation.  code | html
CalcModeRecord   Title: Calc Mode Record

Description: Tells the gui whether to calculate formulas automatically, manually or automatically except for tables.

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
CodepageRecord   Title: Codepage Record

Description: the default characterset. 

code | html
ColumnInfoRecord   Title: ColumnInfo Record

Description: Defines with width and formatting for a range of columns

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
ContinueRecord   Title: Continue Record - Helper class used primarily for SST Records

Description: handles overflow for prior record in the input stream; content is tailored to that prior record

 

code | html
CountryRecord   Title: Country Record (aka WIN.INI country)

Description: used for localization. 

code | html
DBCellRecord   Title: DBCell Record (Currently read only.  code | html
DSFRecord   Title: Double Stream Flag Record

Description: tells if this is a double stream file. 

code | html
DateWindow1904Record   Title: Date Window 1904 Flag record

Description: Flag specifying whether 1904 date windowing is used. 

code | html
DefaultColWidthRecord   Title: Default Column Width Record

Description: Specifies the default width for columns that have no specific width set.

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
DefaultRowHeightRecord   Title: Default Row Height Record Description: Row height for rows with undefined or not explicitly defined heights.  code | html
DeltaRecord   Title: Delta Record

Description: controls the accuracy of the calculations

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
DimensionsRecord   Title: Dimensions Record

Description: provides the minumum and maximum bounds of a sheet.

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
EOFRecord   Title: End Of File record

Description: Marks the end of records belonging to a particular object in the HSSF File

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
ExtSSTInfoSubRecord   Extended SST table info subrecord

contains the elements of "info" in the SST's array field

WE HAVE VERY LITTLE INFORMATION ON HOW TO IMPLEMENT THIS RECORD! (EXTSSST)

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
ExtSSTRecord   Title: Extended Static String Table

Description: I really don't understand this thing... 

code | html
ExtendedFormatRecord   Title: Extended Format Record Description: Probably one of the more complex records.  code | html
FnGroupCountRecord   Title: Function Group Count Record

Description: Number of built in function groups in the current version of the Spreadsheet (probably only used on Windoze)

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
FontRecord   Title: Font Record - descrbes a font in the workbook (index = 0-3,5-infinity - skip 4)

Description: An element in the Font Table

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
FooterRecord   Title: Footer Record

Description: Specifies the footer for a sheet

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
FormatRecord   Title: Format Record

Description: describes a number format -- those goofy strings like $(#,###)

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
FormulaRecord   Formula Record - This is not really supported in this release.  code | html
GridsetRecord   Title: Gridset Record

Description: flag denoting whether the user has mucked with the gridlines.

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
GutsRecord   Title: Guts Record

Description: Row/column gutter sizes

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
HCenterRecord   Title: HCenter record

Description: whether to center between horizontal margins

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
HeaderRecord   Title: Header Record

Description: Specifies a header for a sheet

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
HideObjRecord   Title: Hide Object Record

Description: flag defines whether to hide placeholders and object

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
IndexRecord   Title: Index Record

Description: Occurs right after BOF, tells you where the DBCELL records are for a sheet Important for locating cells

NOT USED IN THIS RELEASE Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
InterfaceEndRecord   Title: Interface End Record

Description: Shows where the Interface Records end (MMS) (has no fields)

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
InterfaceHdrRecord   Title: Interface Header Record

Description: Defines the beginning of Interface records (MMS)

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
IterationRecord   Title: Iteration Record

Description: Tells whether to iterate over forumla calculations or not (if a formula is dependant upon another formula's result) (odd feature for something that can only have 32 elements in a formula!)

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
LabelRecord   Label Record - read only support for strings stored directly in the cell..  code | html
LabelSSTRecord   Title: Label SST Record

Description: Refers to a string in the shared string table and is a column value. 

code | html
MMSRecord   Title: MMS Record

Description: defines how many add menu and del menu options are stored in the file. 

code | html
MulBlankRecord   Title: Mulitple Blank cell record

Description: Represents a set of columns in a row with no value but with styling. 

code | html
MulRKRecord   Used to store multiple RK numbers on a row.  code | html
NumberRecord   Contains a numeric cell value.  code | html
PasswordRecord   Title: Password Record

Description: stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
PasswordRev4Record   Title: Protection Revision 4 password Record

Description: Stores the (2 byte??!!) encrypted password for a shared workbook

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
PrecisionRecord   Title: Precision Record

Description: defines whether to store with full precision or what's displayed by the gui (meaning have really screwed up and skewed figures or only think you do!)

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
PrintGridlinesRecord   Title: Print Gridlines Record

Description: whether to print the gridlines when you enjoy you spreadsheet on paper.

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
PrintHeadersRecord   Title: Print Headers Record

Description: Whether or not to print the row/column headers when you enjoy your spreadsheet in the physical form.

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
PrintSetupRecord   Title: Print Setup Record

Description: Stores print setup options -- bogus for HSSF (and marked as such)

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
ProtectRecord   Title: Protect Record

Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)

(kindly ask the US government to stop having arcane stupid encryption laws and we'll support it)

(after all terrorists will all use US-legal encrypton right??)

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
ProtectionRev4Record   Title: Protection Revision 4 Record

Description: describes whether this is a protected shared/tracked workbook

( HSSF does not support encryption because we don't feel like going to jail )

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
RKRecord   Title: RK Record Description: An internal 32 bit number with the two most significant bits storing the type.  code | html
RecordFactory   Title: Record Factory

Description: Takes a stream and outputs an array of Record objects.

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
RecordFormatException   Title: Record Format Exception Description: Used by records to indicate invalid format/data.

 

code | html
RefModeRecord   Title: RefMode Record

Description: Describes which reference mode to use

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
RefreshAllRecord   Title: Refresh All Record

Description: Flag whether to refresh all external data when loading a sheet. 

code | html
RkRec     code | html
RowRecord   Title: Row Record

Description: stores the row information for the sheet. 

code | html
SSTRecord   Title: Static String Table Record

Description: This holds all the strings for LabelSSTRecords. 

code | html
SaveRecalcRecord   Title: Save Recalc Record

Description: defines whether to recalculate before saving (set to true)

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
SelectionRecord   Title: Selection Record

Description: shows the user's selection on the sheet for write set num refs to 0

TODO : Implement reference subrecords Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
StyleRecord   Title: Style Record

Description: Describes a builtin to the gui or user defined style

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
TabIdRecord   Title: Sheet Tab Index Array Record

Description: Contains an array of sheet id's. 

code | html
UnicodeString   Title: Unicode String

Description: Unicode String record. 

code | html
UnknownRecord   Title: Unknown Record (for debugging)

Description: Unknown record just tells you the sid so you can figure out what records you are missing. 

code | html
UseSelFSRecord   Title: Use Natural Language Formulas Flag

Description: Tells the GUI if this was written by something that can use "natural language" formulas. 

code | html
VCenterRecord   Title: VCenter record

Description: tells whether to center the sheet between vertical margins

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
WSBoolRecord   Title: WSBool Record Description: stores workbook settings (aka its a big "everything we didn't put somewhere else")

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
WindowOneRecord   Title: Window1 Record

Description: Stores the attributes of the workbook window. 

code | html
WindowProtectRecord   Title: Window Protect Record

Description: flags whether workbook windows are protected

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
WindowTwoRecord   Title: Window Two Record

Description: sheet window settings

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html
WriteAccessRecord   Title: Write Access Record

Description: Stores the username of that who owns the spreadsheet generator (on unix the user's login, on Windoze its the name you typed when you installed the thing)

Copyright: Copyright (c) 2001 SuperLink Software, Inc. 

code | html

All Test Cases:

TestSSTRecord     code | html