Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

## Uses of Class
org.apache.poi.hssf.record.RecordBase

Packages that use RecordBase
org.apache.poi.hssf.eventusermodel.dummyrecord |
org.apache.poi.hssf.model | Provides low level API structures for reading, writing, modifying XLS files.
org.apache.poi.hssf.record | Record package contains class representations for XLS binary strutures.
org.apache.poi.hssf.record.aggregates | record aggregates are not real "records" but collections of records that act as a single record.
org.apache.poi.hssf.record.chart |
org.apache.poi.hssf.record.cont |
org.apache.poi.hssf.record.pivottable |

Uses of RecordBase in org.apache.poi.hssf.eventusermodel.dummyrecord

Subclasses of RecordBase in org.apache.poi.hssf.eventusermodel.dummyrecord
`class` | `LastCellOfRowDummyRecord` A dummy record to indicate that we've now had the last cell record for this row.
`class` | `MissingCellDummyRecord` A dummy record for when we're missing a cell in a row, but still want to trigger something
`class` | `MissingRowDummyRecord` A dummy record for when we're missing a row, but still want to trigger something

Uses of RecordBase in org.apache.poi.hssf.model

Methods in org.apache.poi.hssf.model that return types with arguments of type RecordBase
`java.util.List<RecordBase>` | `InternalSheet.getRecords()`

Uses of RecordBase in org.apache.poi.hssf.record

