Uses of Class
org.apache.poi.hssf.record.Record

Packages that use Record
org.apache.poi.hssf.dev DEV package serves two purposes. 1.  
org.apache.poi.hssf.eventmodel   
org.apache.poi.hssf.eventusermodel HSSF eventmodel Package provides an event-based API for reading HSSF files.  
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.  
 

Uses of Record in org.apache.poi.hssf.dev
 

Methods in org.apache.poi.hssf.dev that return Record
static Record[] BiffViewer.createRecords(java.io.InputStream in, boolean dump)
          Create an array of records from an input stream
 

Methods in org.apache.poi.hssf.dev with parameters of type Record
 void EFHSSF.recordHandler(Record record)
           
 

Uses of Record in org.apache.poi.hssf.eventmodel
 

Methods in org.apache.poi.hssf.eventmodel that return Record
static Record[] EventRecordFactory.createRecord(short rectype, short size, byte[] data)
          create a record, if there are MUL records than multiple records are returned digested into the non-mul form.
 

Methods in org.apache.poi.hssf.eventmodel with parameters of type Record
 boolean ERFListener.processRecord(Record rec)
          Process a Record.
 boolean ModelFactory.processRecord(Record rec)
           
 

Uses of Record in org.apache.poi.hssf.eventusermodel
 

Methods in org.apache.poi.hssf.eventusermodel with parameters of type Record
 void AbortableHSSFListener.processRecord(Record record)
          This method, inherited from HSSFListener is implemented as a stub.
abstract  short AbortableHSSFListener.abortableProcessRecord(Record record)
          Process an HSSF Record.
 void HSSFListener.processRecord(Record record)
          process an HSSF Record.
protected  short HSSFRequest.processRecord(Record rec)
          Called by HSSFEventFactory, passes the Record to each listener associated with a record.sid.
 

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

Methods in org.apache.poi.hssf.model that return Record
protected  Record Workbook.createBOF()
          creates the BOF record
protected  Record Workbook.createInterfaceHdr()
          creates the InterfaceHdr record
protected  Record Workbook.createMMS()
          creates an MMS record
protected  Record Workbook.createInterfaceEnd()
          creates the InterfaceEnd record
protected  Record Workbook.createWriteAccess()
          creates the WriteAccess record containing the logged in user's name
protected  Record Workbook.createCodepage()
          creates the Codepage record containing the constant stored in CODEPAGE
protected  Record Workbook.createDSF()
          creates the DSF record containing a 0 since HSSF can't even create Dual Stream Files
protected  Record Workbook.createTabId()
          creates the TabId record containing an array of 0,1,2.
protected  Record Workbook.createFnGroupCount()
          creates the FnGroupCount record containing the Magic number constant of 14.
protected  Record Workbook.createWindowProtect()
          creates the WindowProtect record with protect set to false.
protected  Record Workbook.createProtect()
          creates the Protect record with protect set to false.
protected  Record Workbook.createPassword()
          creates the Password record with password set to 0.
protected  Record Workbook.createProtectionRev4()
          creates the ProtectionRev4 record with protect set to false.
protected  Record Workbook.createPasswordRev4()
          creates the PasswordRev4 record with password set to 0.
protected  Record Workbook.createWindowOne()
          creates the WindowOne record with the following magic values: horizontal hold - 0x168 vertical hold - 0x10e width - 0x3a5c height - 0x23be options - 0x38 selected tab - 0 displayed tab - 0 num selected tab- 0 tab width ratio - 0x258
protected  Record Workbook.createBackup()
          creates the Backup record with backup set to 0.
protected  Record Workbook.createHideObj()
          creates the HideObj record with hide object set to 0.
protected  Record Workbook.createDateWindow1904()
          creates the DateWindow1904 record with windowing set to 0.
protected  Record Workbook.createPrecision()
          creates the Precision record with precision set to true.
protected  Record Workbook.createRefreshAll()
          creates the RefreshAll record with refreshAll set to true.
protected  Record Workbook.createBookBool()
          creates the BookBool record with saveLinkValues set to 0.
protected  Record Workbook.createFont()
          creates a Font record with the following magic values: fontheight = 0xc8 attributes = 0x0 color palette index = 0x7fff bold weight = 0x190 Font Name Length = 5 Font Name = Arial
