Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

jxl.biff.* (142)jxl.demo.* (12)jxl.format.* (16)jxl.read.* (79)
jxl.write.* (137)

jxl: Javadoc index of package jxl.


Package Samples:

jxl.biff
jxl.biff.drawing
jxl.biff.formula
jxl.demo
jxl.format
jxl.read.biff
jxl.write
jxl.write.biff

Classes:

DateTime: A Date which may be created on the fly by a user application and added to a spreadsheet NOTE: By default, all dates will have local timezone information added to their UTC value. If this is not desired (eg. if the date entered represents an interval eg. 9.83s for the 100m world record, then use the overloaded constructor which indicate that the date passed in was created under the GMT timezone. It is important that when the date was created, an instruction like Calendar.setTimeZone(TimeZone.getTimeZone("GMT")) was made prior to that
WritableCellFormat: A user specified cell format, which may be reused across many cells. The constructors takes parameters, such as font details and the numerical date formats, which specify to Excel how cells with this format should be displayed. Once a CellFormat has been added to a Cell which has been added to a sheet, then the CellFormat becomes immutable (to prevent unforeseen effects on other cells which share the same format). Attempts to call the various set... functions on a WritableCellFormat after this time will result in a runtime exception.
NumberFormat: A custom user defined number format, which may be instantiated within user applications in order to present numerical values to the appropriate level of accuracy. The string format used to create a number format adheres to the standard java specification, and JExcelAPI makes the necessary modifications so that it is rendered in Excel as the nearest possible equivalent. Once created, this may be used within a CellFormat object, which in turn is a parameter passed to the constructor of the Number cell
DateFormat: A custom user defined number format which may be instantiated within user applications in order to present date and time values in the appropriate format. The string format used to create a DateFormat adheres to the standard java specification, and JExcelApi makes the necessary modifications so that it is rendered as its nearest equivalent in Excel. Once created, this may be used within a CellFormat object, which in turn is a parameter passed to the constructor of the DateTime cell
ReadWrite: Demo class which uses the api to read in a spreadsheet and generate a clone of that spreadsheet which contains the same data. If the spreadsheet read in is the spreadsheet called jxlrwtest.xls (provided with the distribution) then this class will modify certain fields in the copy of that spreadsheet. This is illustrating that it is possible to read in a spreadsheet, modify a few values, and write it under a new name.
CompoundFile: Writes out a compound file Header block is -1 Excel data is e..n (where e is the head extension blocks, normally 0 and n is at least 8) Summary information (8 blocks) Document summary (8 blocks) BBD is block p..q (where p=e+n+16 and q-p+1 is the number of BBD blocks) Property storage block is q+b...r (normally 1 block) (where b is the number of BBD blocks)
SheetImpl: Represents a sheet within a workbook. Provides a handle to the individual cells, or lines of cells (grouped by Row or Column) In order to simplify this class due to code bloat, the actual reading logic has been delegated to the SheetReaderClass. This class' main responsibility is now to implement the API methods declared in the Sheet interface
Hyperlink: Hyperlink information. Only URLs or file links are supported Hyperlinks may apply to a range of cells; in such cases the methods getRow and getColumn return the cell at the top left of the range the hyperlink refers to. Hyperlinks have no specific cell format information applied to them, so the getCellFormat method will return null
HeaderFooter: Class which represents an Excel header or footer. Information for this class came from Microsoft Knowledge Base Article 142136 (previously Q142136). This class encapsulates three internal structures representing the header or footer contents which appear on the left, right or central part of the page
CellReferenceHelper: A helper to transform between excel cell references and sheet:column:row notation Because this function will be called when generating a string representation of a formula, the cell reference will merely be appened to the string buffer instead of returning a full blooded string, for performance reasons
RangeImpl: Implementation class for the Range interface. This merely holds the raw range information, and when the time comes, it interrogates the workbook for the object. This does not keep handles to the objects for performance reasons, as this could impact garbage collection on larger spreadsheets
BuiltInFormat: The excel string for the various built in formats. Used to present the cell format information back to the user The difference between this class and the various format object contained in the jxl.write package is that this object contains the Excel strings, not their java equivalents
BooleanCell: This type represents the Microsoft concept of a Boolean. Accordingly, this cell represents either TRUE, FALSE or an error condition. This third state naturally makes handling BooleanCells quite tricky, and use of the specific access methods should be handled with care
WritableImage: Allows an image to be created, or an existing image to be manipulated Note that co-ordinates and dimensions are given in cells, so that if for example the width or height of a cell which the image spans is altered, the image will have a correspondign distortion
CellValue: Abstract class which stores the common data used for cells, such as row, column and formatting information. Any record which directly represents the contents of a cell, such as labels and numbers, are derived from this class data store
WorkbookSettings: This is a bean which client applications may use to set various advanced workbook properties. Use of this bean is not mandatory, and its absence will merely result in workbooks being read/written using the default settings
Minus: Ambiguously defined minus operator, used as a place holder when parsing string formulas. At this stage it could be either a unary or binary operator - the string parser will deduce which and create the appropriate type
SheetRangeImpl: Implementation class for the Range interface. This merely holds the raw range information. This implementation is used for ranges which are present on the current working sheet, so the getSheetIndex merely returns -1
Plus: Ambiguously defined plus operator, used as a place holder when parsing string formulas. At this stage it could be either a unary or binary operator - the string parser will deduce which and create the appropriate type
SheetWriter: Contains the functionality necessary for writing out a sheet. Originally this was incorporated in WritableSheetImpl, but was moved out into a dedicated class in order to reduce the over bloated nature of that class
StringOperator: Ambiguously defined operator, used as a place holder when parsing string formulas. At this stage it could be either a unary or binary operator - the string parser will deduce which and create the appropriate type
File: A file of excel data to be written out. All the excel data is held in memory, and when the close method is called a CompoundFile object is used to write the Biff oriented excel data in the CompoundFile format
ExtendedSSTRecord: Indicates an extension to the Shared String Table. Currently this contains blank records Thanks to Guenther for contributing a proper implementation of the EXTSST record, replacing my previous dummy version
RangeSeparator: A "holding" token for a range separator. This token gets instantiated when the lexical analyzer can't distinguish a range cleanly, eg in the case where where one of the identifiers of the range is a formula
StringParseItem: A dummy implementation used for typing information when tokens are read when parsing strings. These are then stored by the parser before being re-stored as the appropriate RPN syntactic equivalent

Home | Contact Us | Privacy Policy | Terms of Service