org.subtlelib.poi.api.workbook

Interface WorkbookContext

All Superinterfaces:

ConfigurationProvider, StyleConfigurable<WorkbookContext>, StyleConfiguration, StyleRegistry

All Known Implementing Classes:

WorkbookContextImpl

public interface WorkbookContext
extends ConfigurationProvider, StyleRegistry, StyleConfiguration, StyleConfigurable<WorkbookContext>

Workbook context.

Author:

i.voshkulat

Method Summary

Modifier and Type	Method and Description
SheetContext	createSheet(String sheetName) Create new sheet within the current workbook.
byte[]	toNativeBytes() Create .xls file binary representation for current WorkbookContext
org.apache.poi.hssf.usermodel.HSSFWorkbook	toNativeWorkbook() Retrieve POI workbook referred to by current WorkbookContext.

Methods inherited from interface org.subtlelib.poi.api.configuration.ConfigurationProvider

getConfiguration

Methods inherited from interface org.subtlelib.poi.api.style.StyleRegistry

registerStyle

Methods inherited from interface org.subtlelib.poi.api.style.StyleConfiguration

getDateStyle, getHeaderStyle, getNumberStyle, getPercentageStyle, getTextStyle, getTotalStyle

Methods inherited from interface org.subtlelib.poi.api.style.StyleConfigurable

getStyleConfiguration, setDateStyle, setHeaderStyle, setNumberStyle, setPercentageStyle, setStyleConfiguration, setTextStyle, setTotalStyle

Method Detail

createSheet

SheetContext createSheet(String sheetName)

Create new sheet within the current workbook.

Parameters:

sheetName - sheet name

Returns:

created SheetContext

toNativeWorkbook

org.apache.poi.hssf.usermodel.HSSFWorkbook toNativeWorkbook()

Retrieve POI workbook referred to by current WorkbookContext. Please refrain from using the exposed HSSFWorkbook directly unless you need functionality of POI not provided by WorkbookContext. To retrieve a workbook for saving to a file look at toNativeBytes() instead.

Returns:

native POI HSSFWorkbook

toNativeBytes

byte[] toNativeBytes()

Create .xls file binary representation for current WorkbookContext

Returns:

excel file binary representation