org.subtlelib.poi.impl.row

Class AbstractDelegatingRowContext

java.lang.Object

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

org.subtlelib.poi.impl.row.AbstractDelegatingRowContext

All Implemented Interfaces:

CellCondition<RowContext>, RowCondition<RowContext>, CellNavigation<RowContext>, RowNavigation<SheetContext,RowContext>, FormattedDataOutput, PlainDataOutput, RowContext, StyleConfigurable<RowContext>, StyleConfiguration, SupportsColumnTotalsRendering<RowContext>

Direct Known Subclasses:

RowContextImpl, RowContextNoImpl

public abstract class AbstractDelegatingRowContext
extends InheritableStyleConfiguration<RowContext>
implements RowContext

Field Summary

Fields

Modifier and Type	Field and Description
protected SheetContext	sheet

Constructor Summary

Constructors

Constructor and Description
AbstractDelegatingRowContext(SheetContext sheet)

Method Summary

Modifier and Type	Method and Description
RowContext	currentRow() Retrieve current row, i.e.
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	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.
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.row.RowContext

getNativeRow, mergeCells, setColumnWidth, setRowHeight

Methods inherited from interface org.subtlelib.poi.api.row.PlainDataOutput

date, date, date, date, multilineText, multilineText, number, number, number, number, text, text, text, text

Methods inherited from interface org.subtlelib.poi.api.row.FormattedDataOutput

header, percentage, percentage, total

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

cellAt, skipCell, skipCells

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

conditionalCell

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.SupportsColumnTotalsRendering

setTotalsDataRange, total, total, totals, totals

Field Detail

sheet

protected final SheetContext sheet

Constructor Detail

AbstractDelegatingRowContext

public AbstractDelegatingRowContext(SheetContext sheet)

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

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

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

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>