org.subtlelib.poi.impl.sheet

Class SheetContextNoImpl

java.lang.Object

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

org.subtlelib.poi.impl.sheet.SheetContextNoImpl

All Implemented Interfaces:

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

public class SheetContextNoImpl
extends InheritableStyleConfiguration<SheetContext>
implements SheetContext

Constructor Summary

Constructors

Constructor and Description
SheetContextNoImpl(SheetContext parent, WorkbookContext workbook)

Method Summary

Modifier and Type	Method and Description
RowContext	currentRow() Retrieve current row, i.e.
SheetContext	endConditionalBlock() Designates end of a conditional block.
SheetContext	fitOnPagesByHeight(int pages)
SheetContext	fitOnPagesByWidth(int pages)
Configuration	getConfiguration() Get workbook wide configuration.
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	hideGrid() Hide grid lines for current sheet.
SheetContext	mergeCells(int startColumn, int endColumn) Merge cells of the current row starting from column number startColumn and ending with a column endColumn.
RowContext	nextConditionalRow(boolean condition) Create row in current position within the sheet and process all the configurations on it only if condition evaluates to true.
RowContext	nextRow() Create subsequent row and place current row pointer on it.
SheetContext	setColumnWidth(int columnNumber, int width) Set column width.
SheetContext	setColumnWidths(int... multipliers) Set widths for subsequent columns starting from the first one.
SheetContext	setDefaultRowIndent(int indent) Set sheet-wide indentation.
SheetContext	skipRow() Move current row pointer to the next position within the sheet.
SheetContext	skipRows(int offset) Move current row pointer by offset rows within the sheet.
ColumnTotalsDataRange	startColumnTotalsDataRangeFromNextRow()
SheetContext	startConditionalBlock(boolean condition) Demarcates start of a conditional block and defines execution condition.
SheetContext	stepOneRowBack()

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

SheetContextNoImpl

public SheetContextNoImpl(SheetContext parent,
                          WorkbookContext workbook)

Method Detail

nextRow

public RowContext nextRow()

Description copied from interface: RowNavigation

Create subsequent row and place current row pointer on it.

Specified by:

nextRow in interface RowNavigation<SheetContext,RowContext>

Returns:

created row

nextConditionalRow

public RowContext nextConditionalRow(boolean condition)

Description copied from interface: RowCondition

Create row in current position within the sheet and process all the configurations on it only if condition evaluates to true.

Specified by:

nextConditionalRow in interface RowCondition<RowContext>

Parameters:

condition - execution condition

Returns:

this

currentRow

public RowContext currentRow()

Description copied from interface: RowNavigation

Retrieve current row, i.e. last row created (see RowNavigation.nextRow() and RowCondition.nextConditionalRow(boolean)) within current sheet. Is not affected by RowNavigation.skipRow() or RowNavigation.skipRows(int).

Specified by:

currentRow in interface RowNavigation<SheetContext,RowContext>

Returns:

current row RowContext

skipRow

public SheetContext skipRow()

Description copied from interface: RowNavigation

Move current row pointer to the next position within the sheet. Doesn't involve actual row creation but just the position in which the next row will be created with RowNavigation.nextRow() or RowCondition.nextConditionalRow(boolean).

Specified by:

skipRow in interface RowNavigation<SheetContext,RowContext>

Returns:

current sheet SheetContext

skipRows

public SheetContext skipRows(int offset)

Description copied from interface: RowNavigation

Move current row pointer by offset rows within the sheet. Doesn't involve actual row creation but just the position in which the next row will be created with RowNavigation.nextRow() or RowCondition.nextConditionalRow(boolean).

Specified by:

skipRows in interface RowNavigation<SheetContext,RowContext>

Parameters:

offset - number of rows to move pointer by

Returns:

current sheet SheetContext

stepOneRowBack

public SheetContext stepOneRowBack()

Specified by:

stepOneRowBack in interface RowNavigation<SheetContext,RowContext>

startConditionalBlock

public SheetContext startConditionalBlock(boolean condition)

Description copied from interface: BlockCondition

Demarcates start of a conditional block and defines execution condition. Block is executed only if condition evaluates to true.

Specified by:

startConditionalBlock in interface BlockCondition<SheetContext>

Parameters:

condition - execution condition

Returns:

this

endConditionalBlock

public SheetContext endConditionalBlock()

Description copied from interface: BlockCondition

Designates end of a conditional block.

Specified by:

endConditionalBlock in interface BlockCondition<SheetContext>

Returns:

this

getNativeSheet

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

Description copied from interface: SheetContext

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.

Specified by:

getNativeSheet in interface SheetContext

Returns:

native POI HSSFSheet

setColumnWidth

public SheetContext setColumnWidth(int columnNumber,
                                   int width)

Description copied from interface: SheetConfiguration

Set column width.

Specified by:

setColumnWidth in interface SheetConfiguration<SheetContext>

Parameters:

columnNumber - index of the column to set width for

width - width in units, subject to multiplication - see Configuration.getColumnWidthBaseValue()

Returns:

this

setColumnWidths

public SheetContext setColumnWidths(int... multipliers)

Description copied from interface: SheetConfiguration

Set widths for subsequent columns starting from the first one.

Specified by:

setColumnWidths in interface SheetConfiguration<SheetContext>

Parameters:

multipliers - each width in units, subject to multiplication - see Configuration.getColumnWidthBaseValue()

Returns:

this

mergeCells

public SheetContext mergeCells(int startColumn,
                               int endColumn)

Description copied from interface: SheetContext

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.

Specified by:

mergeCells in interface SheetContext

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

hideGrid

public SheetContext hideGrid()

Description copied from interface: SheetConfiguration

Hide grid lines for current sheet.

Specified by:

hideGrid in interface SheetConfiguration<SheetContext>

Returns:

this

setDefaultRowIndent

public SheetContext setDefaultRowIndent(int indent)

Description copied from interface: SheetConfiguration

Set sheet-wide indentation. Defines initial position of current cell pointer on a newly created RowContext which in due order affects all the cell navigation and output operations. Shifts position set by CellNavigation.cellAt(int). Default: 0.

Specified by:

setDefaultRowIndent in interface SheetConfiguration<SheetContext>

Parameters:

indent - indentation in number of cells

Returns:

this

fitOnPagesByWidth

public SheetContext fitOnPagesByWidth(int pages)

Specified by:

fitOnPagesByWidth in interface SheetConfiguration<SheetContext>

fitOnPagesByHeight

public SheetContext fitOnPagesByHeight(int pages)

Specified by:

fitOnPagesByHeight in interface SheetConfiguration<SheetContext>

getConfiguration

public Configuration getConfiguration()

Description copied from interface: ConfigurationProvider

Get workbook wide configuration.

Specified by:

getConfiguration in interface ConfigurationProvider

Returns:

configuration

startColumnTotalsDataRangeFromNextRow

public ColumnTotalsDataRange startColumnTotalsDataRangeFromNextRow()

Specified by:

startColumnTotalsDataRangeFromNextRow in interface ColumnTotalsDataRangeSource