Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.hssf.record.formula.eval
Class Area3DEval

java.lang.Object
  extended by org.apache.poi.hssf.record.formula.eval.Area3DEval
All Implemented Interfaces:
AreaEval, Eval, ValueEval
public final class Area3DEval
extends java.lang.Object

Author:
Amol S. Deshmukh < amolweb at ya hoo dot com >

Constructor Summary
Area3DEval(Ptg ptg, ValueEval[] values)
           
 
Method Summary
 boolean contains(int row, int col)
          returns true if the cell at row and col specified as absolute indexes in the sheet is contained in this area.
 boolean containsColumn(short col)
          returns true if the specified col is in range
 boolean containsRow(int row)
          returns true if the specified row is in range
 int getExternSheetIndex()
           
 int getFirstColumn()
          returns the 0-based index of the first col in this area.
 int getFirstRow()
          returns the 0-based index of the first row in this area.
 int getLastColumn()
          returns the 0-based index of the last col in this area.
 int getLastRow()
          returns the 0-based index of the last row in this area.
 ValueEval getValueAt(int row, int col)
          returns the ValueEval from the values array at the specified row and col index.
 ValueEval[] getValues()
          The array of values in this area.
 boolean isColumn()
          returns true if the Area's start and end col indexes are same.
 boolean isRow()
          returns true if the Area's start and end row indexes are same.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Area3DEval

public Area3DEval(Ptg ptg,
                  ValueEval[] values)
Method Detail

getExternSheetIndex

public int getExternSheetIndex()

getFirstColumn

public final int getFirstColumn()
Description copied from interface: AreaEval
returns the 0-based index of the first col in this area.

Specified by:
getFirstColumn in interface AreaEval

getFirstRow

public final int getFirstRow()
Description copied from interface: AreaEval
returns the 0-based index of the first row in this area.

Specified by:
getFirstRow in interface AreaEval

getLastColumn

public final int getLastColumn()
Description copied from interface: AreaEval
returns the 0-based index of the last col in this area.

Specified by:
getLastColumn in interface AreaEval

getLastRow

public final int getLastRow()
Description copied from interface: AreaEval
returns the 0-based index of the last row in this area.

Specified by:
getLastRow in interface AreaEval

getValues

public final ValueEval[] getValues()
Description copied from interface: AreaEval
The array of values in this area. Although the area maybe 1D (ie. isRow() or isColumn() returns true) or 2D the returned array is 1D.

Specified by:
getValues in interface AreaEval

getValueAt

public final ValueEval getValueAt(int row,
                                  int col)
Description copied from interface: AreaEval
returns the ValueEval from the values array at the specified row and col index. The specified indexes should be absolute indexes in the sheet and not relative indexes within the area. Also, if contains(row, col) evaluates to true, a null value will bre returned.

Specified by:
getValueAt in interface AreaEval

contains

public final boolean contains(int row,
                              int col)
Description copied from interface: AreaEval
returns true if the cell at row and col specified as absolute indexes in the sheet is contained in this area.

Specified by:
contains in interface AreaEval

containsRow

public final boolean containsRow(int row)
Description copied from interface: AreaEval
returns true if the specified row is in range

Specified by:
containsRow in interface AreaEval

containsColumn

public final boolean containsColumn(short col)
Description copied from interface: AreaEval
returns true if the specified col is in range

Specified by:
containsColumn in interface AreaEval

isColumn

public final boolean isColumn()
Description copied from interface: AreaEval
returns true if the Area's start and end col indexes are same. This result of this method should agree with getFirstColumn() == getLastColumn().

Specified by:
isColumn in interface AreaEval

isRow

public final boolean isRow()
Description copied from interface: AreaEval
returns true if the Area's start and end row indexes are same. This result of this method should agree with getFirstRow() == getLastRow().

Specified by:
isRow in interface AreaEval
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright 2008 The Apache Software Foundation or its licensors, as applicable.