Subclasses of RecordBase in org.apache.poi.hssf.record
`class` | `AbstractEscherHolderRecord` The escher container record is used to hold escher records.
`class` | `ArrayRecord` ARRAY (0x0221) Treated in a similar way to SharedFormulaRecord
`class` | `AutoFilterInfoRecord` The AutoFilterInfo record specifies the number of columns that have AutoFilter enabled and indicates the beginning of the collection of AutoFilter records.
`class` | `BackupRecord` Title: Backup Record
`class` | `BlankRecord` Title: Blank cell record (0x0201)
`class` | `BOFRecord` Title: Beginning Of File (0x0809)
`class` | `BookBoolRecord` Title: Save External Links record (BookBool)
`class` | `BoolErrRecord` Creates new BoolErrRecord.
`class` | `BottomMarginRecord` Record for the bottom margin.
`class` | `BoundSheetRecord` Title: Bound Sheet Record (aka BundleSheet) (0x0085)
`class` | `CalcCountRecord` Title: Calc Count Record Description: Specifies the maximum times the gui should perform a formula recalculation.
`class` | `CalcModeRecord` Title: Calc Mode Record
`class` | `CellRecord` Base class for all cell value records (implementors of `CellValueRecordInterface`).
`class` | `CFHeaderRecord` Conditional Formatting Header record CFHEADER (0x01B0)
`class` | `CFRuleRecord` Conditional Formatting Rule Record (0x01B1).
`class` | `CodepageRecord` Title: Codepage Record
`class` | `ColumnInfoRecord` Title: COLINFO Record (0x007D) 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)
`class` | `ContinueRecord` Title: Continue Record(0x003C) - Helper class used primarily for SST Records
`class` | `CountryRecord` Title: Country Record (aka WIN.INI country)
`class` | `CRNCountRecord` XCT - CRN Count
`class` | `CRNRecord` Title: CRN(0x005A) Description: This record stores the contents of an external cell or cell range REFERENCE: OOO 5.23
`class` | `DateWindow1904Record` Title: Date Window 1904 Flag record
`class` | `DBCellRecord` Title: DBCell Record (0x00D7) Description: Used by Excel and other MS apps to quickly find rows in the sheets.
`class` | `DefaultColWidthRecord` Title: Default Column Width Record (0x0055)
`class` | `DefaultRowHeightRecord` Title: Default Row Height Record Description: Row height for rows with undefined or not explicitly defined heights.
`class` | `DeltaRecord` Title: Delta Record (0x0010) Description: controls the accuracy of the calculations REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
`class` | `DimensionsRecord` Title: Dimensions Record
`class` | `DrawingGroupRecord`
`class` | `DrawingRecord` DrawingRecord (0x00EC)
`class` | `DrawingRecordForBiffViewer` This is purely for the biff viewer.
`class` | `DrawingSelectionRecord` MsoDrawingSelection (0x00ED) Reference: [MS-OGRAPH].pdf sec 2.4.69
`class` | `DSFRecord` Title: Double Stream Flag Record (0x0161) Description: tells if this is a double stream file.
`class` | `DVALRecord` Title: DATAVALIDATIONS Record (0x01B2) Description: used in data validation ; This record is the list header of all data validation records (0x01BE) in the current sheet.
`class` | `DVRecord` Title: DATAVALIDATION Record (0x01BE) Description: This record stores data validation settings and a list of cell ranges which contain these settings.
`class` | `EOFRecord` End Of File record.
`class` | `EscherAggregate` This class is used to aggregate the MSODRAWING and OBJ record combinations.
`class` | `ExtendedFormatRecord` Title: Extended Format Record Description: Probably one of the more complex records.
`class` | `ExternalNameRecord` EXTERNALNAME (0x0023)
`class` | `ExternSheetRecord` EXTERNSHEET (0x0017) A List of Indexes to EXTERNALBOOK (supplemental book) Records
`class` | `ExtSSTRecord` Title: Extended Static String Table (0x00FF) Description: This record is used for a quick lookup into the SST record.
`class` | `FeatHdrRecord` Title: FeatHdr (Feature Header) Record
`class` | `FeatRecord` Title: Feat (Feature) Record
`class` | `FilePassRecord` Title: File Pass Record (0x002F) Description: Indicates that the record after this record are encrypted.
`class` | `FileSharingRecord` Title: FILESHARING (0x005B) Description: stores the encrypted readonly for a workbook (write protect) This functionality is accessed from the options dialog box available when performing 'Save As'. REFERENCE: PG 314 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
`class` | `FnGroupCountRecord` Title: Function Group Count Record
`class` | `FontRecord` Title: Font Record (0x0031) - describes a font in the workbook (index = 0-3,5-infinity - skip 4)
`class` | `FooterRecord` Title: Footer Record (0x0015) Description: Specifies the footer for a sheet
`class` | `FormatRecord` Title: Format Record (0x041E) Description: describes a number format -- those goofy strings like $(#,###) REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
`class` | `FormulaRecord` Formula Record (0x0006).
`class` | `GridsetRecord` Title: Gridset Record.
`class` | `GutsRecord` Title: Guts Record
`class` | `HCenterRecord` Title: HCenter record (0x0083)
`class` | `HeaderFooterBase` Common header/footer base class
`class` | `HeaderFooterRecord` The HEADERFOOTER record stores information added in Office Excel 2007 for headers/footers.
`class` | `HeaderRecord` Title: Header Record
`class` | `HideObjRecord` Title: Hide Object Record
`class` | `HorizontalPageBreakRecord` HorizontalPageBreak (0x001B) record that stores page breaks at rows
`class` | `HyperlinkRecord` The `HyperlinkRecord` (0x01B8) wraps an HLINK-record from the Excel-97 format.
`class` | `IndexRecord` Title: Index Record (0x020B) 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)
`class` | `InterfaceEndRecord` Title: Interface End Record (0x00E2)
`class` | `InterfaceHdrRecord` Title: Interface Header Record (0x00E1)
`class` | `IterationRecord` Title: Iteration Record (0x0011) 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!)
`class` | `LabelRecord` Label Record (0x0204) - read only support for strings stored directly in the cell..
`class` | `LabelSSTRecord` Title: Label SST Record
`class` | `LeftMarginRecord` Record for the left margin.
`class` | `MergeCellsRecord` Title: Merged Cells Record (0x00E5) Description: Optional record defining a square area of cells to "merged" into one cell.
`class` | `MMSRecord` Title: MMS Record
`class` | `MulBlankRecord` Title: Multiple Blank cell record(0x00BE) Description: Represents a set of columns in a row with no value but with styling.
`class` | `MulRKRecord` MULRK (0x00BD) Used to store multiple RK numbers on a row.
`class` | `NameCommentRecord` Title: NAMECMT Record (0x0894) Description: Defines a comment associated with a specified name.
`class` | `NameRecord` Title: DEFINEDNAME Record (0x0018) Description: Defines a named range within a workbook.
`class` | `NoteRecord` NOTE: Comment Associated with a Cell (0x001C)
`class` | `NumberRecord` NUMBER (0x0203) Contains a numeric cell value.
`class` | `ObjectProtectRecord` Title: Object Protect Record
`class` | `ObjRecord` OBJRECORD (0x005D) The obj record is used to hold various graphic objects and controls.
`class` | `PageBreakRecord` Record that contains the functionality page breaks (horizontal and vertical)
`class` | `PaletteRecord` PaletteRecord (0x0092) - Supports custom palettes.
`class` | `PaneRecord` Describes the frozen and unfozen panes.
`class` | `PasswordRecord` Title: Password Record (0x0013) 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)
`class` | `PasswordRev4Record` Title: Protection Revision 4 password Record (0x01BC) Description: Stores the (2 byte??!!) encrypted password for a shared workbook REFERENCE: PG 374 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
`class` | `PrecisionRecord` Title: Precision Record
`class` | `PrintGridlinesRecord` Title: Print Gridlines Record
`class` | `PrintHeadersRecord` Title: Print Headers Record
`class` | `PrintSetupRecord` Title: PAGESETUP (0x00A1) 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) REFERENCE: PG 412 Microsoft Excel Binary File Format Structure v20091214
`class` | `ProtectionRev4Record` Title: Protection Revision 4 Record (0x01AF) Description: describes whether this is a protected shared/tracked workbook REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
`class` | `ProtectRecord` Title: Protect Record (0x0012) Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION) HSSF now supports the simple "protected" sheets (where they are not encrypted and open office et al ignore the password record entirely).
`class` | `RecalcIdRecord` Title: Recalc Id Record (0x01C1) Description: This record contains an ID that marks when a worksheet was last recalculated.
`class` | `Record` Title: Record Description: All HSSF Records inherit from this class.
`class` | `RefModeRecord` Title: RefMode Record
`class` | `RefreshAllRecord` Title: Refresh All Record (0x01B7) Description: Flag whether to refresh all external data when loading a sheet.
`class` | `RightMarginRecord` Record for the right margin.
`class` | `RKRecord` Title: RK Record (0x027E) Description: An internal 32 bit number with the two most significant bits storing the type.
`class` | `RowRecord` Title: Row Record (0x0208) Description: stores the row information for the sheet.
`class` | `SaveRecalcRecord` Title: Save Recalc Record
`class` | `ScenarioProtectRecord` Title: Scenario Protect Record
`class` | `SCLRecord` Specifies the window's zoom magnification.
`class` | `SelectionRecord` Title: Selection Record (0x001D)
`class` | `SharedFormulaRecord` Title: SHAREDFMLA (0x04BC) SharedFormulaRecord Description: Primarily used as an excel optimization so that multiple similar formulas are not written out too many times.
`class` | `SharedValueRecordBase` Common base class for `SharedFormulaRecord`, `ArrayRecord` and `TableRecord` which are have similarities.
`class` | `SSTRecord` Title: Static String Table Record (0x00FC) Description: This holds all the strings for LabelSSTRecords.
`class` | `StandardRecord` Subclasses of this class (the majority of BIFF records) are non-continuable.
`class` | `StringRecord` STRING (0x0207) Stores the cached result of a text formula
`class` | `StyleRecord` Title: Style Record (0x0293) Description: Describes a builtin to the gui or user defined style
`class` | `SupBookRecord` Title: Sup Book - EXTERNALBOOK (0x01AE) Description: A External Workbook Description (Supplemental Book) Its only a dummy record for making new ExternSheet Record
`class` | `TabIdRecord` Title: Sheet Tab Index Array Record (0x013D) Description: Contains an array of sheet id's.
`class` | `TableRecord` DATATABLE (0x0236) TableRecord - The record specifies a data table.
`class` | `TableStylesRecord` TABLESTYLES (0x088E)
`class` | `TextObjectRecord` The TXO record (0x01B6) is used to define the properties of a text box.
`class` | `TopMarginRecord` Record for the top margin.
`class` | `UncalcedRecord` Title: Uncalced Record
`class` | `UnknownRecord` Title: Unknown Record (for debugging) Description: Unknown record just tells you the sid so you can figure out what records you are missing.
`class` | `UserSViewBegin` The UserSViewBegin record specifies settings for a custom view associated with the sheet.
`class` | `UserSViewEnd` The UserSViewEnd record marks the end of the settings for a custom view associated with the sheet
`class` | `UseSelFSRecord` Title: USESELFS (0x0160) - Use Natural Language Formulas Flag Description: Tells the GUI if this was written by something that can use "natural language" formulas.
`class` | `VCenterRecord` Title: VCenter record
`class` | `VerticalPageBreakRecord` VerticalPageBreak (0x001A) record that stores page breaks at columns
`class` | `WindowOneRecord` Title: Window1 Record
`class` | `WindowProtectRecord` Title: Window Protect Record (0x0019) Description: flags whether workbook windows are protected REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
`class` | `WindowTwoRecord` Title: Window Two Record
`class` | `WriteAccessRecord` Title: Write Access Record (0x005C) 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)
`class` | `WriteProtectRecord` Title: Write Protect Record
`class` | `WSBoolRecord` Title: WSBOOL (0x0081) (called SHEETPR in OOO doc) Description: stores workbook settings (aka its a big "everything we didn't put somewhere else")

