jxl.write
Class WritableWorkbook

java.lang.Object
  |
  +--jxl.write.WritableWorkbook
Direct Known Subclasses:
WritableWorkbookImpl

public abstract class WritableWorkbook
extends java.lang.Object

A writable workbook


Field Summary
static WritableFont ARIAL_10_PT
          The default font for Cell formats
static WritableFont HYPERLINK_FONT
          The font used for hyperlinks
static WritableCellFormat HYPERLINK_STYLE
          The style used for hyperlinks
static WritableCellFormat NORMAL_STYLE
          The default style for cells
 
Constructor Summary
protected WritableWorkbook()
          Constructor used by the implemenation class
 
Method Summary
abstract  void close()
          Closes this workbook, and makes any memory allocated available for garbage collection.
 void copy(Workbook w)
          Deprecated. Copying now occurs implicitly as part of the overloaded factory method Workbook.createWorkbood
abstract  void copySheet(int s, java.lang.String name, int index)
          Copies the specified sheet and places it at the index specified by the parameter
abstract  void copySheet(java.lang.String s, java.lang.String name, int index)
          Copies the specified sheet and places it at the index specified by the parameter
abstract  WritableSheet createSheet(java.lang.String name, int index)
          Creates, and returns a worksheet at the specified position with the specified name If the index specified is less than or equal to zero, the new sheet is created at the beginning of the workbook.
abstract  int getNumberOfSheets()
          Returns the number of sheets in this workbook
abstract  WritableSheet getSheet(int index)
          Gets the specified sheet within this workbook
abstract  WritableSheet getSheet(java.lang.String name)
          Gets the sheet with the specified name from within this workbook
abstract  WritableSheet[] getSheets()
          Gets the sheets within this workbook.
abstract  WritableSheet moveSheet(int fromIndex, int toIndex)
          Moves the specified sheet within this workbook to another index position.
abstract  void removeSheet(int index)
          Removes the sheet at the specified index from this workbook
abstract  void setColourRGB(Colour c, int r, int g, int b)
          Sets the RGB value for the specified colour for this workbook
abstract  void setProtected(boolean prot)
          Indicates whether or not this workbook is protected
abstract  void write()
          Writes out the data held in this workbook in Excel format
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

ARIAL_10_PT

public static final WritableFont ARIAL_10_PT
The default font for Cell formats

HYPERLINK_FONT

public static WritableFont HYPERLINK_FONT
The font used for hyperlinks

NORMAL_STYLE

public static final WritableCellFormat NORMAL_STYLE
The default style for cells

HYPERLINK_STYLE

public static WritableCellFormat HYPERLINK_STYLE
The style used for hyperlinks
Constructor Detail

WritableWorkbook

protected WritableWorkbook()
Constructor used by the implemenation class
Method Detail

getSheets

public abstract WritableSheet[] getSheets()
Gets the sheets within this workbook. Use of this method for large worksheets can cause performance problems.
Returns:
an array of the individual sheets

getSheet

public abstract WritableSheet getSheet(int index)
                                throws java.lang.IndexOutOfBoundsException
Gets the specified sheet within this workbook
Parameters:
index - the zero based index of the reQuired sheet
Returns:
The sheet specified by the index
Throws:
IndexOutOfBoundException - when index refers to a non-existent sheet

getSheet

public abstract WritableSheet getSheet(java.lang.String name)
Gets the sheet with the specified name from within this workbook
Parameters:
name - the sheet name
Returns:
The sheet with the specified name, or null if it is not found

getNumberOfSheets

public abstract int getNumberOfSheets()
Returns the number of sheets in this workbook
Returns:
the number of sheets in this workbook

close

public abstract void close()
                    throws java.io.IOException
Closes this workbook, and makes any memory allocated available for garbage collection. Also closes the underlying output stream if necessary.
Throws:
java.io.IOException -  

createSheet

public abstract WritableSheet createSheet(java.lang.String name,
                                          int index)
Creates, and returns a worksheet at the specified position with the specified name If the index specified is less than or equal to zero, the new sheet is created at the beginning of the workbook. If the index is greater than the number of sheet, then the sheet is created at the end of the workbook.
Parameters:
name -  
index -  

copySheet

public abstract void copySheet(int s,
                               java.lang.String name,
                               int index)
Copies the specified sheet and places it at the index specified by the parameter
Parameters:
s - the index of the sheet to copy
name - the name of the new sheet
index - the position of the new sheet

copySheet

public abstract void copySheet(java.lang.String s,
                               java.lang.String name,
                               int index)
Copies the specified sheet and places it at the index specified by the parameter
Parameters:
s - the name of the sheet to copy
name - the name of the new sheet
index - the position of the new sheet

removeSheet

public abstract void removeSheet(int index)
Removes the sheet at the specified index from this workbook
Parameters:
index -  

moveSheet

public abstract WritableSheet moveSheet(int fromIndex,
                                        int toIndex)
Moves the specified sheet within this workbook to another index position.
Parameters:
fromIndex - the zero based index of the required sheet
toIndex - the zero based index of the required sheet
Returns:
the sheet that has been moved

write

public abstract void write()
                    throws java.io.IOException
Writes out the data held in this workbook in Excel format

setProtected

public abstract void setProtected(boolean prot)
Indicates whether or not this workbook is protected
Parameters:
prot - Protected flag

setColourRGB

public abstract void setColourRGB(Colour c,
                                  int r,
                                  int g,
                                  int b)
Sets the RGB value for the specified colour for this workbook
Parameters:
c - the colour whose RGB value is to be overwritten
r - the red portion to set (0-255)
g - the green portion to set (0-255)
b - the blue portion to set (0-255)

copy

public void copy(Workbook w)
Deprecated. Copying now occurs implicitly as part of the overloaded factory method Workbook.createWorkbood

This method can be used to create a writable clone of some other workbook
Parameters:
w -