csheets.ext.comments

Class CommentableCell

java.lang.Object

csheets.ext.CellExtension

csheets.ext.comments.CommentableCell

All Implemented Interfaces:

Cell, CellListener, Extensible<Cell>, Serializable, Comparable<Cell>, EventListener

public class CommentableCell
extends CellExtension

An extension of a cell in a spreadsheet, with support for comments.

Author:

Alexandre Braganca, Einar Pehrson

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommentableCell(Cell cell) Creates a comentable cell extension for the given cell.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCommentableCellListener(CommentableCellListener listener) Registers the given listener on the cell.
protected void	fireCommentsChanged() Notifies all registered listeners that the cell's comments changed.
String	getUserComment() Get the cell's user comment.
boolean	hasComment() Returns whether the cell has a comment.
void	removeCommentableCellListener(CommentableCellListener listener) Removes the given listener from the cell.
void	setUserComment(String comment) Sets the user-specified comment for the cell.

Methods inherited from class csheets.ext.CellExtension

addCellListener, cellCleared, cellCopied, clear, compareTo, contentChanged, copyFrom, dependentsChanged, getAddress, getCellListeners, getContent, getDelegate, getDependents, getExtension, getFormula, getName, getPrecedents, getSpreadsheet, getValue, moveFrom, removeCellListener, setContent, toString, valueChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentableCell

CommentableCell(Cell cell)

Creates a comentable cell extension for the given cell.

Parameters:

cell - the cell to extend

Method Detail

getUserComment

public String getUserComment()

Get the cell's user comment.

Returns:

The user supplied comment for the cell or null if no user supplied comment exists.

hasComment

public boolean hasComment()

Returns whether the cell has a comment.

Returns:

true if the cell has a comment

setUserComment

public void setUserComment(String comment)

Sets the user-specified comment for the cell.

Parameters:

comment - the user-specified comment

addCommentableCellListener

public void addCommentableCellListener(CommentableCellListener listener)

Registers the given listener on the cell.

Parameters:

listener - the listener to be added

removeCommentableCellListener

public void removeCommentableCellListener(CommentableCellListener listener)

Removes the given listener from the cell.

Parameters:

listener - the listener to be removed

fireCommentsChanged

protected void fireCommentsChanged()

Notifies all registered listeners that the cell's comments changed.