org.subtlelib.poi.impl.totals

Class ColumnTotalsDataRangeImpl

java.lang.Object

org.subtlelib.poi.impl.totals.ColumnTotalsDataRangeImpl

All Implemented Interfaces:

ColumnTotalsDataRange

public class ColumnTotalsDataRangeImpl
extends Object
implements ColumnTotalsDataRange

Created on 28/03/13

Author:

d.serdiuk

Constructor Summary

Constructors

Constructor and Description
ColumnTotalsDataRangeImpl(SheetContextImpl sheetContext)

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()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ColumnTotalsDataRangeImpl

public ColumnTotalsDataRangeImpl(SheetContextImpl sheetContext)

Method Detail

endOnCurrentRow

public void endOnCurrentRow()

Description copied from interface: ColumnTotalsDataRange

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.

Specified by:

endOnCurrentRow in interface ColumnTotalsDataRange

See Also:

SupportsColumnTotalsRendering.setTotalsDataRange(ColumnTotalsDataRange)

endOnPreviousRow

public void endOnPreviousRow()

Description copied from interface: ColumnTotalsDataRange

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

Specified by:

endOnPreviousRow in interface ColumnTotalsDataRange

endOn

public void endOn(int rowOffset)

Specified by:

endOn in interface ColumnTotalsDataRange

Parameters:

rowOffset - example values:

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

getStartRowNo

public int getStartRowNo()

Specified by:

getStartRowNo in interface ColumnTotalsDataRange

Returns:

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

getEndRowNo

public int getEndRowNo()

Specified by:

getEndRowNo in interface ColumnTotalsDataRange

Returns:

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

isEndMarked

public boolean isEndMarked()

Specified by:

isEndMarked in interface ColumnTotalsDataRange

Returns:

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

toString

public String toString()

Overrides:

toString in class Object