org.apache.poi.hslf.record
Class Comment2000Atom

java.lang.Object
  extended by org.apache.poi.hslf.record.Record
      extended by org.apache.poi.hslf.record.RecordAtom
          extended by org.apache.poi.hslf.record.Comment2000Atom

public final class Comment2000Atom
extends RecordAtom

An atomic record containing information about a comment.

Author:
Daniel Noll

Method Summary
 java.util.Date getDate()
          Gets the date the comment was made.
 int getNumber()
          Gets the comment number (note - each user normally has their own count).
 long getRecordType()
          Gets the record type.
 int getXOffset()
          Gets the X offset of the comment on the page.
 int getYOffset()
          Gets the Y offset of the comment on the page.
 void setDate(java.util.Date date)
          Sets the date the comment was made.
 void setNumber(int number)
          Sets the comment number (note - each user normally has their own count).
 void setXOffset(int xOffset)
          Sets the X offset of the comment on the page.
 void setYOffset(int yOffset)
          Sets the Y offset of the comment on the page.
 void writeOut(java.io.OutputStream out)
          Write the contents of the record back, so it can be written to disk
 
Methods inherited from class org.apache.poi.hslf.record.RecordAtom
getChildRecords, isAnAtom
 
Methods inherited from class org.apache.poi.hslf.record.Record
buildRecordAtOffset, createRecordForType, findChildRecords, writeLittleEndian, writeLittleEndian
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getNumber

public int getNumber()
Gets the comment number (note - each user normally has their own count).

Returns:
the comment number.

setNumber

public void setNumber(int number)
Sets the comment number (note - each user normally has their own count).

Parameters:
number - the comment number.

getDate

public java.util.Date getDate()
Gets the date the comment was made.

Returns:
the comment date.

setDate

public void setDate(java.util.Date date)
Sets the date the comment was made.

Parameters:
date - the comment date.

getXOffset

public int getXOffset()
Gets the X offset of the comment on the page.

Returns:
the X offset.

setXOffset

public void setXOffset(int xOffset)
Sets the X offset of the comment on the page.

Parameters:
xOffset - the X offset.

getYOffset

public int getYOffset()
Gets the Y offset of the comment on the page.

Returns:
the Y offset.

setYOffset

public void setYOffset(int yOffset)
Sets the Y offset of the comment on the page.

Parameters:
yOffset - the Y offset.

getRecordType

public long getRecordType()
Gets the record type.

Specified by:
getRecordType in class Record
Returns:
the record type.

writeOut

public void writeOut(java.io.OutputStream out)
              throws java.io.IOException
Write the contents of the record back, so it can be written to disk

Specified by:
writeOut in class Record
Parameters:
out - the output stream to write to.
Throws:
java.io.IOException - if an error occurs.