org.subtlelib.poi.impl.row

Class RowContextImpl

java.lang.Object

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

org.subtlelib.poi.impl.row.AbstractDelegatingRowContext

org.subtlelib.poi.impl.row.RowContextImpl

All Implemented Interfaces:

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

public class RowContextImpl
extends AbstractDelegatingRowContext

Field Summary

Fields inherited from class org.subtlelib.poi.impl.row.AbstractDelegatingRowContext

sheet

Constructor Summary

Constructors

Constructor and Description
RowContextImpl(org.apache.poi.ss.usermodel.Row row, SheetContext sheet, StyleRegistry styleRegistry, int indent)

Method Summary

Modifier and Type	Method and Description
RowContext	cellAt(int newIndex) Place current cell pointer in the newIndex-th position in the row.
RowContext	conditionalCell(boolean condition) Make execution of the next cell conditional.
RowContext	date(Date date) Write mandatory date to the current cell.
RowContext	date(Date date, Style style) Write mandatory date to the current cell.
RowContext	date(com.google.common.base.Optional<Date> date)
RowContext	date(com.google.common.base.Optional<Date> date, Style style)
org.apache.poi.ss.usermodel.Row	getNativeRow() Retrieve POI row referred to by current RowContext.
RowContext	header(String text)
RowContext	mergeCells(int number) Merge cells of the current row starting from the current cell.
RowContext	multilineText(Collection<String> lines) Write mandatory multiline text to the current cell.
RowContext	multilineText(Collection<String> lines, Style style) Write mandatory multiline text to the current cell.
RowContext	number(Number number) Write mandatory number to the current cell.
RowContext	number(Number number, Style style) Write mandatory number to the current cell.
RowContext	number(com.google.common.base.Optional<? extends Number> number) Write optional number to the current cell.
RowContext	number(com.google.common.base.Optional<? extends Number> number, Style style) Write optional number to the current cell and apply style provided.
RowContext	percentage(Number number) Write mandatory percentage to the current cell.
RowContext	percentage(com.google.common.base.Optional<? extends Number> number)
RowContext	setColumnWidth(int width) Set width of the last output cell.
RowContext	setRowHeight(int height) Set height of the current row.
RowContext	setTotalsDataRange(ColumnTotalsDataRange data) The data range will be used to render totals.
RowContext	skipCell() Move current cell pointer to the next position.
RowContext	skipCells(int offset) Move current cell pointer by offset cells within the row.
RowContext	text(com.google.common.base.Optional<String> text) Write optional text to the current cell.
RowContext	text(com.google.common.base.Optional<String> text, Style style) Write optional text to the current cell and apply style provided.
RowContext	text(String text) Write mandatory text to the current cell.
RowContext	text(String text, Style style) Write mandatory text to the current cell.
RowContext	total(Formula formula)
RowContext	total(Formula formula, Style style)
RowContext	total(String text)
RowContext	totals(Formula formula, int times)
RowContext	totals(Formula formula, int times, Style style)

Methods inherited from class org.subtlelib.poi.impl.row.AbstractDelegatingRowContext

currentRow, nextConditionalRow, nextRow, skipRow, skipRows, 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

RowContextImpl

public RowContextImpl(org.apache.poi.ss.usermodel.Row row,
                      SheetContext sheet,
                      StyleRegistry styleRegistry,
                      int indent)

Method Detail

text

public RowContext text(String text)

Description copied from interface: PlainDataOutput

Write mandatory text to the current cell. Shift current cell pointer to the next position. Style as per StyleConfiguration.getTextStyle() on the current level is applied. For details of style configuration please see StyleConfiguration implementation used.

Parameters:

text - non-null string

Returns:

this

text

public RowContext text(String text,
                       Style style)

Description copied from interface: PlainDataOutput

Write mandatory text to the current cell. Shift current cell pointer to the next position. Style which is a product of merging/overwriting StyleConfiguration.getTextStyle() with a provided style is applied. For details of style configuration please see StyleConfiguration implementation used. For details of style merging see actual Style in use.

Parameters:

text - non-null string

style - style to be applied to the current cell on top of the predefined style

Returns:

this

text

public RowContext text(com.google.common.base.Optional<String> text)

Description copied from interface: PlainDataOutput

Write optional text to the current cell. Same as PlainDataOutput.text(String) but the value is optional.

Parameters:

text - for Present string - value is written, on Absent value the cell is skipped

Returns:

this

text

public RowContext text(com.google.common.base.Optional<String> text,
                       Style style)

Description copied from interface: PlainDataOutput

Write optional text to the current cell and apply style provided. Same as PlainDataOutput.text(String, Style) but the value is optional.

Parameters:

text - for Present string - value is written, on Absent value the cell is skipped

style - style to be applied to the current cell on top of the predefined style

Returns:

this

multilineText

public RowContext multilineText(Collection<String> lines)

Description copied from interface: PlainDataOutput

Write mandatory multiline text to the current cell. Shift current cell pointer to the next position. Style as per StyleConfiguration.getTextStyle() on the current level is applied. For details of style configuration please see StyleConfiguration implementation used.

Parameters:

lines - non-null collection of strings

Returns:

this

multilineText

public RowContext multilineText(Collection<String> lines,
                                Style style)

Description copied from interface: PlainDataOutput

Write mandatory multiline text to the current cell. Shift current cell pointer to the next position. Style which is a product of merging/overwriting StyleConfiguration.getTextStyle() with a provided style is applied. For details of style configuration please see StyleConfiguration implementation used. For details of style merging see actual Style in use.

Parameters:

lines - non-null collection of strings

