Package org.adempiere.base

Interface IGridTabExporter

All Known Implementing Classes:

GridTab2PackExporter, GridTabCSVExporter, GridTabExcelExporter, GridTabSQLInsertExporter, GridTabXLSXExporter

public interface IGridTabExporter

Interface to export data from GridTab

Author:

hengsin

Method Summary

Modifier and Type	Method	Description
void	export(GridTab gridTab, List<GridTab> childs, boolean isCurrentRowOnly, File file, int indxDetailSelected)	export gridTab data to file
String	getContentType()
String	getFileExtension()
String	getFileExtensionLabel()
String	getSuggestedFileName(GridTab gridTab)
default boolean	isAdvanced()
boolean	isExportableTab(GridTab childTab)	Check if exported support the export of a child tab
default boolean	isExportChildTabsForCurrentRowOnly()
default int	maxDeepOfChildTab()	Maximum deep of child tab supported by the exporter

Method Details

export

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

export gridTab data to file

Parameters:

gridTab -

childs -

isCurrentRowOnly -

file -

indxDetailSelected - index of selected child tab

getFileExtension

String getFileExtension()

Returns:

file extension (csv, zip, ect)

getFileExtensionLabel

String getFileExtensionLabel()

Returns:

label for file extension

getContentType

String getContentType()

Returns:

mime content type

getSuggestedFileName

String getSuggestedFileName(GridTab gridTab)

Returns:

suggested file name

isExportableTab

boolean isExportableTab(GridTab childTab)

Check if exported support the export of a child tab

Parameters:

childTab -

Returns:

true if export is supported, false otherwise

isAdvanced

default boolean isAdvanced()

Returns:

true if exporter is available to role with advanced access only

isExportChildTabsForCurrentRowOnly

default boolean isExportChildTabsForCurrentRowOnly()

Returns:

true if export of child tabs is supported only when current row only is on.

maxDeepOfChildTab

default int maxDeepOfChildTab()

Maximum deep of child tab supported by the exporter

Returns:

> 0 for maximum level of deep, <= 0 for unlimited level of deep