| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjxl.Workbook
Represents a Workbook. Contains the various factory methods and provides a variety of accessors which provide access to the work sheets.
| Method Summary | |
| abstract  void | close()Closes this workbook, and frees makes any memory allocated available for garbage collection | 
| static WritableWorkbook | createWorkbook(java.io.File file)Creates a writable workbook with the given file name | 
| static WritableWorkbook | createWorkbook(java.io.File file,
               Workbook in)Creates a writable workbook with the given filename as a copy of the workbook passed in. | 
| static WritableWorkbook | createWorkbook(java.io.File file,
               WorkbookSettings ws)Creates a writable workbook with the given file name | 
| static WritableWorkbook | createWorkbook(java.io.File file,
               Workbook in,
               WorkbookSettings ws)Creates a writable workbook with the given filename as a copy of the workbook passed in. | 
| static WritableWorkbook | createWorkbook(java.io.OutputStream os)Creates a writable workbook. | 
| static WritableWorkbook | createWorkbook(java.io.OutputStream os,
               Workbook in)Creates a writable workbook as a copy of the workbook passed in. | 
| static WritableWorkbook | createWorkbook(java.io.OutputStream os,
               WorkbookSettings ws)Creates a writable workbook. | 
| static WritableWorkbook | createWorkbook(java.io.OutputStream os,
               Workbook in,
               WorkbookSettings ws)Creates a writable workbook as a copy of the workbook passed in. | 
| abstract  Range[] | findByName(java.lang.String name)Gets the named range from this workbook. | 
| abstract  Cell | findCellByName(java.lang.String name)Gets the named cell from this workbook. | 
| abstract  Cell | getCell(java.lang.String loc)Returns the cell for the specified location eg. | 
| abstract  int | getNumberOfSheets()Returns the number of sheets in this workbook | 
| abstract  java.lang.String[] | getRangeNames()Gets the named ranges | 
| abstract  Sheet | getSheet(int index)Gets the specified sheet within this workbook As described in the accompanying technical notes, each call to getSheet forces a reread of the sheet (for memory reasons). | 
| abstract  Sheet | getSheet(java.lang.String name)Gets the sheet with the specified name from within this workbook. | 
| abstract  java.lang.String[] | getSheetNames()Gets the sheet names | 
| abstract  Sheet[] | getSheets()Gets the sheets within this workbook. | 
| static java.lang.String | getVersion()Accessor for the software version | 
| static Workbook | getWorkbook(java.io.File file)A factory method which takes in an excel file and reads in the contents. | 
| static Workbook | getWorkbook(java.io.File file,
            WorkbookSettings ws)A factory method which takes in an excel file and reads in the contents. | 
| static Workbook | getWorkbook(java.io.InputStream is)A factory method which takes in an excel file and reads in the contents. | 
| static Workbook | getWorkbook(java.io.InputStream is,
            WorkbookSettings ws)A factory method which takes in an excel file and reads in the contents. | 
| abstract  boolean | isProtected()Determines whether the sheet is protected | 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Method Detail | 
public abstract Sheet[] getSheets()
public abstract java.lang.String[] getSheetNames()
public abstract Sheet getSheet(int index)
                        throws java.lang.IndexOutOfBoundsException
index - the zero based index of the reQuired sheet
IndexOutOfBoundException - when index refers to a non-existent
            sheet
java.lang.IndexOutOfBoundsExceptionpublic abstract Sheet getSheet(java.lang.String name)
name - the sheet name
public static java.lang.String getVersion()
public abstract int getNumberOfSheets()
public abstract Cell findCellByName(java.lang.String name)
name - the name of the cell/range to search for
public abstract Cell getCell(java.lang.String loc)
loc - the cell to retrieve
public abstract Range[] findByName(java.lang.String name)
name - the name of the cell/range to search for
public abstract java.lang.String[] getRangeNames()
public abstract boolean isProtected()
public abstract void close()
public static Workbook getWorkbook(java.io.File file)
                            throws java.io.IOException,
                                   jxl.read.biff.BiffException
file - the excel 97 spreadsheet to parse
java.io.IOException
jxl.read.biff.BiffException
public static Workbook getWorkbook(java.io.File file,
                                   WorkbookSettings ws)
                            throws java.io.IOException,
                                   jxl.read.biff.BiffException
file - the excel 97 spreadsheet to parsews - the settings for the workbook
java.io.IOException
jxl.read.biff.BiffException
public static Workbook getWorkbook(java.io.InputStream is)
                            throws java.io.IOException,
                                   jxl.read.biff.BiffException
is - an open stream which is the the excel 97 spreadsheet to parse
java.io.IOException
jxl.read.biff.BiffException
public static Workbook getWorkbook(java.io.InputStream is,
                                   WorkbookSettings ws)
                            throws java.io.IOException,
                                   jxl.read.biff.BiffException
is - an open stream which is the the excel 97 spreadsheet to parsews - the settings for the workbook
java.io.IOException
jxl.read.biff.BiffException
public static WritableWorkbook createWorkbook(java.io.File file)
                                       throws java.io.IOException
file - the workbook to copy
java.io.IOException
public static WritableWorkbook createWorkbook(java.io.File file,
                                              WorkbookSettings ws)
                                       throws java.io.IOException
file - the file to copy fromws - the global workbook settings
java.io.IOException
public static WritableWorkbook createWorkbook(java.io.File file,
                                              Workbook in)
                                       throws java.io.IOException
file - the output file for the copyin - the workbook to copy
java.io.IOException
public static WritableWorkbook createWorkbook(java.io.File file,
                                              Workbook in,
                                              WorkbookSettings ws)
                                       throws java.io.IOException
file - the output file for the copyin - the workbook to copyws - the configuration for this workbook
java.io.IOException
public static WritableWorkbook createWorkbook(java.io.OutputStream os,
                                              Workbook in)
                                       throws java.io.IOException
os - the stream to write toin - the workbook to copy
java.io.IOException
public static WritableWorkbook createWorkbook(java.io.OutputStream os,
                                              Workbook in,
                                              WorkbookSettings ws)
                                       throws java.io.IOException
os - the output stream to write toin - the workbook to copyws - the configuration for this workbook
java.io.IOException
public static WritableWorkbook createWorkbook(java.io.OutputStream os)
                                       throws java.io.IOException
os - the output stream
java.io.IOException
public static WritableWorkbook createWorkbook(java.io.OutputStream os,
                                              WorkbookSettings ws)
                                       throws java.io.IOException
os - the output streamws - the configuration for this workbook
java.io.IOException| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||