icy.util

Class XLSUtil

java.lang.Object

icy.util.XLSUtil

public class XLSUtil
extends java.lang.Object

XLS (excel) utilities class (create and write XLS documents).
IMPORTANT NOTE: this class only handles basic XLS file, for XLSX files (XML excel) you need to use the Workbooks plugin (Alexandre Dufour)

Author:

Stephane

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILE_DOT_EXTENSION
static java.lang.String	FILE_EXTENSION

Constructor Summary

Constructors

Constructor and Description
XLSUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	addImage(jxl.write.WritableSheet sheet, jxl.write.WritableImage image) Adds an image to the specified Sheet.
static void	clear(jxl.write.WritableWorkbook workbook) Clear the specified workbook (remove all pages).
static void	clearPage(jxl.write.WritableSheet sheet, java.lang.String name) Clear the specified page (remove all rows)
static jxl.write.WritableSheet	createNewPage(jxl.write.WritableWorkbook workbook, java.lang.String title) Creates and returns a new page for the specified workbook.
static jxl.write.WritableWorkbook	createWorkbook(java.io.File file) Creates and returns a new Workbook file.
static jxl.write.WritableWorkbook	createWorkbook(java.lang.String filename) Creates and returns a new Workbook file.
static jxl.write.WritableSheet	getPage(jxl.write.WritableWorkbook workbook, java.lang.String title) Searches for the specified page in workbook and returns it.
static jxl.write.WritableWorkbook	loadWorkbook(java.io.File file) Deprecated. Use loadWorkbookForRead(File) or loadWorkbookForWrite(File) depending your needs.
static jxl.Workbook	loadWorkbookForRead(java.io.File file) Loads and returns Workbook from an existing file (read operation only)
static jxl.write.WritableWorkbook	loadWorkbookForWrite(java.io.File file) Loads and returns Workbook from an existing file (for write operation).
static void	saveAndClose(jxl.write.WritableWorkbook workbook) Saves and closes the specified Workbook.
static boolean	setCellNumber(jxl.write.WritableSheet sheet, int x, int y, double value) Sets cell content in double format of specified Sheet.
static boolean	setCellNumber(jxl.write.WritableSheet sheet, int x, int y, double value, jxl.format.Colour background) Sets cell content in double format of specified Sheet.
static boolean	setCellString(jxl.write.WritableSheet sheet, int x, int y, java.lang.String value) Sets cell content in string format of specified Sheet.
static boolean	setCellString(jxl.write.WritableSheet sheet, int x, int y, java.lang.String value, jxl.format.Colour background) Sets cell content in string format of specified Sheet.
static boolean	setFromCSV(jxl.write.WritableSheet sheet, java.lang.String csvContent) Fill sheet content from CSV text.
static void	setPageName(jxl.write.WritableSheet sheet, java.lang.String name) Sets name of specified Sheet

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FILE_EXTENSION

public static final java.lang.String FILE_EXTENSION

See Also:

Constant Field Values

FILE_DOT_EXTENSION

public static final java.lang.String FILE_DOT_EXTENSION

See Also:

Constant Field Values

Constructor Detail

XLSUtil

public XLSUtil()

Method Detail

createWorkbook

public static jxl.write.WritableWorkbook createWorkbook(java.io.File file)
                                                 throws java.io.IOException

Creates and returns a new Workbook file.
Previous existing file is overwritten.

Throws:

java.io.IOException

createWorkbook

public static jxl.write.WritableWorkbook createWorkbook(java.lang.String filename)
                                                 throws java.io.IOException

Creates and returns a new Workbook file.
Previous existing file is overwritten.

Throws:

java.io.IOException

loadWorkbookForRead

public static jxl.Workbook loadWorkbookForRead(java.io.File file)
                                        throws java.io.IOException,
                                               jxl.read.biff.BiffException

Loads and returns Workbook from an existing file (read operation only)

Throws:

java.io.IOException

jxl.read.biff.BiffException

loadWorkbookForWrite

public static jxl.write.WritableWorkbook loadWorkbookForWrite(java.io.File file)
                                                       throws java.io.IOException,
                                                              jxl.read.biff.BiffException

Loads and returns Workbook from an existing file (for write operation).
If the file does not exist a new empty Workbook is returned.

WARNING: don't forget to end by saveAndClose(WritableWorkbook) even if you don't change the Workbook else you lost all previous data already present.

Throws:

java.io.IOException

jxl.read.biff.BiffException

loadWorkbook

@Deprecated
public static jxl.write.WritableWorkbook loadWorkbook(java.io.File file)
                                               throws java.io.IOException,
                                                      jxl.read.biff.BiffException

Deprecated. Use loadWorkbookForRead(File) or loadWorkbookForWrite(File) depending your needs.

Throws:

java.io.IOException

jxl.read.biff.BiffException

saveAndClose

public static void saveAndClose(jxl.write.WritableWorkbook workbook)
                         throws java.io.IOException,
                                jxl.write.WriteException

Saves and closes the specified Workbook.

Throws:

java.io.IOException

jxl.write.WriteException

getPage

public static jxl.write.WritableSheet getPage(jxl.write.WritableWorkbook workbook,
                              java.lang.String title)

Searches for the specified page in workbook and returns it.
If the page does not exists it creates and returns a new page.

See Also:

createNewPage(WritableWorkbook, String)

createNewPage

public static jxl.write.WritableSheet createNewPage(jxl.write.WritableWorkbook workbook,
                                    java.lang.String title)

Creates and returns a new page for the specified workbook.
If the page already exists, add an incremented number for distinction.

See Also:

getPage(WritableWorkbook, String)

clear

public static void clear(jxl.write.WritableWorkbook workbook)

Clear the specified workbook (remove all pages).

clearPage

public static void clearPage(jxl.write.WritableSheet sheet,
             java.lang.String name)

Clear the specified page (remove all rows)

setPageName

public static void setPageName(jxl.write.WritableSheet sheet,
               java.lang.String name)

Sets name of specified Sheet

addImage

public static boolean addImage(jxl.write.WritableSheet sheet,
               jxl.write.WritableImage image)

Adds an image to the specified Sheet.
Returns false if the operation failed.

setCellString

public static boolean setCellString(jxl.write.WritableSheet sheet,
                    int x,
                    int y,
                    java.lang.String value,
                    jxl.format.Colour background)

Sets cell content in string format of specified Sheet.
Returns false if the operation failed.

setCellString

public static boolean setCellString(jxl.write.WritableSheet sheet,
                    int x,
                    int y,
                    java.lang.String value)

Sets cell content in string format of specified Sheet.
Returns false if the operation failed.

setCellNumber

public static boolean setCellNumber(jxl.write.WritableSheet sheet,
                    int x,
                    int y,
                    double value,
                    jxl.format.Colour background)

Sets cell content in double format of specified Sheet.
Returns false if the operation failed.

setCellNumber

public static boolean setCellNumber(jxl.write.WritableSheet sheet,
                    int x,
                    int y,
                    double value)

Sets cell content in double format of specified Sheet.
Returns false if the operation failed.

setFromCSV

public static boolean setFromCSV(jxl.write.WritableSheet sheet,
                 java.lang.String csvContent)

Fill sheet content from CSV text.

Returns:

true if the operation succeed