Package org.adempiere.impexp

Class GridTabExcelExporter

java.lang.Object

org.adempiere.impexp.AbstractExcelExporter

org.adempiere.impexp.GridTabExcelExporter

All Implemented Interfaces:

IGridTabExporter

public class GridTabExcelExporter
extends AbstractExcelExporter
implements IGridTabExporter

Excel (XLS) Exporter Adapter for GridTab

Author:

Teo Sarca, www.arhipac.ro

FR [ 1943731 ] Window data export functionality

Field Summary

Fields inherited from class org.adempiere.impexp.AbstractExcelExporter

colSuppressRepeats, log, m_lang, m_workbook

Constructor Summary

Constructors

Constructor	Description
GridTabExcelExporter()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	export(GridTab gridTab, List<GridTab> childs, boolean currentRowOnly, File file, int indxDetailSelected)	export gridTab data to file
int	getColumnCount()	Get Columns Count
String	getContentType()
protected int	getCurrentRow()
int	getDisplayType(int row, int col)	Get cell display type (see DisplayType)
String	getFileExtension()
String	getFileExtensionLabel()
String	getHeaderName(int col)	Get column header name
int	getRowCount()	Get Rows Count
String	getSuggestedFileName(GridTab gridTab)
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
boolean	isExportableTab(GridTab gridTab)	Check if exported support the export of a child tab
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 void	setCurrentRow(int row)	Set current row

Methods inherited from class org.adempiere.impexp.AbstractExcelExporter

createHeaderFooter, createParameter, export, export, export, exportToWorkbook, formatPage, getCellFormat, getCtx, getFormCell, getFormRow, getLanguage, getNoOfParameter, isCurrentRowOnly, isForm, isSetFormRowPosition, isSuppressNull, isVisible, setCurrentRowOnly, setFreezePane, setNoOfParameter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.adempiere.base.IGridTabExporter

isAdvanced, isExportChildTabsForCurrentRowOnly, maxDeepOfChildTab

Constructor Details

GridTabExcelExporter

public GridTabExcelExporter()

Default constructor

Method Details

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

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

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

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

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

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

export

public void export(GridTab gridTab,
 List<GridTab> childs,
 boolean currentRowOnly,
 File file,
 int indxDetailSelected)

Description copied from interface: IGridTabExporter

export gridTab data to file

Specified by:

export in interface IGridTabExporter

indxDetailSelected - index of selected child tab

getFileExtension

public String getFileExtension()

Specified by:

getFileExtension in interface IGridTabExporter

Returns:

file extension (csv, zip, ect)

getFileExtensionLabel

public String getFileExtensionLabel()

Specified by:

getFileExtensionLabel in interface IGridTabExporter

Returns:

label for file extension

getContentType

public String getContentType()

Specified by:

getContentType in interface IGridTabExporter

Returns:

mime content type

getSuggestedFileName

public String getSuggestedFileName(GridTab gridTab)

Specified by:

getSuggestedFileName in interface IGridTabExporter

Returns:

suggested file name

isExportableTab

public boolean isExportableTab(GridTab gridTab)

Check if exported support the export of a child tab no detail tab is support to export with excel

Specified by:

isExportableTab in interface IGridTabExporter

Returns:

true if export is supported, false otherwise

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