org.subtlelib.poi.api.totals

Interface ColumnTotalsDataRange

All Known Implementing Classes:

ColumnTotalsDataRangeImpl

public interface ColumnTotalsDataRange

An instance of this interface represents the contiguous range of rows that can be used as a source for totals formula.

Data range is started when the instance is created, and ended when endOnCurrentRow() or endOnPreviousRow() called explicitly or when the object is used to render totals.

Created on 28/03/13

Author:

d.serdiuk

Method Summary

Modifier and Type	Method and Description
void	endOn(int rowOffset)
void	endOnCurrentRow() Mark the current row as the end of data range
void	endOnPreviousRow() Mark the row rendered before current one as the end of data range
int	getEndRowNo()
int	getStartRowNo()
boolean	isEndMarked()

Method Detail

endOnCurrentRow

void endOnCurrentRow()

Mark the current row as the end of data range

You can omit calling this method directly if the formula is generated on the line following the last line of the data range.

If you want to leave some lines between the data range and the formula that uses it, call this method when you finished writing your data.

See Also:

SupportsColumnTotalsRendering.setTotalsDataRange(ColumnTotalsDataRange)

getStartRowNo

int getStartRowNo()

Returns:

1-based line number that marks the start of the data range (line number corresponds to how it's shown in Excel)

getEndRowNo

int getEndRowNo()

Returns:

1-based line number that marks the end of the data range (line number corresponds to how it's shown in Excel)

isEndMarked

boolean isEndMarked()

Returns:

true if either endOnCurrentRow() or endOnPreviousRow() was called and therefore, calling either of these methods will produce an error (cannot mark the end twice)

endOnPreviousRow

void endOnPreviousRow()

Mark the row rendered before current one as the end of data range

endOn

void endOn(int rowOffset)

Parameters:

rowOffset - example values:

• = 0 equivalent to endOnCurrentRow()
• = -1 equivalent to endOnPreviousRow()