org.apache.poi.hssf.record.formula.functions
Class Offset

java.lang.Object
  org.apache.poi.hssf.record.formula.functions.Offset

All Implemented Interfaces:

FreeRefFunction

public final class Offset
extends java.lang.Object
implements FreeRefFunction

Implementation for Excel function OFFSET()

OFFSET returns an area reference that is a specified number of rows and columns from a reference cell or area.

Syntax:
OFFSET(reference, rows, cols, height, width)

reference is the base reference.
rows is the number of rows up or down from the base reference.
cols is the number of columns left or right from the base reference.
height (default same height as base reference) is the row count for the returned area reference.
width (default same width as base reference) is the column count for the returned area reference.

Author:

Josh Micich

Constructor Summary

Offset()

Method Summary

ValueEval

evaluate(Eval[] args, int srcCellRow, short srcCellCol, HSSFWorkbook workbook, HSSFSheet sheet)

Methods inherited from class java.lang.Object

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

Constructor Detail

Offset

public Offset()

Method Detail

evaluate

public ValueEval evaluate(Eval[] args,
                          int srcCellRow,
                          short srcCellCol,
                          HSSFWorkbook workbook,
                          HSSFSheet sheet)

Specified by:

evaluate in interface FreeRefFunction

Parameters:

args - the pre-evaluated arguments for this function. args is never null, nor are any of its elements.

srcCellRow - zero based row index of the cell containing the currently evaluating formula

srcCellCol - zero based column index of the cell containing the currently evaluating formula

workbook - is the workbook containing the formula/cell being evaluated

sheet - is the sheet containing the formula/cell being evaluated

Returns:

never null. Possibly an instance of ErrorEval in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors).