csheets.ext
Class SpreadsheetExtension

java.lang.Object
  csheets.ext.SpreadsheetExtension

All Implemented Interfaces:

Spreadsheet, Extensible<Spreadsheet>, Serializable, Iterable<Cell>

Direct Known Subclasses:

StylableSpreadsheet, TestableSpreadsheet

public abstract class SpreadsheetExtension
extends Object
implements Spreadsheet

A base class for extensions of spreadsheets that uses delegation to provide cell data.

Author:

Einar Pehrson

See Also:

Serialized Form

Constructor Summary

SpreadsheetExtension(Spreadsheet delegate, String name)
Creates a new spreadsheet extension.

Method Summary

void	addCellListener(CellListener listener) Registers the given listener to receive events from all cells in the spreadsheet.
Cell	getCell(Address address) Returns the cell at the given address.
Cell	getCell(int column, int row) Returns the cell at the given column and row in the spreadsheet.
CellListener[]	getCellListeners() Returns the cell listeners that have been registered on the spreadsheet.
SortedSet<Cell>	getCells(Address address1, Address address2) Returns the cells in the range between the given addresses.
Cell[]	getColumn(int index) Returns the cells in the given column.
int	getColumnCount() Returns the number of columns in the spreadsheet.
Spreadsheet	getExtension(String name) Returns the extension with the given key.
String	getName() Returns the name of the extension to which the spreadsheet extension belongs.
Cell[]	getRow(int index) Returns the cells in the given row.
int	getRowCount() Returns the number of rows in the spreadsheet.
String	getTitle() Returns the title of the spreadsheet.
Workbook	getWorkbook() Returns the workbook to which the spreadsheet belongs.
Iterator<Cell>	iterator()
void	removeCellListener(CellListener listener) Deregisters the given listener from receiving events from all cells in the spreadsheet.
void	setTitle(String title) Sets the title of the spreadsheet.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpreadsheetExtension

public SpreadsheetExtension(Spreadsheet delegate,
                            String name)

Creates a new spreadsheet extension.

Parameters:

delegate - the delegate of the extension

name - the name of the extension to which the spreadsheet extension belongs

Method Detail

getName

public final String getName()

Returns the name of the extension to which the spreadsheet extension belongs.

Returns:

the name of the extension to which the spreadsheet extension belongs

getTitle

public final String getTitle()

Description copied from interface: Spreadsheet

Returns the title of the spreadsheet.

Specified by:

getTitle in interface Spreadsheet

Returns:

the title of the spreadsheet.

setTitle

public final void setTitle(String title)

Description copied from interface: Spreadsheet

Sets the title of the spreadsheet.

Specified by:

setTitle in interface Spreadsheet

Parameters:

title - the title of the spreadsheet.

getWorkbook

public final Workbook getWorkbook()

Description copied from interface: Spreadsheet

Returns the workbook to which the spreadsheet belongs.

Specified by:

getWorkbook in interface Spreadsheet

Returns:

the workbook to which the spreadsheet belongs

getColumnCount

public final int getColumnCount()

Description copied from interface: Spreadsheet

Returns the number of columns in the spreadsheet.

Specified by:

getColumnCount in interface Spreadsheet

Returns:

the number of columns in the spreadsheet.

getRowCount

public final int getRowCount()

Description copied from interface: Spreadsheet

Returns the number of rows in the spreadsheet.

Specified by:

getRowCount in interface Spreadsheet

Returns:

the number of rows in the spreadsheet.

getCell

public final Cell getCell(Address address)

Description copied from interface: Spreadsheet

Returns the cell at the given address.

Specified by:

getCell in interface Spreadsheet

Parameters:

address - the address of the cell

Returns:

the cell at the given address

getCell

public final Cell getCell(int column,
                          int row)

Description copied from interface: Spreadsheet

Returns the cell at the given column and row in the spreadsheet.

Specified by:

getCell in interface Spreadsheet

Parameters:

column - the column index of the cell's location

row - the row index of the cell's location

Returns:

the cell at the given column and row in the spreadsheet

getCells

public final SortedSet<Cell> getCells(Address address1,
                                      Address address2)

Description copied from interface: Spreadsheet

Returns the cells in the range between the given addresses.

Specified by:

getCells in interface Spreadsheet

Parameters:

address1 - the address of the cell in one end of the range

address2 - the address of the cell in the other end of the range

Returns:

a sorted set of the cells in the range

getColumn

public final Cell[] getColumn(int index)

Description copied from interface: Spreadsheet

Returns the cells in the given column.

Specified by:

getColumn in interface Spreadsheet

Parameters:

index - the index of the column

Returns:

an array of the cells in the column

getRow

public final Cell[] getRow(int index)

Description copied from interface: Spreadsheet

Returns the cells in the given row.

Specified by:

getRow in interface Spreadsheet

Parameters:

index - the index of the row

Returns:

an array of the cells in the row

iterator

public final Iterator<Cell> iterator()

Specified by:

iterator in interface Iterable<Cell>

addCellListener

public void addCellListener(CellListener listener)

Description copied from interface: Spreadsheet

Registers the given listener to receive events from all cells in the spreadsheet.

Specified by:

addCellListener in interface Spreadsheet

Parameters:

listener - the listener to be added

removeCellListener

public void removeCellListener(CellListener listener)

Description copied from interface: Spreadsheet

Deregisters the given listener from receiving events from all cells in the spreadsheet.

Specified by:

removeCellListener in interface Spreadsheet

Parameters:

listener - the listener to be removed

getCellListeners

public CellListener[] getCellListeners()

Description copied from interface: Spreadsheet

Returns the cell listeners that have been registered on the spreadsheet.

Specified by:

getCellListeners in interface Spreadsheet

Returns:

the cell listeners that have been registered on the spreadsheet

getExtension

public final Spreadsheet getExtension(String name)

Description copied from interface: Extensible

Returns the extension with the given key.

Specified by:

getExtension in interface Extensible<Spreadsheet>

Parameters:

name - the name of the extension (case-insensitive)

Returns:

the appropriate extension, or null if no extension with the given name was found