Uses of RecordBase in org.apache.poi.hssf.record.aggregates

Subclasses of RecordBase in org.apache.poi.hssf.record.aggregates
`class` | `CFRecordsAggregate` CFRecordsAggregate - aggregates Conditional Formatting records CFHeaderRecord and number of up to three CFRuleRecord records together to simplify access to them.
`class` | `ChartSubstreamRecordAggregate` Manages the all the records associated with a chart sub-stream. Includes the initial `BOFRecord` and final `EOFRecord`.
`class` | `ColumnInfoRecordsAggregate`
`class` | `ConditionalFormattingTable` Holds all the conditional formatting for a workbook sheet. See OOO exelfileformat.pdf sec 4.12 'Conditional Formatting Table'
`class` | `CustomViewSettingsRecordAggregate` Manages the all the records associated with a 'Custom View Settings' sub-stream. Includes the initial USERSVIEWBEGIN(0x01AA) and final USERSVIEWEND(0x01AB).
`class` | `DataValidityTable` Manages the DVALRecord and DVRecords for a single sheet See OOO excelfileformat.pdf section 4.14
`class` | `FormulaRecordAggregate` The formula record aggregate is used to join together the formula record and it's (optional) string record and (optional) Shared Formula Record (template reads, excel optimization).
`class` | `MergedCellsTable`
`class` | `PageSettingsBlock` Groups the page settings records for a worksheet. See OOO excelfileformat.pdf sec 4.4 'Page Settings Block'
`class` | `RecordAggregate` `RecordAggregate`s are groups of of BIFF `Record`s that are typically stored together and/or updated together.
`class` | `RowRecordsAggregate`
`class` | `WorksheetProtectionBlock` Groups the sheet protection records for a worksheet.