protected  Record Workbook.createFormat(int id)
          Creates a FormatRecord object
protected  Record Workbook.createExtendedFormat(int id)
          Creates an ExtendedFormatRecord object
protected  Record Workbook.createStyle(int id)
          Creates a StyleRecord object
protected  Record Workbook.createUseSelFS()
          Creates the UseSelFS object with the use natural language flag set to 0 (false)
protected  Record Workbook.createBoundSheet(int id)
          create a "bound sheet" or "bundlesheet" (depending who you ask) record Always sets the sheet's bof to 0.
protected  Record Workbook.createCountry()
          Creates the Country record with the default country set to 1 and current country set to 7 in case of russian locale ("ru_RU") and 1 otherwise
protected  Record Workbook.createSST()
          Creates the SST record with no strings and the unique/num string set to 0
protected  Record Workbook.createExtendedSST()
          Creates the ExtendedSST record with numstrings per bucket set to 0x8.
protected  Record Workbook.createEOF()
          creates the EOF record
 Record Workbook.findFirstRecordBySid(short sid)
          Returns the first occurance of a record matching a particular sid.
 Record Workbook.findNextRecordBySid(short sid, int pos)
          Returns the next occurance of a record matching a particular sid.
 Record WorkbookRecordList.get(int i)
           
protected  Record Sheet.createBOF()
          creates the BOF record
protected  Record Sheet.createIndex()
          creates the Index record - not currently used
protected  Record Sheet.createCalcMode()
          creates the CalcMode record and sets it to 1 (automatic formula caculation)
protected  Record Sheet.createCalcCount()
          creates the CalcCount record and sets it to 0x64 (default number of iterations)
protected  Record Sheet.createRefMode()
          creates the RefMode record and sets it to A1 Mode (default reference mode)
