Apache POI - Common 5.3.0 · org.apache.poi.hssf.record

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

Class Summary

Modifier and Type	Class and Description
public abstract class	AbstractEscherHolderRecord The escher container record is used to hold escher records.
public class	ArrayRecord ARRAY (0x0221) Treated in a similar way to SharedFormulaRecord
public class	AutoFilterInfoRecord The AutoFilterInfo record specifies the number of columns that have AutoFilter enabled and indicates the beginning of the collection of AutoFilter records.
public class	BackupRecord Boolean specifying whether the GUI should store a backup of the file.
public class	BlankRecord Represents a column in a row with no value but with styling.
public class	BOFRecord Somewhat of a misnomer, its used for the beginning of a set of records that have a particular purpose or subject.
public class	BookBoolRecord Contains a flag specifying whether the Gui should save externally linked values from other workbooks.
public class	BoolErrRecord Creates new BoolErrRecord.
public class	BottomMarginRecord Record for the bottom margin.
public class	BoundSheetRecord Defines a sheet within a workbook.
public class	CalcCountRecord Specifies the maximum times the gui should perform a formula recalculation.
public class	CalcModeRecord Tells the gui whether to calculate formulas automatically, manually or automatically except for tables.
public abstract class	CellRecord Base class for all cell value records (implementors of `CellValueRecordInterface`).
public class	CFHeader12Record Conditional Formatting Header v12 record CFHEADER12 (0x0879), for conditional formattings introduced in Excel 2007 and newer.
public abstract class	CFHeaderBase Parent of Conditional Formatting Header records, `CFHeaderRecord` and `CFHeader12Record`.
public class	CFHeaderRecord Conditional Formatting Header record CFHEADER (0x01B0).
public class	CFRule12Record Conditional Formatting v12 Rule Record (0x087A).
public abstract class	CFRuleBase Conditional Formatting Rules.
public class	CFRuleRecord Conditional Formatting Rule Record (0x01B1).
public class	CodepageRecord The default characterset.
public class	ColumnInfoRecord Defines with width and formatting for a range of columns
public class	CommonObjectDataSubRecord The common object data record is used to store all common preferences for an excel object.
public class	ContinueRecord Helper class used primarily for SST Records handles overflow for prior record in the input stream; content is tailored to that prior record
public class	CountryRecord Country Record (aka WIN.INI country) - used for localization Currently HSSF always sets this to 1 and it seems to work fine even in Germany.
public class	CRNCountRecord XCT - CRN Count
public class	CRNRecord This record stores the contents of an external cell or cell range
public class	DateWindow1904Record Flag specifying whether 1904 date windowing is used.
public class	DBCellRecord Used by Excel and other MS apps to quickly find rows in the sheets.
public class	DConRefRecord DConRef records specify a range in a workbook (internal or external) that serves as a data source for pivot tables or data consolidation.
public class	DefaultColWidthRecord Specifies the default width for columns that have no specific width set.
public class	DefaultRowHeightRecord Row height for rows with undefined or not explicitly defined heights.
public class	DeltaRecord Controls the accuracy of the calculations
public class	DimensionsRecord Provides the minumum and maximum bounds of a sheet.
public class	DrawingGroupRecord Specifies a group of drawing objects.
public class	DrawingRecord
public class	DrawingRecordForBiffViewer This is purely for the biff viewer.
public class	DrawingSelectionRecord MsoDrawingSelection (0x00ED) Reference: [MS-OGRAPH].pdf sec 2.4.69
public class	DSFRecord Tells if this is a double stream file.
public class	DVALRecord This record is the list header of all data validation records (0x01BE) in the current sheet.
public class	DVRecord This record stores data validation settings and a list of cell ranges which contain these settings.
public class	EmbeddedObjectRefSubRecord ftPictFmla (0x0009) A sub-record within the OBJ record which stores a reference to an object stored in a separate entry within the OLE2 compound file.
public class	EndSubRecord ftEnd (0x0000) The end data record is used to denote the end of the subrecords.
public class	EOFRecord Marks the end of records belonging to a particular object in the HSSF File
public class	EscherAggregate This class is used to aggregate the MSODRAWING and OBJ record combinations.
public class	ExtendedFormatRecord Probably one of the more complex records.
public class	ExternalNameRecord EXTERNALNAME (0x0023)
public class	ExternSheetRecord EXTERNSHEET (0x0017) A List of Indexes to EXTERNALBOOK (supplemental book) Records
public class	ExtSSTRecord Extended Static String Table (0x00FF) This record is used for a quick lookup into the SST record.
public class	FeatHdrRecord Title: FeatHdr (Feature Header) Record This record specifies common information for Shared Features, and specifies the beginning of a collection of records to define them.
public class	FeatRecord Title: Feat (Feature) Record This record specifies Shared Features data.
public class	FilePassRecord File Pass Record (0x002F) Indicates that the record after this record are encrypted.
public class	FileSharingRecord Stores the encrypted readonly for a workbook (write protect).
public class	FnGroupCountRecord umber of built in function groups in the current version of the Spreadsheet (probably only used on Windows)
public class	FontRecord Describes a font in the workbook
public class	FooterRecord Specifies the footer for a sheet
public class	FormatRecord Describes a number format -- those goofy strings like $(#,###)
public class	FormulaRecord Formula Record (0x0006).
public class	FormulaSpecialCachedValue Manages the cached formula result values of other types besides numeric.
public class	FtCblsSubRecord This structure appears as part of an Obj record that represents a checkbox or radio button.
public class	FtCfSubRecord The FtCf structure specifies the clipboard format of the picture-type Obj record containing this FtCf.
public class	FtPioGrbitSubRecord This structure appears as part of an Obj record that represents image display properties.
public class	GridsetRecord Flag denoting whether the user specified that gridlines are used when printing.
public class	GroupMarkerSubRecord ftGmo (0x0006) The group marker record is used as a position holder for groups.
public class	GutsRecord Row/column gutter sizes
public class	HCenterRecord Whether to center between horizontal margins
public abstract class	HeaderFooterBase Common header/footer base class
public class	HeaderFooterRecord The HEADERFOOTER record stores information added in Office Excel 2007 for headers/footers.
public class	HeaderRecord Specifies a header for a sheet
public class	HideObjRecord Flag defines whether to hide placeholders and object
public class	HorizontalPageBreakRecord HorizontalPageBreak (0x001B) record that stores page breaks at rows
public class	HyperlinkRecord The `HyperlinkRecord` (0x01B8) wraps an HLINK-record from the Excel-97 format.
public class	IndexRecord Occurs right after BOF, tells you where the DBCELL records are for a sheet Important for locating cells
public class	InterfaceEndRecord Shows where the Interface Records ends (MMS)
public class	InterfaceHdrRecord Defines the beginning of Interface records (MMS)
public class	IterationRecord Tells whether to iterate over formula calculations or not.
public class	LabelRecord Label Record (0x0204) - read only support for strings stored directly in the cell...
public class	LabelSSTRecord Refers to a string in the shared string table and is a column value.
public class	LbsDataSubRecord This structure specifies the properties of a list or drop-down list embedded object in a sheet.
public class	LeftMarginRecord Record for the left margin.
public class	MergeCellsRecord Optional record defining a square area of cells to "merged" into one cell.
public class	MMSRecord defines how many add menu and del menu options are stored in the file.
public class	MulBlankRecord Represents a set of columns in a row with no value but with styling.
public class	MulRKRecord Used to store multiple RK numbers on a row.
public class	NameCommentRecord Defines a comment associated with a specified name.
public class	NameRecord Defines a named range within a workbook.
public class	NoteRecord Note Comment Associated with a Cell (0x001C)
public class	NoteStructureSubRecord ftNts (0x000D) Represents a NoteStructure sub record.
public class	NumberRecord NUMBER (0x0203) Contains a numeric cell value.
public class	ObjectProtectRecord Protect embedded object with the lamest "security" ever invented.
public class	ObjRecord OBJRECORD (0x005D) The obj record is used to hold various graphic objects and controls.
public abstract class	OldCellRecord Base class for all old (Biff 2 - Biff 4) cell value records (implementors of `CellValueRecordInterface`).
public class	OldFormulaRecord Formula Record (0x0006 / 0x0206 / 0x0406) - holds a formula in encoded form, along with the value if a number
public class	OldLabelRecord Biff2 - Biff 4 Label Record (0x0004 / 0x0204) - read only support for strings stored directly in the cell, from the older file formats that didn't use `LabelSSTRecord`
public class	OldSheetRecord Title: Bound Sheet Record (aka BundleSheet) (0x0085) for BIFF 5 Description: Defines a sheet within a workbook.
public class	OldStringRecord Biff2 - Biff 4 Label Record (0x0007 / 0x0207) - read only support for formula string results.
public abstract class	PageBreakRecord Record that contains the functionality page breaks (horizontal and vertical) The other two classes just specifically set the SIDS for record creation.
public class	PaletteRecord Supports custom palettes.
public class	PaneRecord Describes the frozen and unfrozen panes.
public class	PasswordRecord Stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption)
public class	PasswordRev4Record Protection Revision 4 password Record (0x01BC) Stores the (2 byte??!!) encrypted password for a shared workbook
public class	PrecisionRecord 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!)
public class	PrintGridlinesRecord Whether to print the gridlines when you enjoy the spreadsheet on paper.
public class	PrintHeadersRecord Whether or not to print the row/column headers when you enjoy your spreadsheet in the physical form.
public class	PrintSetupRecord Stores print setup options -- bogus for HSSF (and marked as such)
public class	ProtectionRev4Record Describes whether this is a protected shared/tracked workbook
public class	ProtectRecord 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).
public class	RecalcIdRecord This record contains an ID that marks when a worksheet was last recalculated.
public abstract class	Record All HSSF Records inherit from this class.
public abstract class	RecordBase Common base class of `Record` and `org.apache.poi.hssf.record.aggregates.RecordAggregate`
public class	RecordFactory Title: Record Factory Description: Takes a stream and outputs an array of Record objects.
public class	RecordFactoryInputStream A stream based way to get at complete records, with as low a memory footprint as possible.
public class	RecordInputStream Title: Record Input Stream Description: Wraps a stream and provides helper methods for the construction of records.
public class	RefModeRecord Describes which reference mode to use
public class	RefreshAllRecord Flag whether to refresh all external data when loading a sheet.
public class	RightMarginRecord Record for the right margin.
public class	RKRecord An internal 32 bit number with the two most significant bits storing the type.
public class	RowRecord Stores the row information for the sheet.
public class	SaveRecalcRecord Defines whether to recalculate before saving (set to true)
public class	ScenarioProtectRecord I have no idea what a Scenario is or why on would want to protect it with the lamest "security" ever invented.
public class	SCLRecord Specifies the window's zoom magnification.
public class	SelectionRecord Shows the user's selection on the sheet for write set num refs to 0
public class	SharedFormulaRecord Primarily used as an excel optimization so that multiple similar formulas are not written out too many times.
public abstract class	SharedValueRecordBase Common base class for `SharedFormulaRecord`, `ArrayRecord` and `TableRecord` which are have similarities.
pack-priv class	SSTDeserializer Handles the task of deserializing a SST string.
public class	SSTRecord Static String Table Record (0x00FC) This holds all the strings for LabelSSTRecords.
pack-priv class	SSTSerializer This class handles serialization of SST records.
public abstract class	StandardRecord Subclasses of this class (the majority of BIFF records) are non-continuable.
public class	StringRecord STRING (0x0207) Stores the cached result of a text formula
public class	StyleRecord Describes a builtin to the gui or user defined style
public abstract class	SubRecord Subrecords are part of the OBJ class.
public class	SupBookRecord A External Workbook Description (Supplemental Book).
public class	TabIdRecord Contains an array of sheet id's.
public class	TableRecord The record specifies a data table.
public class	TableStylesRecord TABLESTYLES (0x088E)
public class	TextObjectRecord The TXO record (0x01B6) is used to define the properties of a text box.
public class	TopMarginRecord Record for the top margin.
public class	UncalcedRecord If this record occurs in the Worksheet Substream, it indicates that the formulas have not been recalculated before the document was saved.
public class	UnknownRecord Unknown record just tells you the sid so you can figure out what records you are missing.
public class	UserSViewBegin The UserSViewBegin record specifies settings for a custom view associated with the sheet.
public class	UserSViewEnd The UserSViewEnd record marks the end of the settings for a custom view associated with the sheet
public class	UseSelFSRecord Tells the GUI if this was written by something that can use "natural language" formulas.
public class	VCenterRecord Tells whether to center the sheet between vertical margins
public class	VerticalPageBreakRecord VerticalPageBreak (0x001A) record that stores page breaks at columns
public class	WindowOneRecord Stores the attributes of the workbook window.
public class	WindowProtectRecord Flags whether workbook windows are protected
public class	WindowTwoRecord Sheet window settings
public 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)
public class	WriteProtectRecord Indicated that the sheet/workbook is write protected.
public class	WSBoolRecord Stores workbook settings (aka its a big "everything we didn't put somewhere else")

Package org.apache.poi.hssf.record

Interface Summary

Class Summary

Enum Summary