Package org.apache.poi.hssf.record

Record package contains class representations for XLS binary strutures.

See:
          Description

Interface Summary
CellValueRecordInterface The cell value record interface is implemented by all classes of type Record that contain cell values.
CustomField  
Margin The margin interface is a parent used to define left, right, top and bottom margins.
 

Class Summary
AreaFormatRecord The area format record is used to define the colours and patterns for an area.
AreaRecord The area record is used to define a area chart.
AxisLineFormatRecord The axis line format record defines the axis type details.
AxisOptionsRecord The axis options record provides unit information and other various tidbits about the axis.
AxisParentRecord The axis size and location NOTE: This source is automatically generated please do not modify this file.
AxisRecord The axis record defines the type of an axis.
AxisUsedRecord The number of axes used on a chart.
BackupRecord Title: Backup Record Description: Boolean specifying whether the GUI should store a backup of the file.
BarRecord The bar record is used to define a bar chart.
BeginRecord The begin record defines the start of a block of records for a (grpahing data object.
BlankRecord Title: Blank cell record Description: Represents a column in a row with no value but with styling.
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.
BookBoolRecord Title: Save External Links record (BookBool) Description: Contains a flag specifying whether the Gui should save externally linked values from other workbooks.
BoolErrRecord Creates new BoolErrRecord.
BottomMarginRecord Record for the bottom margin.
BoundSheetRecord Title: Bound Sheet Record (aka BundleSheet) Description: Defines a sheet within a workbook.
CalcCountRecord Title: Calc Count Record Description: Specifies the maximum times the gui should perform a formula recalculation.
CalcModeRecord Title: Calc Mode Record Description: Tells the gui whether to calculate formulas automatically, manually or automatically except for tables.
CategorySeriesAxisRecord This record refers to a category or series axis and is used to specify label/tickmark frequency.
ChartFormatRecord Class ChartFormatRecord
ChartRecord The chart record is used to define the location and size of a chart.
CodepageRecord Title: Codepage Record Description: the default characterset. for the workbook REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
ColumnInfoRecord Title: ColumnInfo Record Description: Defines with width and formatting for a range of columns REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
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
CountryRecord Title: Country Record (aka WIN.INI country) Description: used for localization.
DataFormatRecord The data format record is used to index into a series.
DateWindow1904Record Title: Date Window 1904 Flag record Description: Flag specifying whether 1904 date windowing is used.
DatRecord The dat record is used to store options for the chart.
DBCellRecord Title: DBCell Record (Currently read only.
DefaultColWidthRecord Title: Default Column Width Record Description: Specifies the default width for columns that have no specific width set.
DefaultDataLabelTextPropertiesRecord The default data label text properties record identifies the text characteristics of the preceeding text record.
DefaultRowHeightRecord Title: Default Row Height Record Description: Row height for rows with undefined or not explicitly defined heights.
DeltaRecord Title: Delta Record Description: controls the accuracy of the calculations REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
DimensionsRecord Title: Dimensions Record Description: provides the minumum and maximum bounds of a sheet.
DSFRecord Title: Double Stream Flag Record Description: tells if this is a double stream file.
EndRecord The end record defines the end of a block of records for a (Graphing) data object.
EOFRecord End Of File record.
ExtendedFormatRecord Title: Extended Format Record Description: Probably one of the more complex records.
ExternSheetRecord Title: Extern Sheet Description: A List of Inndexes to SupBook REFERENCE:
ExternSheetSubRecord Title: A sub Record for Extern Sheet Description: Defines a named range within a workbook.
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!
ExtSSTRecord Title: Extended Static String Table Description: I really don't understand this thing... its supposed to be "a hash table for optimizing external copy operations" -- This sounds like a job for Marc "BitMaster" Johnson aka the "Hawaiian Master Chef".
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) REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
FontBasisRecord The font basis record stores various font metrics.
FontIndexRecord The font index record indexes into the font table for the text record.
FontRecord Title: Font Record - descrbes a font in the workbook (index = 0-3,5-infinity - skip 4) Description: An element in the Font Table REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
FooterRecord Title: Footer Record Description: Specifies the footer for a sheet REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
FormatRecord Title: Format Record Description: describes a number format -- those goofy strings like $(#,###) REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
FormulaRecord Formula Record.
FrameRecord The frame record indicates whether there is a border around the displayed text of a chart.
GridsetRecord Title: Gridset Record.
GutsRecord Title: Guts Record Description: Row/column gutter sizes REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
HCenterRecord Title: HCenter record Description: whether to center between horizontal margins REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
HeaderRecord Title: Header Record Description: Specifies a header for a sheet REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
HideObjRecord Title: Hide Object Record Description: flag defines whether to hide placeholders and object REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
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 REFERENCE: PG 323 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
InterfaceEndRecord Title: Interface End Record Description: Shows where the Interface Records end (MMS) (has no fields) REFERENCE: PG 324 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
InterfaceHdrRecord Title: Interface Header Record Description: Defines the beginning of Interface records (MMS) REFERENCE: PG 324 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
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!)
LabelRecord Label Record - read only support for strings stored directly in the cell..
LabelSSTRecord Title: Label SST Record Description: Refers to a string in the shared string table and is a column value.
LeftMarginRecord Record for the left margin.
LegendRecord Defines a legend for a chart.
LineFormatRecord Describes a line format record.
LinkedDataFormulaField Not implemented yet.
LinkedDataRecord Describes a linked data record.
MergeCellsRecord Title: Merged Cells Record Description: Optional record defining a square area of cells to "merged" into one cell.
MMSRecord Title: MMS Record Description: defines how many add menu and del menu options are stored in the file.
MulBlankRecord Title: Mulitple Blank cell record Description: Represents a set of columns in a row with no value but with styling.
MulRKRecord Used to store multiple RK numbers on a row. 1 MulRk = Multiple Cell values.
NameRecord Title: Name Record (aka Named Range) Description: Defines a named range within a workbook.
NumberFormatIndexRecord The number format index record indexes format table.
NumberRecord Contains a numeric cell value.
ObjectLinkRecord Links text to an object on the chart or identifies it as the title.
PaletteRecord PaletteRecord - Supports custom palettes.
PaneRecord Describes the frozen and unfozen panes.
PasswordRecord Title: Password Record Description: stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption) REFERENCE: PG 371 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
PasswordRev4Record Title: Protection Revision 4 password Record Description: Stores the (2 byte??!!)
PlotAreaRecord preceeds and identifies a frame as belonging to the plot area.
PlotGrowthRecord The plot growth record specifies the scaling factors used when a font is scaled.
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!)
PrintGridlinesRecord Title: Print Gridlines Record Description: whether to print the gridlines when you enjoy you spreadsheet on paper.
PrintHeadersRecord Title: Print Headers Record Description: Whether or not to print the row/column headers when you enjoy your spreadsheet in the physical form.
PrintSetupRecord Title: Print Setup Record Description: Stores print setup options -- bogus for HSSF (and marked as such) REFERENCE: PG 385 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
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 ) REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
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??)
RecalcIdRecord Title: Recalc Id Record Description: This record contains an ID that marks when a worksheet was last recalculated.
Record Title: Record Description: All HSSF Records inherit from this class.
RecordFactory Deprecated. use EventRecordFactory instead
RefModeRecord Title: RefMode Record Description: Describes which reference mode to use REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
RefreshAllRecord Title: Refresh All Record Description: Flag whether to refresh all external data when loading a sheet.
RightMarginRecord Record for the right margin.
RKRecord Title: RK Record Description: An internal 32 bit number with the two most significant bits storing the type.
RowRecord Title: Row Record Description: stores the row information for the sheet.
SaveRecalcRecord Title: Save Recalc Record Description: defines whether to recalculate before saving (set to true) REFERENCE: PG 381 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
SCLRecord Specifies the window's zoom magnification.
SelectionRecord Title: Selection Record Description: shows the user's selection on the sheet for write set num refs to 0 TODO : Fully implement reference subrecords.
SeriesChartGroupIndexRecord The series chart group index record stores the index to the CHARTFORMAT record (0 based).
SeriesIndexRecord links a series to its position in the series list.
SeriesLabelsRecord The series label record defines the type of label associated with the data format record.
SeriesListRecord The series list record defines the series displayed as an overlay to the main chart record.
SeriesRecord The series record describes the overall data for a series.
SeriesTextRecord Defines a series name NOTE: This source is automatically generated please do not modify this file.
SeriesToChartGroupRecord Indicates the chart-group index for a series.
SheetPropertiesRecord Describes a chart sheet properties record.
SSTRecord Title: Static String Table Record Description: This holds all the strings for LabelSSTRecords.
StringRecord Supports the STRING record structure.
StyleRecord Title: Style Record Description: Describes a builtin to the gui or user defined style REFERENCE: PG 390 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
SupBookRecord Title: Sup Book Description: A Extrenal Workbook Deciption (Sup Book) Its only a dummy record for making new ExternSheet Record REFERENCE:
TabIdRecord Title: Sheet Tab Index Array Record Description: Contains an array of sheet id's.
TextRecord The text record is used to define text stored on a chart.
TickRecord The Tick record defines how tick marks and label positioning/formatting NOTE: This source is automatically generated please do not modify this file.
TopMarginRecord Record for the top margin.
UnicodeString Title: Unicode String * Description: Unicode String record.
UnitsRecord The units record describes units.
UnknownRecord Title: Unknown Record (for debugging) Description: Unknown record just tells you the sid so you can figure out what records you are missing.
UseSelFSRecord Title: Use Natural Language Formulas Flag Description: Tells the GUI if this was written by something that can use "natural language" formulas.
ValueRangeRecord The value range record defines the range of the value axis.
VCenterRecord Title: VCenter record Description: tells whether to center the sheet between vertical margins REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
WindowOneRecord Title: Window1 Record Description: Stores the attributes of the workbook window.
WindowProtectRecord Title: Window Protect Record Description: flags whether workbook windows are protected REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
WindowTwoRecord Title: Window Two Record Description: sheet window settings REFERENCE: PG 422 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
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) REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
WSBoolRecord Title: WSBool Record.
 

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

Package org.apache.poi.hssf.record Description

Record package contains class representations for XLS binary strutures. Its very low level.

Related Documentation

For overviews, tutorials, examples, guides, and tool documentation, please see:

See Also:
org.apache.poi.hssf.eventmodel, RecordFactory

jakarta-poi 1.10.0-dev

Copyright © 2004 Apache jakarta-poi project. All Rights Reserved.