org.formulacompiler.spreadsheet
Interface Spreadsheet.Range

All Superinterfaces:
Describable
All Known Subinterfaces:
Spreadsheet.Cell
Enclosing interface:
Spreadsheet

public static interface Spreadsheet.Range
extends Describable

Marker interface for a spreadsheet range in the spreadsheet model.

This interface is an API only. Do not implement it yourself.

Author:
peo
See Also:
Spreadsheet

Method Summary
 java.lang.Iterable<Spreadsheet.Cell> cells()
          Allows iteration over the cells contained in the range.
 boolean contains(Spreadsheet.Range _other)
          Tests whether the other range is completely contained within this one.
 Spreadsheet.Cell getBottomRight()
          Returns the bottom right corner of the range (on the rightmost sheet of the range).
 Spreadsheet.Cell getTopLeft()
          Returns the top left corner of the range (on the leftmost sheet of the range).
 
Methods inherited from interface org.formulacompiler.compiler.Describable
describe, toString
 

Method Detail

contains

boolean contains(Spreadsheet.Range _other)
Tests whether the other range is completely contained within this one.

Parameters:
_other - is the other range.
Returns:
true iff the other range is completely contained.

getTopLeft

Spreadsheet.Cell getTopLeft()
Returns the top left corner of the range (on the leftmost sheet of the range).


getBottomRight

Spreadsheet.Cell getBottomRight()
Returns the bottom right corner of the range (on the rightmost sheet of the range).


cells

java.lang.Iterable<Spreadsheet.Cell> cells()
Allows iteration over the cells contained in the range. The direction is first left, then down, from the top left.