Package org.adempiere.print.export

Class PrintDataExcelExporter

java.lang.Object

org.adempiere.impexp.AbstractExcelExporter

org.adempiere.print.export.PrintDataExcelExporter

public class PrintDataExcelExporter
extends AbstractExcelExporter

Export PrintData to Excel (XLS) file

Author:

Teo Sarca, SC ARHIPAC SERVICE SRL

BF [ 1939010 ] Excel Export ERROR - java.sql.Date - integrated Mario Grigioni's fix

BF [ 1974309 ] Exporting a report to XLS is not setting page format

Field Summary

Fields inherited from class org.adempiere.impexp.AbstractExcelExporter

colSuppressRepeats, log, m_lang, m_workbook

Constructor Summary

Constructors

Constructor	Description
PrintDataExcelExporter(PrintData printData, MPrintFormat printFormat)
PrintDataExcelExporter(PrintData printData, MPrintFormat printFormat, Map<MPrintFormatItem,PrintData> childPrintFormatDetails, Boolean[] colSuppressRepeats)
PrintDataExcelExporter(PrintData printData, MPrintFormat printFormat, Map<MPrintFormatItem,PrintData> childPrintFormatDetails, Boolean[] colSuppressRepeats, MQuery query)

Method Summary

Modifier and Type	Method	Description
protected void	createParameter(org.apache.poi.hssf.usermodel.HSSFSheet sheet)
protected void	export(OutputStream out)	Export to given stream
protected void	formatPage(org.apache.poi.hssf.usermodel.HSSFSheet sheet)
protected String	getCellFormat(int row, int col)
int	getColumnCount()	Get Columns Count
protected int	getCurrentRow()
int	getDisplayType(int row, int col)	Get cell display type (see DisplayType)
protected org.apache.poi.hssf.usermodel.HSSFCell	getFormCell(org.apache.poi.hssf.usermodel.HSSFRow row, int colnum)	get cell for column. use for form layout
protected org.apache.poi.hssf.usermodel.HSSFRow	getFormRow(org.apache.poi.hssf.usermodel.HSSFSheet sheet, int colnum)	get row for column. use for form layout
String	getHeaderName(int col)	Get column header name
int	getRowCount()	Get Rows Count
Object	getValueAt(int row, int col)	Get cell value
boolean	isColumnPrinted(int col)	Check if column is printed (displayed)
boolean	isDisplayed(int row, int col)	Check if there is a display logic
protected boolean	isForm()
boolean	isFunctionRow()	Is the current Row a Function Row
boolean	isPageBreak(int row, int col)	Check if there is a page break on given cell
protected boolean	isSetFormRowPosition(int col)
protected boolean	isSuppressNull(int col)
protected boolean	isVisible(int row, int col)
protected void	setCurrentRow(int row)	Set current row

Methods inherited from class org.adempiere.impexp.AbstractExcelExporter

createHeaderFooter, export, export, exportToWorkbook, getCtx, getLanguage, getNoOfParameter, isCurrentRowOnly, setCurrentRowOnly, setFreezePane, setNoOfParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

PrintDataExcelExporter

public PrintDataExcelExporter(PrintData printData,
                              MPrintFormat printFormat)

PrintDataExcelExporter

public PrintDataExcelExporter(PrintData printData,
                              MPrintFormat printFormat,
                              Map<MPrintFormatItem,PrintData> childPrintFormatDetails,
                              Boolean[] colSuppressRepeats)

PrintDataExcelExporter

public PrintDataExcelExporter(PrintData printData,
                              MPrintFormat printFormat,
                              Map<MPrintFormatItem,PrintData> childPrintFormatDetails,
                              Boolean[] colSuppressRepeats,
                              MQuery query)

Method Detail

getColumnCount

public int getColumnCount()

Description copied from class: AbstractExcelExporter

Get Columns Count

Specified by:

getColumnCount in class AbstractExcelExporter

Returns:

number of columns

getDisplayType

public int getDisplayType(int row,
                          int col)

Description copied from class: AbstractExcelExporter

Get cell display type (see DisplayType)

Specified by:

getDisplayType in class AbstractExcelExporter

