Package com.hybris.backoffice.excel.exporting

Class HideUtilitySheetsDecorator

java.lang.Object

com.hybris.backoffice.excel.exporting.HideUtilitySheetsDecorator

All Implemented Interfaces:

ExcelExportWorkbookDecorator, org.springframework.core.Ordered

public class HideUtilitySheetsDecorator
extends java.lang.Object
implements ExcelExportWorkbookDecorator

Hides ExcelTemplateConstants.UtilitySheets passed to decorator using setUtilitySheets(Collection). The hidden level can be configured using "backoffice.excel.utility.sheets.hidden" - passing true won't allow to unhide hidden sheet of excel file.

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
HideUtilitySheetsDecorator()

Method Summary

Modifier and Type	Method	Description
protected void	activateFirstNonUtilitySheet(org.apache.poi.ss.usermodel.Workbook workbook)
void	decorate(ExcelExportResult excelExportResult)	Decorates exported Workbook object.
int	getOrder()
protected org.apache.poi.ss.usermodel.SheetVisibility	getUtilitySheetHiddenLevel()
protected void	hideUtilitySheet(org.apache.poi.ss.usermodel.Workbook workbook, java.lang.String sheetName)
void	setUtilitySheets(java.util.Collection<ExcelTemplateConstants.UtilitySheet> utilitySheets)

Methods inherited from class java.lang.Object

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

Constructor Detail

HideUtilitySheetsDecorator

public HideUtilitySheetsDecorator()

Method Detail

decorate

public void decorate(ExcelExportResult excelExportResult)

Description copied from interface: ExcelExportWorkbookDecorator

Decorates exported Workbook object.

Specified by:

decorate in interface ExcelExportWorkbookDecorator

Parameters:

excelExportResult - - export result which contains exported workbook, list of selected items, list of selected attributes and list of additional attributes

hideUtilitySheet

protected void hideUtilitySheet(org.apache.poi.ss.usermodel.Workbook workbook,
                                java.lang.String sheetName)

getUtilitySheetHiddenLevel

protected org.apache.poi.ss.usermodel.SheetVisibility getUtilitySheetHiddenLevel()

activateFirstNonUtilitySheet

protected void activateFirstNonUtilitySheet(org.apache.poi.ss.usermodel.Workbook workbook)

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

setUtilitySheets

public void setUtilitySheets(java.util.Collection<ExcelTemplateConstants.UtilitySheet> utilitySheets)