Methods in org.apache.poi.hssf.record.aggregates with parameters of type RecordBase
`void` | `CustomViewSettingsRecordAggregate.append(RecordBase r)`

Method parameters in org.apache.poi.hssf.record.aggregates with type arguments of type RecordBase
`void` | `PageSettingsBlock.positionRecords(java.util.List<RecordBase> sheetRecords)` Some apps can define multiple HeaderFooterRecord records for a sheet.

Uses of RecordBase in org.apache.poi.hssf.record.chart

Subclasses of RecordBase in org.apache.poi.hssf.record.chart
`class` | `AreaFormatRecord` The area format record is used to define the colours and patterns for an area.
`class` | `AreaRecord` The area record is used to define a area chart.
`class` | `AxisLineFormatRecord` The axis line format record defines the axis type details.
`class` | `AxisOptionsRecord` The axis options record provides unit information and other various tidbits about the axis.
`class` | `AxisParentRecord` The axis size and location
`class` | `AxisRecord` The axis record defines the type of an axis.
`class` | `AxisUsedRecord` The number of axes used on a chart.
`class` | `BarRecord` The bar record is used to define a bar chart.
`class` | `BeginRecord` The begin record defines the start of a block of records for a (grpahing data object.
`class` | `CategorySeriesAxisRecord` This record refers to a category or series axis and is used to specify label/tickmark frequency.
`class` | `CatLabRecord` CATLAB - Category Labels (0x0856)
`class` | `ChartEndBlockRecord` ENDBLOCK - Chart Future Record Type End Block (0x0853)
`class` | `ChartEndObjectRecord` ENDOBJECT - Chart Future Record Type End Object (0x0855)
`class` | `ChartFormatRecord` Class ChartFormatRecord (0x1014) (As with all chart related records, documentation is lacking.
`class` | `ChartFRTInfoRecord` CHARTFRTINFO - Chart Future Record Type Info (0x0850)
`class` | `ChartRecord` CHART (0x1002) The chart record is used to define the location and size of a chart. Chart related records don't seem to be covered in either the OOO or the MS documentation.
`class` | `ChartStartBlockRecord` STARTBLOCK - Chart Future Record Type Start Block (0x0852)
`class` | `ChartStartObjectRecord` STARTOBJECT - Chart Future Record Type Start Object (0x0854)
`class` | `ChartTitleFormatRecord` CHARTTITLEFORMAT (0x1050) Describes the formatting runs associated with a chart title.
`class` | `DataFormatRecord` The data format record is used to index into a series.
`class` | `DataLabelExtensionRecord` DATALABEXT - Chart Data Label Extension (0x086A)
`class` | `DatRecord` The dat record is used to store options for the chart.
`class` | `DefaultDataLabelTextPropertiesRecord` The default data label text properties record identifies the text characteristics of the preceding text record.
`class` | `EndRecord` The end record defines the end of a block of records for a (Graphing) data object.
`class` | `FontBasisRecord` The font basis record stores various font metrics.
`class` | `FontIndexRecord` The font index record indexes into the font table for the text record.
`class` | `FrameRecord` The frame record indicates whether there is a border around the displayed text of a chart.
`class` | `LegendRecord` Defines a legend for a chart.
`class` | `LineFormatRecord` Describes a line format record.
`class` | `LinkedDataRecord` Describes a linked data record.
`class` | `NumberFormatIndexRecord` The number format index record indexes format table.
`class` | `ObjectLinkRecord` Links text to an object on the chart or identifies it as the title.
`class` | `PlotAreaRecord` preceeds and identifies a frame as belonging to the plot area.
`class` | `PlotGrowthRecord` The plot growth record specifies the scaling factors used when a font is scaled.
`class` | `SeriesChartGroupIndexRecord` The series chart group index record stores the index to the CHARTFORMAT record (0 based).
`class` | `SeriesIndexRecord` links a series to its position in the series list.
`class` | `SeriesLabelsRecord` The series label record defines the type of label associated with the data format record.
`class` | `SeriesListRecord` SERIESLIST (0x1016) The series list record defines the series displayed as an overlay to the main chart record. (As with all chart related records, documentation is lacking.
`class` | `SeriesRecord` The series record describes the overall data for a series.
`class` | `SeriesTextRecord` SERIESTEXT (0x100D)
`class` | `SeriesToChartGroupRecord` Indicates the chart-group index for a series.
`class` | `SheetPropertiesRecord` Describes a chart sheet properties record.
`class` | `TextRecord` The text record is used to define text stored on a chart.
`class` | `TickRecord` The Tick record defines how tick marks and label positioning/formatting
`class` | `UnitsRecord` The units record describes units.
`class` | `ValueRangeRecord` The value range record defines the range of the value axis.

Uses of RecordBase in org.apache.poi.hssf.record.cont

Subclasses of RecordBase in org.apache.poi.hssf.record.cont
`class` | `ContinuableRecord` Common superclass of all records that can produce `ContinueRecord`s while being serialized.

Uses of RecordBase in org.apache.poi.hssf.record.pivottable

Subclasses of RecordBase in org.apache.poi.hssf.record.pivottable
`class` | `DataItemRecord` SXDI - Data Item (0x00C5)
`class` | `ExtendedPivotTableViewFieldsRecord` SXVDEX - Extended PivotTable View Fields (0x0100)
`class` | `PageItemRecord` SXPI - Page Item (0x00B6)
`class` | `StreamIDRecord` SXIDSTM - Stream ID (0x00D5)
`class` | `ViewDefinitionRecord` SXVIEW - View Definition (0x00B0)
`class` | `ViewFieldsRecord` SXVD - View Fields (0x00B1)
`class` | `ViewSourceRecord` SXVS - View Source (0x00E3)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

Copyright 2010 The Apache Software Foundation or its licensors, as applicable.