JIDE 3.5.15

com.jidesoft.hssf
Class HssfAggregateTablePaneUtils

java.lang.Object
  extended by com.jidesoft.hssf.HssfAggregateTableUtils
      extended by com.jidesoft.hssf.HssfAggregateTablePaneUtils

Deprecated. replaced by HssfTableScrollPaneUtils

@Deprecated
public class HssfAggregateTablePaneUtils
extends HssfAggregateTableUtils

HssfAggregateTablePaneUtils is a class that has methods to export AggregateTablePane to Excel file format using POI.

Please set the client property HssfTableUtils.CLIENT_PROPERTY_EXCEL_OUTPUT_FORMAT for the target AggregateTablePane before you invoke this method so that you can choose the output format. If you didn't set the client property, we will use office2003 format for backward compatibility concern.


Constructor Summary
HssfAggregateTablePaneUtils()
          Deprecated.  
 
Method Summary
static boolean export(AggregateTablePane tablePane, OutputStream out, String sheetName)
          Deprecated. Exports the AggregateTablePane to Excel file as an output steam.
static boolean export(AggregateTablePane tablePane, OutputStream out, String sheetName, HssfTableUtils.CellValueConverter converter)
          Deprecated. Exports the AggregateTablePane to Excel file.
static boolean export(AggregateTablePane tablePane, String fileName, String sheetName, boolean append)
          Deprecated. Exports the AggregateTablePane to Excel file.
static boolean export(AggregateTablePane tablePane, String fileName, String sheetName, boolean append, HssfTableUtils.CellValueConverter converter)
          Deprecated. Exports the AggregateTablePane to Excel file.
 
Methods inherited from class com.jidesoft.hssf.HssfAggregateTableUtils
export, export, export, export, export, export, export, export, export, exportToCell, exportToSheet, exportToSheet, exportToSheet, exportToSheet, exportToSheet, exportToSheet, exportToSheet, exportToSheet, isHssfInstalled
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HssfAggregateTablePaneUtils

public HssfAggregateTablePaneUtils()
Deprecated. 
Method Detail

export

public static boolean export(AggregateTablePane tablePane,
                             String fileName,
                             String sheetName,
                             boolean append)
                      throws IOException
Deprecated. 
Exports the AggregateTablePane to Excel file.

Parameters:
tablePane - the AggregateTablePane.
fileName - the Excel file name. It should be the full path to the file.
sheetName - the worksheet name.
append - whether it appends to the existing Excel file or it creates a new Excel file.
Returns:
true if exporting succeed. If hssf.jar is not in the classpath, false will be returned. Exception will be thrown if there is error during the exporting.
Throws:
IOException - if if an I/O error occurs when writing to the file.

export

public static boolean export(AggregateTablePane tablePane,
                             String fileName,
                             String sheetName,
                             boolean append,
                             HssfTableUtils.CellValueConverter converter)
                      throws IOException
Deprecated. 
Exports the AggregateTablePane to Excel file.

Parameters:
tablePane - the AggregateTablePane.
fileName - the Excel file name. It should be the full path to the file.
sheetName - the worksheet name.
append - whether it appends to the existing Excel file or it creates a new Excel file.
converter - the converter to converts cell value to the value that can be set to Excel cell. Please note, this converter is only used to convert the cell in the data area, not any cells in row header or column header area.
Returns:
true if exporting succeed. If hssf.jar is not in the classpath, false will be returned. Exception will be thrown if there is error during the exporting.
Throws:
IOException - if if an I/O error occurs when writing to the file.

export

public static boolean export(AggregateTablePane tablePane,
                             OutputStream out,
                             String sheetName)
                      throws IOException
Deprecated. 
Exports the AggregateTablePane to Excel file as an output steam.

Parameters:
tablePane - the AggregateTablePane.
out - the output stream
sheetName - the worksheet name.
Returns:
true if exporting succeed. If hssf.jar is not in the classpath, false will be returned. Exception will be thrown if there is error during the exporting.
Throws:
IOException - if if an I/O error occurs when writing to the OutputStream.

export

public static boolean export(AggregateTablePane tablePane,
                             OutputStream out,
                             String sheetName,
                             HssfTableUtils.CellValueConverter converter)
                      throws IOException
Deprecated. 
Exports the AggregateTablePane to Excel file.

Parameters:
tablePane - the AggregateTablePane.
out - the output stream
sheetName - the worksheet name.
converter - the converter to converts cell value to the value that can be set to Excel cell. Please note, this converter is only used to convert the cell in the data area, not any cells in row header or column header area.
Returns:
true if exporting succeed. If hssf.jar is not in the classpath, false will be returned. Exception will be thrown if there is error during the exporting.
Throws:
IOException - if if an I/O error occurs when writing to the OutputStream.

JIDE 3.5.15