protected  Record Sheet.createIteration()
          creates the Iteration record and sets it to false (don't iteratively calculate formulas)
protected  Record Sheet.createDelta()
          creates the Delta record and sets it to 0.0010 (default accuracy)
protected  Record Sheet.createSaveRecalc()
          creates the SaveRecalc record and sets it to true (recalculate before saving)
protected  Record Sheet.createPrintHeaders()
          creates the PrintHeaders record and sets it to false (we don't create headers yet so why print them)
protected  Record Sheet.createPrintGridlines()
          creates the PrintGridlines record and sets it to false (that makes for ugly sheets).
protected  Record Sheet.createGridset()
          creates the Gridset record and sets it to true (user has mucked with the gridlines)
protected  Record Sheet.createGuts()
          creates the Guts record and sets leftrow/topcol guttter and rowlevelmax/collevelmax to 0
protected  Record Sheet.createDefaultRowHeight()
          creates the DefaultRowHeight Record and sets its options to 0 and rowheight to 0xff
protected  Record Sheet.createWSBool()
          creates the WSBoolRecord and sets its values to defaults
protected  Record Sheet.createHeader()
          creates the Header Record and sets it to nothing/0 length
protected  Record Sheet.createFooter()
          creates the Footer Record and sets it to nothing/0 length
protected  Record Sheet.createHCenter()
          creates the HCenter Record and sets it to false (don't horizontally center)
protected  Record Sheet.createVCenter()
          creates the VCenter Record and sets it to false (don't horizontally center)
protected  Record Sheet.createPrintSetup()
          creates the PrintSetup Record and sets it to defaults and marks it invalid
protected  Record Sheet.createDefaultColWidth()
          creates the DefaultColWidth Record and sets it to 8
protected  Record Sheet.createColInfo()
          creates the ColumnInfo Record and sets it to a default column/width
protected  Record Sheet.createDimensions()
          creates the Dimensions Record and sets it to bogus values (you should set this yourself or let the high level API do it for you)
protected  Record Sheet.createWindowTwo()
          creates the WindowTwo Record and sets it to: options = 0x6b6 toprow = 0 leftcol = 0 headercolor = 0x40 pagebreakzoom = 0x0 normalzoom = 0x0
protected  Record Sheet.createSelection()
          Creates the Selection record and sets it to nothing selected
protected  Record Sheet.createMergedCells()
           
protected  Record Sheet.createEOF()
          creates the EOF record
 Record Sheet.findFirstRecordBySid(short sid)
          Returns the first occurance of a record matching a particular sid.
 

Methods in org.apache.poi.hssf.model with parameters of type Record
 void WorkbookRecordList.add(int pos, Record r)
           
 void Sheet.checkDimsLoc(Record rec, int recloc)
          in the event the record is a dimensions record, resets both the loc index and dimsloc index
 

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

Subclasses of Record in org.apache.poi.hssf.record
 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 NOTE: This source is automatically generated please do not modify this file.
 class AxisRecord
          The axis record defines the type of an axis.
 class AxisUsedRecord
          The number of axes used on a chart.
 class BackupRecord
          Title: Backup Record Description: Boolean specifying whether the GUI should store a backup of the file.
 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 BlankRecord
          Title: Blank cell record Description: Represents a column in a row with no value but with styling.
 class 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.
 class BookBoolRecord
          Title: Save External Links record (BookBool) Description: Contains a flag specifying whether the Gui should save externally linked values from other workbooks.
 class BoolErrRecord
          Creates new BoolErrRecord.
 class BottomMarginRecord
          Record for the bottom margin.
 class BoundSheetRecord
          Title: Bound Sheet Record (aka BundleSheet) Description: Defines a sheet within a workbook.
 class CalcCountRecord
          Title: Calc Count Record Description: Specifies the maximum times the gui should perform a formula recalculation.
 class CalcModeRecord
          Title: Calc Mode Record Description: Tells the gui whether to calculate formulas automatically, manually or automatically except for tables.
 class CategorySeriesAxisRecord
          This record refers to a category or series axis and is used to specify label/tickmark frequency.
 class ChartFormatRecord
          Class ChartFormatRecord
 class ChartRecord
          The chart record is used to define the location and size of a chart.
 class 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)
 class 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)
 class 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
 class CountryRecord
          Title: Country Record (aka WIN.INI country) Description: used for localization.
 class DataFormatRecord
          The data format record is used to index into a series.
 class DateWindow1904Record
          Title: Date Window 1904 Flag record Description: Flag specifying whether 1904 date windowing is used.
 class DatRecord
          The dat record is used to store options for the chart.
 class DBCellRecord
          Title: DBCell Record (Currently read only.
 class DefaultColWidthRecord
          Title: Default Column Width Record Description: Specifies the default width for columns that have no specific width set.
 class DefaultDataLabelTextPropertiesRecord
          The default data label text properties record identifies the text characteristics of the preceeding text record.
 class DefaultRowHeightRecord
          Title: Default Row Height Record Description: Row height for rows with undefined or not explicitly defined heights.
 class 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)
 class DimensionsRecord
          Title: Dimensions Record Description: provides the minumum and maximum bounds of a sheet.
 class DSFRecord
          Title: Double Stream Flag Record Description: tells if this is a double stream file.
 class EndRecord
          The end record defines the end of a block of records for a (Graphing) data object.
 class EOFRecord
          End Of File record.
 class ExtendedFormatRecord
          Title: Extended Format Record Description: Probably one of the more complex records.
 class ExternSheetRecord
          Title: Extern Sheet Description: A List of Inndexes to SupBook REFERENCE:
 class ExternSheetSubRecord
          Title: A sub Record for Extern Sheet Description: Defines a named range within a workbook.
 class 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!
 class 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".
 class 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)
 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 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)
 class 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)
 class 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)
 class FormulaRecord
          Formula Record.
 class FrameRecord
          The frame record indicates whether there is a border around the displayed text of a chart.
 class GridsetRecord
          Title: Gridset Record.
 class GutsRecord
          Title: Guts Record Description: Row/column gutter sizes REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
 class 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)
 class 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)
 class 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)
 class 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)
 class 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)
 class 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)
 class 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!)
 class LabelRecord
          Label Record - read only support for strings stored directly in the cell..
 class LabelSSTRecord
          Title: Label SST Record Description: Refers to a string in the shared string table and is a column value.
 class LeftMarginRecord
          Record for the left margin.
 class LegendRecord
          Defines a legend for a chart.
 class LineFormatRecord
          Describes a line format record.
 class LinkedDataRecord
          Describes a linked data record.
 class MergeCellsRecord
          Title: Merged Cells Record Description: Optional record defining a square area of cells to "merged" into one cell.
 class MMSRecord
          Title: MMS Record Description: defines how many add menu and del menu options are stored in the file.
 class MulBlankRecord
          Title: Mulitple Blank cell record Description: Represents a set of columns in a row with no value but with styling.
 class MulRKRecord
          Used to store multiple RK numbers on a row. 1 MulRk = Multiple Cell values.
 class NameRecord
          Title: Name Record (aka Named Range) Description: Defines a named range within a workbook.
 class NumberFormatIndexRecord
          The number format index record indexes format table.
 class NumberRecord
          Contains a numeric cell value.
 class ObjectLinkRecord
          Links text to an object on the chart or identifies it as the title.
 class PaletteRecord
          PaletteRecord - Supports custom palettes.
 class PaneRecord
          Describes the frozen and unfozen panes.
 class 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)
 class PasswordRev4Record
          Title: Protection Revision 4 password Record Description: Stores the (2 byte??!!)
 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 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!)
 class PrintGridlinesRecord
          Title: Print Gridlines Record Description: whether to print the gridlines when you enjoy you spreadsheet on paper.
 class PrintHeadersRecord
          Title: Print Headers Record Description: Whether or not to print the row/column headers when you enjoy your spreadsheet in the physical form.
 class 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)
 class 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)
 class 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??)
 class RecalcIdRecord
          Title: Recalc Id Record Description: This record contains an ID that marks when a worksheet was last recalculated.
 class 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)
 class RefreshAllRecord
          Title: Refresh All Record Description: Flag whether to refresh all external data when loading a sheet.
 class RightMarginRecord
          Record for the right margin.
 class RKRecord
          Title: RK Record Description: An internal 32 bit number with the two most significant bits storing the type.
 class RowRecord
          Title: Row Record Description: stores the row information for the sheet.
 class 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)
 class SCLRecord
          Specifies the window's zoom magnification.
 class 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.
 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
          The series list record defines the series displayed as an overlay to the main chart record.
 class SeriesRecord
          The series record describes the overall data for a series.
 class SeriesTextRecord
          Defines a series name NOTE: This source is automatically generated please do not modify this file.
 class SeriesToChartGroupRecord
          Indicates the chart-group index for a series.
 class SheetPropertiesRecord
          Describes a chart sheet properties record.
 class SSTRecord
          Title: Static String Table Record Description: This holds all the strings for LabelSSTRecords.
 class StringRecord
          Supports the STRING record structure.
 class 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)
 class SupBookRecord
          Title: Sup Book Description: A Extrenal Workbook Deciption (Sup Book) Its only a dummy record for making new ExternSheet Record REFERENCE:
 class TabIdRecord
          Title: Sheet Tab Index Array Record Description: Contains an array of sheet id's.
 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 NOTE: This source is automatically generated please do not modify this file.
 class TopMarginRecord
          Record for the top margin.
 class UnicodeString
          Title: Unicode String * Description: Unicode String record.
 class UnitsRecord
          The units record describes units.
 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 UseSelFSRecord
          Title: Use Natural Language Formulas Flag Description: Tells the GUI if this was written by something that can use "natural language" formulas.
 class ValueRangeRecord
          The value range record defines the range of the value axis.
 class 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)
 class WindowOneRecord
          Title: Window1 Record Description: Stores the attributes of the workbook window.
 class 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)
 class WindowTwoRecord
          Title: Window Two Record Description: sheet window settings REFERENCE: PG 422 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
 class 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)
 class WSBoolRecord
          Title: WSBool Record.
 

Methods in org.apache.poi.hssf.record that return Record
static Record[] RecordFactory.createRecord(short rectype, short size, byte[] data)
          Deprecated.  
 

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

Subclasses of Record in org.apache.poi.hssf.record.aggregates
 class FormulaRecordAggregate
          The formula record aggregate is used to join together the formula record and it's (optional) string record.
 class RowRecordsAggregate
           
 class ValueRecordsAggregate
          Aggregate value records together.
 


jakarta-poi 1.10.0-dev

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