org.subtlelib.poi.api.row

Interface RowContext

All Superinterfaces:

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

All Known Implementing Classes:

AbstractDelegatingRowContext, RowContextImpl, RowContextNoImpl

public interface RowContext
extends PlainDataOutput, FormattedDataOutput, CellNavigation<RowContext>, CellCondition<RowContext>, RowNavigation<SheetContext,RowContext>, StyleConfiguration, StyleConfigurable<RowContext>, SupportsColumnTotalsRendering<RowContext>

Row context.

Author:

i.voshkulat

Method Summary

Modifier and Type	Method and Description
org.apache.poi.ss.usermodel.Row	getNativeRow() Retrieve POI row referred to by current RowContext.
RowContext	mergeCells(int number) Merge cells of the current row starting from the current cell.
RowContext	setColumnWidth(int width) Set width of the last output cell.
RowContext	setRowHeight(int height) Set height of the current row.

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

Method Detail

setColumnWidth

RowContext setColumnWidth(int width)

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

RowContext setRowHeight(int height)

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

RowContext mergeCells(int number)

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

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

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