style - style to be applied to the current cell on top of the predefined style

Returns:

this

number

public RowContext number(Number number)

Description copied from interface: PlainDataOutput

Write mandatory number to the current cell. Shift current cell pointer to the next position. Style as per StyleConfiguration.getNumberStyle() on the current level is applied. For details of style configuration please see StyleConfiguration implementation used.

Parameters:

number - non-null number

Returns:

this

number

public RowContext number(Number number,
                         Style style)

Description copied from interface: PlainDataOutput

Write mandatory number to the current cell. Shift current cell pointer to the next position. Style which is a product of merging/overwriting StyleConfiguration.getNumberStyle() with a provided style is applied. For details of style configuration please see StyleConfiguration implementation used. For details of style merging see actual Style in use.

Parameters:

number - non-null number

style - style to be applied to the current cell on top of the predefined style

Returns:

this

number

public RowContext number(com.google.common.base.Optional<? extends Number> number)

Description copied from interface: PlainDataOutput

Write optional number to the current cell. Same as PlainDataOutput.number(Number) but the value is optional.

Parameters:

number - Present value is written, on Absent value the cell is skipped

Returns:

this

number

public RowContext number(com.google.common.base.Optional<? extends Number> number,
                         Style style)

Description copied from interface: PlainDataOutput

Write optional number to the current cell and apply style provided. Same as PlainDataOutput.number(Number, Style) but the value is optional.

Parameters:

number - Present value is written, on Absent value the cell is skipped

style - style to be applied to the current cell on top of the predefined style

Returns:

this

date

public RowContext date(Date date)

Description copied from interface: PlainDataOutput

Write mandatory date to the current cell. Shift current cell pointer to the next position. Style as per StyleConfiguration.getDateStyle() on the current level is applied. For details of style configuration please see StyleConfiguration implementation used. For details of style merging see actual Style in use.

Parameters:

date - non-null date

Returns:

this

date

public RowContext date(Date date,
                       Style style)

Description copied from interface: PlainDataOutput

Write mandatory date to the current cell. Shift current cell pointer to the next position. Style which is a product of merging/overwriting StyleConfiguration.getDateStyle() with a provided style is applied. For details of style configuration please see StyleConfiguration implementation used. For details of style merging see actual Style in use.

Parameters:

date - non-null date

style - style to be applied to the current cell on top of the predefined style

Returns:

this

date

public RowContext date(com.google.common.base.Optional<Date> date)

date

public RowContext date(com.google.common.base.Optional<Date> date,
                       Style style)

total

public RowContext total(String text)

header

public RowContext header(String text)

percentage

public RowContext percentage(Number number)

Description copied from interface: FormattedDataOutput

Write mandatory percentage to the current cell. Shift current cell pointer to the next position. Value is an integer or decimal percentage, not the fraction of 1. Style as per StyleConfiguration.getPercentageStyle() on the current level is applied. For details of style configuration please see StyleConfiguration implementation used.

Parameters:

number - non-null percentage

Returns:

this

percentage

public RowContext percentage(com.google.common.base.Optional<? extends Number> number)

skipCell

public RowContext skipCell()

Description copied from interface: CellNavigation

Move current cell pointer to the next position.

Returns:

this

skipCells

public RowContext skipCells(int offset)

Description copied from interface: CellNavigation

Move current cell pointer by offset cells within the row.

Parameters:

offset - number of cells to move pointer by

Returns:

this

cellAt

public RowContext cellAt(int newIndex)

Description copied from interface: CellNavigation

Place current cell pointer in the newIndex-th position in the row. Subject to an additional shift as set by SheetConfiguration.setDefaultRowIndent(int). Therefore: absolute position = newIndex + page wide indentation

Parameters:

newIndex - new pointer absolute position

Returns:

this

conditionalCell

public RowContext conditionalCell(boolean condition)

Description copied from interface: CellCondition

Make execution of the next cell conditional. Execution will take place only if condition evaluates to true.

Parameters:

condition - execution condition

Returns:

this

setColumnWidth

public RowContext setColumnWidth(int width)

Description copied from interface: RowContext

Set width of the last output cell.

Sample: .nextRow() .text("Some column header").setColumnWidth(25)

Parameters:

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

Returns:

this

setRowHeight

public RowContext setRowHeight(int height)

Description copied from interface: RowContext

Set height of the current row. Subject to multiplication - see Configuration.getRowHeightBaseValue()

Parameters:

height - by default, in points (as in Excel row height dialog).

Returns:

this

mergeCells

public RowContext mergeCells(int number)

Description copied from interface: RowContext

Merge cells of the current row starting from the current cell.

Parameters:

number - total number of cells to merge (including the current one)

Returns:

this

getNativeRow

public org.apache.poi.ss.usermodel.Row getNativeRow()

Description copied from interface: RowContext

Retrieve POI row referred to by current RowContext. Please refrain from using the exposed HSSFRow directly unless you need functionality of POI not provided by RowContext.

Returns:

native POI HSSFRow

setTotalsDataRange

public RowContext setTotalsDataRange(ColumnTotalsDataRange data)

Description copied from interface: SupportsColumnTotalsRendering

The data range will be used to render totals. If the end of data range has not yet been marked, ColumnTotalsDataRange.endOnPreviousRow() method will be called

Parameters:

data - data range to be used for totals calculation

Returns:

this

total

public RowContext total(Formula formula)

total

public RowContext total(Formula formula,
                        Style style)

totals

public RowContext totals(Formula formula,
                         int times)

totals

public RowContext totals(Formula formula,
                         int times,
                         Style style)