Uses of Class
org.apache.poi.hssf.record.RecordBase
Packages that use RecordBase
Package
Description
Provides low level API structures for reading, writing, modifying XLS files.
Record package contains class representations for XLS binary strutures.
The record aggregates are not real "records" but collections of records that act as a single record.
-
Uses of RecordBase in org.apache.poi.hssf.eventusermodel.dummyrecord
Subclasses of RecordBase in org.apache.poi.hssf.eventusermodel.dummyrecordModifier and TypeClassDescriptionfinal classA dummy record to indicate that we've now had the last cell record for this row.final classA dummy record for when we're missing a cell in a row, but still want to trigger somethingfinal classA 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 -
Uses of RecordBase in org.apache.poi.hssf.record
Subclasses of RecordBase in org.apache.poi.hssf.recordModifier and TypeClassDescriptionclassThe escher container record is used to hold escher records.final classARRAY (0x0221)final classThe AutoFilterInfo record specifies the number of columns that have AutoFilter enabled and indicates the beginning of the collection of AutoFilter records.final classBoolean specifying whether the GUI should store a backup of the file.final classRepresents a column in a row with no value but with styling.final classSomewhat of a misnomer, its used for the beginning of a set of records that have a particular purpose or subject.final classContains a flag specifying whether the Gui should save externally linked values from other workbooks.final classCreates new BoolErrRecord.final classRecord for the bottom margin.final classDefines a sheet within a workbook.final classSpecifies the maximum times the gui should perform a formula recalculation.final classTells the gui whether to calculate formulas automatically, manually or automatically except for tables.classBase class for all cell value records (implementors ofCellValueRecordInterface).final classConditional Formatting Header v12 record CFHEADER12 (0x0879), for conditional formattings introduced in Excel 2007 and newer.classParent of Conditional Formatting Header records,CFHeaderRecordandCFHeader12Record.final classConditional Formatting Header record CFHEADER (0x01B0).final classConditional Formatting v12 Rule Record (0x087A).classConditional Formatting Rules.final classConditional Formatting Rule Record (0x01B1).final classThe default characterset.final classDefines with width and formatting for a range of columnsfinal classHelper class used primarily for SST Recordsfinal classCountry Record (aka WIN.INI country) - used for localizationfinal classXCT - CRN Countfinal classThis record stores the contents of an external cell or cell rangefinal classFlag specifying whether 1904 date windowing is used.final classUsed by Excel and other MS apps to quickly find rows in the sheets.classDConRef records specify a range in a workbook (internal or external) that serves as a data source for pivot tables or data consolidation.final classSpecifies the default width for columns that have no specific width set.final classRow height for rows with undefined or not explicitly defined heights.final classControls the accuracy of the calculationsfinal classProvides the minumum and maximum bounds of a sheet.final classSpecifies a group of drawing objects.final classfinal classThis is purely for the biff viewer.final classMsoDrawingSelection (0x00ED)final classTells if this is a double stream file.final classThis record is the list header of all data validation records (0x01BE) in the current sheet.final classThis record stores data validation settings and a list of cell ranges which contain these settings.final classMarks the end of records belonging to a particular object in the HSSF Filefinal classThis class is used to aggregate the MSODRAWING and OBJ record combinations.final classProbably one of the more complex records.final classEXTERNALNAME (0x0023)classEXTERNSHEET (0x0017)final classExtended Static String Table (0x00FF)final classTitle: FeatHdr (Feature Header) Recordfinal classTitle: Feat (Feature) Recordfinal classFile Pass Record (0x002F)final classStores the encrypted readonly for a workbook (write protect).final classumber of built in function groups in the current version of the Spreadsheet (probably only used on Windows)final classDescribes a font in the workbookfinal classSpecifies the footer for a sheetfinal classDescribes a number format -- those goofy strings like $(#,###)final classFormula Record (0x0006).final classFlag denoting whether the user specified that gridlines are used when printing.final classRow/column gutter sizesfinal classWhether to center between horizontal marginsclassCommon header/footer base classfinal classThe HEADERFOOTER record stores information added in Office Excel 2007 for headers/footers.final classSpecifies a header for a sheetfinal classFlag defines whether to hide placeholders and objectfinal classHorizontalPageBreak (0x001B) record that stores page breaks at rowsfinal classTheHyperlinkRecord(0x01B8) wraps an HLINK-record from the Excel-97 format.final classOccurs right after BOF, tells you where the DBCELL records are for a sheet Important for locating cellsfinal classShows where the Interface Records ends (MMS)final classDefines the beginning of Interface records (MMS)final classTells whether to iterate over formula calculations or not.final classLabel Record (0x0204) - read only support for strings stored directly in the cell...final classRefers to a string in the shared string table and is a column value.final classRecord for the left margin.final classOptional record defining a square area of cells to "merged" into one cell.final classdefines how many add menu and del menu options are stored in the file.final classRepresents a set of columns in a row with no value but with styling.final classUsed to store multiple RK numbers on a row.final classDefines a comment associated with a specified name.final classDefines a named range within a workbook.final classNOTE: Comment Associated with a Cell (0x001C)final classNUMBER (0x0203) Contains a numeric cell value.final classProtect embedded object with the lamest "security" ever invented.final classOBJRECORD (0x005D)classRecord that contains the functionality page breaks (horizontal and vertical)final classSupports custom palettes.final classDescribes the frozen and unfrozen panes.final classStores the encrypted password for a sheet or workbook (HSSF doesn't support encryption)final classProtection Revision 4 password Record (0x01BC)final classDefines 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!)final classWhether to print the gridlines when you enjoy the spreadsheet on paper.final classWhether or not to print the row/column headers when you enjoy your spreadsheet in the physical form.final classStores print setup options -- bogus for HSSF (and marked as such)final classDescribes whether this is a protected shared/tracked workbookfinal classDefines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)final classThis record contains an ID that marks when a worksheet was last recalculated.classAll HSSF Records inherit from this class.final classDescribes which reference mode to usefinal classFlag whether to refresh all external data when loading a sheet.final classRecord for the right margin.final classAn internal 32 bit number with the two most significant bits storing the type.final classStores the row information for the sheet.final classDefines whether to recalculate before saving (set to true)final classI have no idea what a Scenario is or why on would want to protect it with the lamest "security" ever invented.final classSpecifies the window's zoom magnification.final classShows the user's selection on the sheet for write set num refs to 0final classPrimarily used as an excel optimization so that multiple similar formulas are not written out too many times.classfinal classStatic String Table Record (0x00FC)classSubclasses of this class (the majority of BIFF records) are non-continuable.final classSTRING (0x0207)final classDescribes a builtin to the gui or user defined stylefinal classA External Workbook Description (Supplemental Book).final classContains an array of sheet id's.final classThe record specifies a data table.final classTABLESTYLES (0x088E)final classThe TXO record (0x01B6) is used to define the properties of a text box.final classRecord for the top margin.final classIf this record occurs in the Worksheet Substream, it indicates that the formulas have not been recalculated before the document was saved.final classUnknown record just tells you the sid so you can figure out what records you are missing.final classThe UserSViewBegin record specifies settings for a custom view associated with the sheet.final classThe UserSViewEnd record marks the end of the settings for a custom view associated with the sheetfinal classTells the GUI if this was written by something that can use "natural language" formulas.final classTells whether to center the sheet between vertical marginsfinal classVerticalPageBreak (0x001A) record that stores page breaks at columnsfinal classStores the attributes of the workbook window.final classFlags whether workbook windows are protectedfinal classSheet window settingsfinal classTitle: Write Access Record (0x005C)final classIndicated that the sheet/workbook is write protected.final classStores workbook settings (aka its a big "everything we didn't put somewhere else")Method parameters in org.apache.poi.hssf.record with type arguments of type RecordBaseModifier and TypeMethodDescriptionstatic EscherAggregateEscherAggregate.createAggregate(List<RecordBase> records, int locFirstDrawingRecord) Collapses the drawing records into an aggregate. -
Uses of RecordBase in org.apache.poi.hssf.record.aggregates
Subclasses of RecordBase in org.apache.poi.hssf.record.aggregatesModifier and TypeClassDescriptionfinal classCFRecordsAggregate - aggregates Conditional Formatting records CFHeaderRecord and number of up CFRuleRecord records together to simplify access to them.final classManages the all the records associated with a chart sub-stream.final classfinal classHolds all the conditional formatting for a workbook sheet.final classManages the all the records associated with a 'Custom View Settings' sub-stream.final classManages the DVALRecord and DVRecords for a single sheetfinal classThe 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).final classfinal classGroups the page settings records for a worksheet.classRecordAggregates are groups of of BIFFRecords that are typically stored together and/or updated together.final classfinal classGroups the sheet protection records for a worksheet.Methods in org.apache.poi.hssf.record.aggregates with parameters of type RecordBaseMethod parameters in org.apache.poi.hssf.record.aggregates with type arguments of type RecordBaseModifier and TypeMethodDescriptionvoidPageSettingsBlock.positionRecords(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.chartModifier and TypeClassDescriptionfinal classThe area format record is used to define the colours and patterns for an area.final classThe area record is used to define an area chart.final classThe axis line format record defines the axis type details.final classThe axis options record provides unit information and other various tidbits about the axis.final classThe axis size and locationfinal classThe axis record defines the type of an axis.final classThe number of axes used on a chart.final classThe bar record is used to define a bar chart.final classThe begin record defines the start of a block of records for a (graphing data object.final classThis record refers to a category or series axis and is used to specify label/tickmark frequency.final classCATLAB - Category Labels (0x0856)final classENDBLOCK - Chart Future Record Type End Block (0x0853)final classENDOBJECT - Chart Future Record Type End Object (0x0855)final classClass ChartFormatRecord (0x1014)final classCHARTFRTINFO - Chart Future Record Type Info (0x0850)final classCHART (0x1002)final classSTARTBLOCK - Chart Future Record Type Start Block (0x0852)final classSTARTOBJECT - Chart Future Record Type Start Object (0x0854)classCHARTTITLEFORMAT (0x1050)final classThe data format record is used to index into a series.final classDATALABEXT - Chart Data Label Extension (0x086A)final classThe dat record is used to store options for the chart.final classThe default data label text properties record identifies the text characteristics of the preceding text record.final classThe end record defines the end of a block of records for a (Graphing) data object.final classThe font basis record stores various font metrics.final classThe font index record indexes into the font table for the text record.final classThe frame record indicates whether there is a border around the displayed text of a chart.final classDefines a legend for a chart.final classDescribes a line format record.final classDescribes a linked data record.final classThe number format index record indexes format table.final classLinks text to an object on the chart or identifies it as the title.final classprecedes and identifies a frame as belonging to the plot area.final classThe plot growth record specifies the scaling factors used when a font is scaled.final classThe series chart group index record stores the index to the CHARTFORMAT record (0 based).final classlinks a series to its position in the series list.final classThe series label record defines the type of label associated with the data format record.final classSERIESLIST (0x1016)final classThe series record describes the overall data for a series.final classSERIESTEXT (0x100D)final classDescribes a chart sheet properties record.final classThe text record is used to define text stored on a chart.final classThe Tick record defines how tick marks and label positioning/formattingfinal classThe units record describes units.final classThe 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.contModifier and TypeClassDescriptionclassCommon superclass of all records that can produceContinueRecords while being serialized. -
Uses of RecordBase in org.apache.poi.hssf.record.pivottable
Subclasses of RecordBase in org.apache.poi.hssf.record.pivottableModifier and TypeClassDescriptionfinal classSXDI - Data Item (0x00C5)final classSXVDEX - Extended PivotTable View Fields (0x0100)final classSXPI - Page Item (0x00B6)final classSXIDSTM - Stream ID (0x00D5)final classSXVIEW - View Definition (0x00B0)final classSXVD - View Fields (0x00B1)final classSXVS - View Source (0x00E3)