com.jrefinery.workbook
Class Comment

java.lang.Object
  |
  +--com.jrefinery.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 java.lang.String	comment The comment.
protected int	row The cell row.

Constructor Summary

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

Method Summary

int	compareTo(java.lang.Object other) Implements the Comparable interface.
void	writeComment(java.io.PrintStream out, java.lang.String indent) Writes a comment element in the Gnumeric file format.

Methods inherited from class java.lang.Object

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

Field Detail

column

protected int column

The cell column.

row

protected int row

The cell row.

comment

protected java.lang.String comment

The comment.

author

protected java.lang.String author

The author.

Constructor Detail

Comment

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

Standard constructor.

Parameters:

column - The column.

row - The row.

comment - The comment.

Method Detail

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.

writeComment

public void writeComment(java.io.PrintStream out,
                         java.lang.String indent)

Writes a comment element in the Gnumeric file format.

Parameters:

out - The output stream.

indent - The indentation.