org.subtlelib.poi.api.sheet

Interface SheetContext

All Superinterfaces:

BlockCondition<SheetContext>, ColumnTotalsDataRangeSource, ConfigurationProvider, RowCondition<RowContext>, RowNavigation<SheetContext,RowContext>, SheetConfiguration<SheetContext>, StyleConfigurable<SheetContext>, StyleConfiguration

All Known Implementing Classes:

SheetContextImpl, SheetContextNoImpl

public interface SheetContext
extends RowNavigation<SheetContext,RowContext>, BlockCondition<SheetContext>, SheetConfiguration<SheetContext>, ConfigurationProvider, StyleConfiguration, StyleConfigurable<SheetContext>, ColumnTotalsDataRangeSource

Sheet context.

Author:

i.voshkulat

Method Summary

Modifier and Type	Method and Description
org.apache.poi.ss.usermodel.Sheet	getNativeSheet() Retrieve POI sheet referred to by current SheetContext Please refrain from using the exposed HSSFSheet directly unless you need functionality of POI not provided by SheetContext.
SheetContext	mergeCells(int startColumn, int endColumn) Merge cells of the current row starting from column number startColumn and ending with a column endColumn.

Methods inherited from interface org.subtlelib.poi.api.navigation.RowNavigation

currentRow, nextRow, skipRow, skipRows, stepOneRowBack

Methods inherited from interface org.subtlelib.poi.api.condition.RowCondition

nextConditionalRow

Methods inherited from interface org.subtlelib.poi.api.condition.BlockCondition

endConditionalBlock, startConditionalBlock

Methods inherited from interface org.subtlelib.poi.api.sheet.SheetConfiguration

fitOnPagesByHeight, fitOnPagesByWidth, hideGrid, setColumnWidth, setColumnWidths, setDefaultRowIndent

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

getConfiguration

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

Methods inherited from interface org.subtlelib.poi.api.totals.ColumnTotalsDataRangeSource

startColumnTotalsDataRangeFromNextRow

Method Detail

mergeCells

SheetContext mergeCells(int startColumn,
                        int endColumn)

Merge cells of the current row starting from column number startColumn and ending with a column endColumn. In most cases using RowContext.mergeCells(int) is supposed to be more convenient.

Parameters:

startColumn - index of the first column participating in a merged cell

endColumn - index of the last column participating in a merged cell

Returns:

this

getNativeSheet

org.apache.poi.ss.usermodel.Sheet getNativeSheet()

Retrieve POI sheet referred to by current SheetContext Please refrain from using the exposed HSSFSheet directly unless you need functionality of POI not provided by SheetContext.

Returns:

native POI HSSFSheet