Package org.apache.poi.hslf.record
Class Comment2000Atom
java.lang.Object
org.apache.poi.hslf.record.Record
org.apache.poi.hslf.record.RecordAtom
org.apache.poi.hslf.record.Comment2000Atom
An atomic record containing information about a comment.
- Author:
- Daniel Noll
-
Field Summary
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructs a brand new comment atom record.protectedComment2000Atom(byte[] source, int start, int len) Constructs the comment atom record from its source data. -
Method Summary
Modifier and TypeMethodDescriptiongetDate()Gets the date the comment was made.intGets the comment number (note - each user normally has their own count).longGets the record type.intGets the X offset of the comment on the page.intGets the Y offset of the comment on the page.voidSets the date the comment was made.voidsetNumber(int number) Sets the comment number (note - each user normally has their own count).voidsetXOffset(int xOffset) Sets the X offset of the comment on the page.voidsetYOffset(int yOffset) Sets the Y offset of the comment on the page.voidwriteOut(OutputStream out) Write the contents of the record back, so it can be written to diskMethods inherited from class org.apache.poi.hslf.record.RecordAtom
getChildRecords, isAnAtomMethods inherited from class org.apache.poi.hslf.record.Record
buildRecordAtOffset, createRecordForType, findChildRecords, writeLittleEndian, writeLittleEndian
-
Constructor Details
-
Comment2000Atom
protected Comment2000Atom()Constructs a brand new comment atom record. -
Comment2000Atom
protected Comment2000Atom(byte[] source, int start, int len) Constructs the comment atom record from its source data.- Parameters:
source- the source data as a byte array.start- the start offset into the byte array.len- the length of the slice in the byte array.
-
-
Method Details
-
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
Gets the date the comment was made.- Returns:
- the comment date.
-
setDate
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:
getRecordTypein classRecord- Returns:
- the record type.
-
writeOut
Write the contents of the record back, so it can be written to disk- Specified by:
writeOutin classRecord- Parameters:
out- the output stream to write to.- Throws:
IOException- if an error occurs.
-