org.jfree.workbook
Class Comment

java.lang.Object
  |
  +--org.jfree.workbook.Comment

All Implemented Interfaces:

java.lang.Comparable

public class Comment

extends java.lang.Object

implements java.lang.Comparable

Represents a comment that can be attached to a cell.

Field Summary

protected java.lang.String	author The author.
protected int	column The cell column.
protected int	row The cell row.
protected java.lang.String	text The comment.

Constructor Summary

Comment(int row, int column, java.lang.String text)
Standard constructor.

Method Summary

int	compareTo(java.lang.Object other) Implements the Comparable interface.
java.lang.String	getAuthor() Returns the name of the comment author.
int	getColumn() Returns the column of the cell that the comment applies to.
int	getRow() Returns the row of the cell that the comment applies to.
java.lang.String	getText() Returns the comment text.

Methods inherited from class java.lang.Object

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

Field Detail

row

protected int row

The cell row.

column

protected int column

The cell column.

text

protected java.lang.String text

The comment.

author

protected java.lang.String author

The author.

Constructor Detail

Comment

public Comment(int row,
               int column,
               java.lang.String text)

Standard constructor.

Parameters:

column - the column.

row - the row.

text - the comment.

Method Detail

getRow

public int getRow()

Returns the row of the cell that the comment applies to.

Returns:

The row.

getColumn

public int getColumn()

Returns the column of the cell that the comment applies to.

Returns:

The column.

getText

public java.lang.String getText()

Returns the comment text.

Returns:

The text.

getAuthor

public java.lang.String getAuthor()

Returns the name of the comment author.

Returns:

The author.

compareTo

public int compareTo(java.lang.Object other)

Implements the Comparable interface.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

other - the object to compare against.

Returns:

An integer that indicates the relative order of the objects.