org.subtlelib.poi.impl.workbook

Class WorkbookContextImpl

java.lang.Object

org.subtlelib.poi.impl.style.InheritableStyleConfiguration<WorkbookContext>

org.subtlelib.poi.impl.workbook.WorkbookContextImpl

All Implemented Interfaces:

ConfigurationProvider, StyleConfigurable<WorkbookContext>, StyleConfiguration, StyleRegistry, WorkbookContext

public class WorkbookContextImpl
extends InheritableStyleConfiguration<WorkbookContext>
implements WorkbookContext

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WorkbookContextImpl(org.apache.poi.hssf.usermodel.HSSFWorkbook workbook, StyleConfiguration styleConfiguration, Configuration configuration)

Method Summary

Modifier and Type	Method and Description
SheetContext	createSheet(String sheetName) Create new sheet within the current workbook.
Configuration	getConfiguration() Get workbook wide configuration.
org.apache.poi.hssf.usermodel.HSSFCellStyle	registerStyle(Style style) Convert provided Style into POI style and register it with 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 class org.subtlelib.poi.impl.style.InheritableStyleConfiguration

getDateStyle, getHeaderStyle, getNumberStyle, getPercentageStyle, getStyleConfiguration, getTextStyle, getTotalStyle, setDateStyle, setHeaderStyle, setNumberStyle, setPercentageStyle, setStyleConfiguration, setTextStyle, setTotalStyle

Methods inherited from class java.lang.Object

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

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

Constructor Detail

WorkbookContextImpl

protected WorkbookContextImpl(org.apache.poi.hssf.usermodel.HSSFWorkbook workbook,
                              StyleConfiguration styleConfiguration,
                              Configuration configuration)

Method Detail

createSheet

public SheetContext createSheet(String sheetName)

Description copied from interface: WorkbookContext

Create new sheet within the current workbook.

Specified by:

createSheet in interface WorkbookContext

Parameters:

sheetName - sheet name

Returns:

created SheetContext

registerStyle

public org.apache.poi.hssf.usermodel.HSSFCellStyle registerStyle(Style style)

Description copied from interface: StyleRegistry

Convert provided Style into POI style and register it with current workbook. Resulting style can be assigned directly to a POI cell.

Specified by:

registerStyle in interface StyleRegistry

Parameters:

style - style to be converted and registered

Returns:

POI representation of the provided style

toNativeBytes

public byte[] toNativeBytes()

Description copied from interface: WorkbookContext

Create .xls file binary representation for current WorkbookContext

Specified by:

toNativeBytes in interface WorkbookContext

Returns:

excel file binary representation

toNativeWorkbook

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

Description copied from interface: WorkbookContext

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 WorkbookContext.toNativeBytes() instead.

Specified by:

toNativeWorkbook in interface WorkbookContext

Returns:

native POI HSSFWorkbook

getConfiguration

public Configuration getConfiguration()

Description copied from interface: ConfigurationProvider

Get workbook wide configuration.

Specified by:

getConfiguration in interface ConfigurationProvider

Returns:

configuration