Parameters:

row - row index

col - column index

Returns:

display type

getValueAt

public Object getValueAt(int row,
                         int col)

Description copied from class: AbstractExcelExporter

Get cell value

Specified by:

getValueAt in class AbstractExcelExporter

Parameters:

row - row index

col - column index

Returns:

cell value

getHeaderName

public String getHeaderName(int col)

Description copied from class: AbstractExcelExporter

Get column header name

Specified by:

getHeaderName in class AbstractExcelExporter

Parameters:

col - column index

Returns:

header name

getRowCount

public int getRowCount()

Description copied from class: AbstractExcelExporter

Get Rows Count

Specified by:

getRowCount in class AbstractExcelExporter

Returns:

number of rows

isColumnPrinted

public boolean isColumnPrinted(int col)

Description copied from class: AbstractExcelExporter

Check if column is printed (displayed)

Specified by:

isColumnPrinted in class AbstractExcelExporter

Parameters:

col - column index

Returns:

true if is visible

isPageBreak

public boolean isPageBreak(int row,
                           int col)

Description copied from class: AbstractExcelExporter

Check if there is a page break on given cell

Specified by:

isPageBreak in class AbstractExcelExporter

Parameters:

row - row index

col - column index

Returns:

true if there is a page break

setCurrentRow

protected void setCurrentRow(int row)

Description copied from class: AbstractExcelExporter

Set current row

Specified by:

setCurrentRow in class AbstractExcelExporter

Parameters:

row - row index

getCurrentRow

protected int getCurrentRow()

Specified by:

getCurrentRow in class AbstractExcelExporter

Returns:

current row index

isFunctionRow

public boolean isFunctionRow()

Description copied from class: AbstractExcelExporter

Is the current Row a Function Row

Specified by:

isFunctionRow in class AbstractExcelExporter

Returns:

true if function row

formatPage

protected void formatPage(org.apache.poi.hssf.usermodel.HSSFSheet sheet)

Overrides:

formatPage in class AbstractExcelExporter

getCellFormat

protected String getCellFormat(int row,
                               int col)

Overrides:

getCellFormat in class AbstractExcelExporter

export

protected void export(OutputStream out)
               throws Exception

Description copied from class: AbstractExcelExporter

Export to given stream

Overrides:

export in class AbstractExcelExporter

Throws:

Exception

createParameter

protected void createParameter(org.apache.poi.hssf.usermodel.HSSFSheet sheet)

Overrides:

createParameter in class AbstractExcelExporter

isForm

protected boolean isForm()

Overrides:

isForm in class AbstractExcelExporter

Returns:

true if it is form layout

getFormCell

protected org.apache.poi.hssf.usermodel.HSSFCell getFormCell(org.apache.poi.hssf.usermodel.HSSFRow row,
                                                             int colnum)

Description copied from class: AbstractExcelExporter

get cell for column. use for form layout

Overrides:

getFormCell in class AbstractExcelExporter

Returns:

cell for column

getFormRow

protected org.apache.poi.hssf.usermodel.HSSFRow getFormRow(org.apache.poi.hssf.usermodel.HSSFSheet sheet,
                                                           int colnum)

Description copied from class: AbstractExcelExporter

get row for column. use for form layout

Overrides:

getFormRow in class AbstractExcelExporter

Returns:

row for column

isSetFormRowPosition

protected boolean isSetFormRowPosition(int col)

Overrides:

isSetFormRowPosition in class AbstractExcelExporter

Returns:

true if column is use to set new row position

isSuppressNull

protected boolean isSuppressNull(int col)

Overrides:

isSuppressNull in class AbstractExcelExporter

Returns:

true if column should be hidden when it is null

isVisible

protected boolean isVisible(int row,
                            int col)

Overrides:

isVisible in class AbstractExcelExporter

Returns:

true if column is visible

isDisplayed

public boolean isDisplayed(int row,
                           int col)

Description copied from class: AbstractExcelExporter

Check if there is a display logic

Specified by:

isDisplayed in class AbstractExcelExporter

Parameters:

row - row index

col - column index

Returns:

true if there is no logic or evaluate logic specified in print item