| Home >> All >> org >> apache >> poi >> [ hssf Javadoc ] |
• org.apache.poi.hssf: Javadoc index of package org.apache.poi.hssf.
Package Samples:
• org.apache.poi.hssf.record.formula: Record package contains class representations for XLS binary strutures.
• org.apache.poi.hssf.contrib.view
• org.apache.poi.hssf.usermodel.contrib
• org.apache.poi.hssf.usermodel.examples
• org.apache.poi.hssf.dev
• org.apache.poi.hssf.eventmodel
• org.apache.poi.hssf.eventusermodel
• org.apache.poi.hssf.model
• org.apache.poi.hssf.record.aggregates
• org.apache.poi.hssf.record
• org.apache.poi.hssf.usermodel
• org.apache.poi.hssf.util
Classes:
• HSSFDataFormat: Utility to identify builin formats. Now can handle user defined data formats also. The following is a list of the formats as returned by this class. 0, "General" 1, "0" 2, "0.00" 3, "#,##0" 4, "#,##0.00" 5, "($#,##0_);($#,##0)" 6, "($#,##0_);[Red]($#,##0)" 7, "($#,##0.00);($#,##0.00)" 8, "($#,##0.00_);[Red]($#,##0.00)" 9, "0%" 0xa, "0.00%" 0xb, "0.00E+00" 0xc, "# ?/?" 0xd, "# ??/??" 0xe, "m/d/yy" 0xf, "d-mmm-yy" 0x10, "d-mmm" 0x11, "mmm-yy" 0x12, "h:mm AM/PM" 0x13, "h:mm:ss AM/PM" 0x14, "h:mm" 0x15, "h:mm:ss" 0x16, "m/d/yy h:mm" // 0x17 - 0x24 reserved for international and undocumented 0x25, "(#,##0_);(#,##0)" ...
• EscherGraphics: Translates Graphics calls into escher calls. The translation is lossy so many features are not supported and some just aren't implemented yet. If in doubt test the specific calls you wish to make. Graphics calls are always performed into an EscherGroup so one will need to be created. Important: One important concept worth considering is that of font size. One of the difficulties in converting Graphics calls into escher drawing calls is that Excel does not have the concept of absolute pixel positions. It measures it's cell widths in 'characters' and the cell heights in points. Unfortunately it's ...
• EscherGraphics2d: Translates Graphics2d calls into escher calls. The translation is lossy so many features are not supported and some just aren't implemented yet. If in doubt test the specific calls you wish to make. Graphics calls are always drawn into an EscherGroup so one will need to be created. Important: One important concept worth considering is that of font size. One of the difficulties in converting Graphics calls into escher drawing calls is that Excel does not have the concept of absolute pixel positions. It measures it's cell widths in 'characters' and the cell heights in points. Unfortunately it's not ...
• RecalcIdRecord: Title: Recalc Id Record Description: This record contains an ID that marks when a worksheet was last recalculated. It's an optimization Excel uses to determine if it needs to recalculate the spreadsheet when it's opened. So far, only the two values 0xC1 0x01 0x00 0x00 0x80 0x38 0x01 0x00 (do not recalculate) and 0xC1 0x01 0x00 0x00 0x60 0x69 0x01 0x00 have been seen. If the field isNeeded is set to false (default), then this record is swallowed during the serialization process REFERENCE: http://chicago.sourceforge.net/devel/docs/excel/biff8.html
• Workbook: Low level model implementation of a Workbook. Provides creational methods for settings and objects contained in the workbook object. This file contains the low level binary records starting at the workbook's BOF and ending with the workbook's EOF. Use HSSFWorkbook for a high level representation. The structures of the highlevel API use references to this to perform most of their operations. Its probably unwise to use these low level structures directly unless you really know what you're doing. I recommend you read the Microsoft Excel 97 Developer's Kit (Microsoft Press) and the documentation at ...
• HSSFPrintSetup: Used to modify the print setup. Paper size constants have been added for the ones I have access to. They follow as: public static final short LETTER_PAPERSIZE = 1; public static final short LEGAL_PAPERSIZE = 5; public static final short EXECUTIVE_PAPERSIZE = 7; public static final short A4_PAPERSIZE = 9; public static final short A5_PAPERSIZE = 11; public static final short ENVELOPE_10_PAPERSIZE = 20; public static final short ENVELOPE_DL_PAPERSIZE = 27; public static final short ENVELOPE_CS_PAPERSIZE = 28; public static final short ENVELOPE_MONARCH_PAPERSIZE = 37;
• Sheet: Low level model implementation of a Sheet (one workbook contains many sheets) This file contains the low level binary records starting at the sheets BOF and ending with the sheets EOF. Use HSSFSheet for a high level representation. The structures of the highlevel API use references to this to perform most of their operations. Its probably unwise to use these low level structures directly unless you really know what you're doing. I recommend you read the Microsoft Excel 97 Developer's Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf before even attempting ...
• HSSFCell: High level representation of a cell in a row of a spreadsheet. Cells can be numeric, formula-based or string-based (text). The cell type specifies this. String cells cannot conatin numbers and numeric cells cannot contain strings (at least according to our model). Client apps should do the conversions themselves. Formula cells are treated like string cells, simply containing a formula string. They'll be rendered differently. Cells should have their number (0 based) before being added to a row. Only cells that have values should be added. NOTE: the alpha won't be implementing formulas
• RKRecord: Title: RK Record Description: An internal 32 bit number with the two most significant bits storing the type. This is part of a bizarre scheme to save disk space and memory (gee look at all the other whole records that are in the file just "cause"..,far better to waste processor cycles on this then leave on of those "valuable" records out). We support this in READ-ONLY mode. HSSF converts these to NUMBER records REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
• EscherAggregate: This class is used to aggregate the MSODRAWING and OBJ record combinations. This is necessary due to the bizare way in which these records are serialized. What happens is that you get a combination of MSODRAWING -> OBJ -> MSODRAWING -> OBJ records but the escher records are serialized _across_ the MSODRAWING records. It gets even worse when you start looking at TXO records. So what we do with this class is aggregate lazily. That is we don't aggregate the MSODRAWING -> OBJ records unless we need to modify them.
• HSSFColor: Intends to provide support for the very evil index to triplet issue and will likely replace the color contants interface for HSSF 2.0. This class contains static inner class members for representing colors. Each color has an index (for the standard palette in Excel (tm) ), native (RGB) triplet and string triplet. The string triplet is as the color would be represented by Gnumeric. Having (string) this here is a bit of a collusion of function between HSSF and the HSSFSerializer but I think its a reasonable one in this case.
• ExtendedFormatRecord: Title: Extended Format Record Description: Probably one of the more complex records. There are two breeds: Style and Cell. It should be noted that fields in the extended format record are somewhat arbitrary. Almost all of the fields are bit-level, but we name them as best as possible by functional group. In some places this is better than others. REFERENCE: PG 426 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
• HSSFUserException: This exception is provided as a way for API users to throw exceptions from their event handling code. By doing so they abort file processing by the HSSFEventFactory and by catching it from outside the HSSFEventFactory.processEvents method they can diagnose the cause for the abort. The HSSFUserException supports a nested "reason" throwable, i.e. an exception that caused this one to be thrown. The HSSF package does not itself throw any of these exceptions.
• SharedFormulaRecord: Title: SharedFormulaRecord Description: Primarily used as an excel optimization so that multiple similar formulas are not written out too many times. We should recognize this record and serialize as is since this is used when reading templates. Note: the documentation says that the SID is BC where biffviewer reports 4BC. The hex dump shows that the two byte sid representation to be 'BC 04' that is consistent with the other high byte record types.
• CalcCountRecord: Title: Calc Count Record Description: Specifies the maximum times the gui should perform a formula recalculation. For instance: in the case a formula includes cells that are themselves a result of a formula and a value changes. This is essentially a failsafe against an infinate loop in the event the formulas are not independant. REFERENCE: PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
• HSSFFooter: Class to read and manipulate the footer. The footer works by having a left, center, and right side. The total cannot be more that 255 bytes long. One uses this class by getting the HSSFFooter from HSSFSheet and then getting or setting the left, center, and right side. For special things (such as page numbers and date), one can use a the methods that return the characters used to represent these. One can also change the fonts by using similar methods.
• HSSFHeader: Class to read and manipulate the header. The header works by having a left, center, and right side. The total cannot be more that 255 bytes long. One uses this class by getting the HSSFHeader from HSSFSheet and then getting or setting the left, center, and right side. For special things (such as page numbers and date), one can use a the methods that return the characters used to represent these. One can also change the fonts by using similar methods.
• HSSFCellUtil: Various utility functions that make working with a cells and rows easier. The various methods that deal with style's allow you to create your HSSFCellStyles as you need them. When you apply a style change to a cell, the code will attempt to see if a style already exists that meets your needs. If not, then it will create a new style. This is to prevent creating too many styles. there is an upper limit in Excel on the number of styles that can be supported.
• SeriesToChartGroupRecord: Indicates the chart-group index for a series. The order probably defines the mapping. So the 0th record probably means the 0th series. The only field in this of course defines which chart group the 0th series (for instance) would map to. Confusing? Well thats because it is. (p 522 BCG) NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
• ExtSSTRecord: Title: Extended Static String Table Description: This record is used for a quick lookup into the SST record. This record breaks the SST table into a set of buckets. The offsets to these buckets within the SST record are kept as well as the position relative to the start of the SST record. REFERENCE: PG 313 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
• TextObjectBaseRecord: The TXO record is used to define the properties of a text box. It is followed by two continue records unless there is no actual text. The first continue record contains the text data and the next continue record contains the formatting runs. NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
• HSSFEventFactory: Low level event based HSSF reader. Pass either a DocumentInputStream to process events along with a request object or pass a POIFS POIFSFileSystem to processWorkbookEvents along with a request. This will cause your file to be processed a record at a time. Each record with a static id matching one that you have registed in your HSSFRequest will be passed to your associated HSSFListener.
• FormulaParser: This class parses a formula string into a List of tokens in RPN order. Inspired by Lets Build a Compiler, by Jack Crenshaw BNF for the formula expression is : ::= [ ]* ::= [ ]* ::= | ( ) | | ::= ([expression [, expression]*])
• SViewer: Sheet Viewer - Views XLS files via HSSF. Can be used as an applet with filename="" or as a applications (pass the filename as the first parameter). Or you can pass it a URL in a "url" parameter when run as an applet or just that first parameter must start with http:// and it will guess its a url. I only tested it as an applet though, so it probably won't work...you fix it.
• 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??) REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
| Home | Contact Us | Privacy Policy | Terms of Service |