@Internal public class CommentsTable extends POIXMLDocumentPart implements Comments
POIXMLDocumentPart.RelationPart
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_AUTHOR |
static int |
DEFAULT_AUTHOR_ID |
Constructor and Description |
---|
CommentsTable() |
CommentsTable(PackagePart part) |
Modifier and Type | Method and Description |
---|---|
protected void |
commit()
Save the content in the underlying package part.
|
int |
findAuthor(java.lang.String author) |
XSSFComment |
findCellComment(CellAddress cellAddress)
Finds the cell comment at cellAddress, if one exists
|
java.lang.String |
getAuthor(long authorId) |
java.util.Iterator<CellAddress> |
getCellAddresses()
Returns all cell addresses that have comments.
|
java.util.Map<CellAddress,XSSFComment> |
getCellComments()
Deprecated.
use
getCellAddresses instead |
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment |
getCTComment(CellAddress cellRef)
Get the underlying CTComment xmlbean for a comment located at cellRef, if it exists
|
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComments |
getCTComments()
Returns the underlying CTComments list xmlbean
|
int |
getNumberOfAuthors() |
int |
getNumberOfComments() |
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment |
newComment(CellAddress ref)
Create a new comment located` at cell address
|
void |
readFrom(java.io.InputStream is) |
void |
referenceUpdated(CellAddress oldReference,
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment comment)
Called after the reference is updated, so that
we can reflect that in our cache
|
boolean |
removeComment(CellAddress cellRef)
Remove the comment at cellRef location, if one exists
|
void |
writeTo(java.io.OutputStream out) |
_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommited, isCommitted, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, removeRelation, setCommited, setCommitted, toString
public static final java.lang.String DEFAULT_AUTHOR
public static final int DEFAULT_AUTHOR_ID
public CommentsTable()
public CommentsTable(PackagePart part) throws java.io.IOException
java.io.IOException
public void readFrom(java.io.InputStream is) throws java.io.IOException
java.io.IOException
public void writeTo(java.io.OutputStream out) throws java.io.IOException
java.io.IOException
protected void commit() throws java.io.IOException
POIXMLDocumentPart
Sub-classes should override and add logic to marshal the "model" into Ooxml4J.
For example, the code saving a generic XML entry may look as follows:
protected void commit() throws IOException { PackagePart part = getPackagePart(); OutputStream out = part.getOutputStream(); XmlObject bean = getXmlBean(); //the "model" which holds changes in memory bean.save(out, DEFAULT_XML_OPTIONS); out.close(); }
commit
in class POIXMLDocumentPart
java.io.IOException
- a subclass may throw an IOException if the changes can't be committedpublic void referenceUpdated(CellAddress oldReference, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment comment)
oldReference
- the comment to remove from the commentRefs mapcomment
- the comment to replace in the commentRefs mappublic int getNumberOfComments()
getNumberOfComments
in interface Comments
public int getNumberOfAuthors()
getNumberOfAuthors
in interface Comments
public java.lang.String getAuthor(long authorId)
public int findAuthor(java.lang.String author)
findAuthor
in interface Comments
public XSSFComment findCellComment(CellAddress cellAddress)
findCellComment
in interface Comments
cellAddress
- the address of the cell to find a comment@Internal public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment getCTComment(CellAddress cellRef)
cellRef
- the location of the cell commentpublic java.util.Iterator<CellAddress> getCellAddresses()
getCellAddresses
in interface Comments
@Removal(version="4.2") @Deprecated public java.util.Map<CellAddress,XSSFComment> getCellComments()
getCellAddresses
instead@Internal public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment newComment(CellAddress ref)
ref
- the location to add the commentpublic boolean removeComment(CellAddress cellRef)
removeComment
in interface Comments
cellRef
- the location of the comment to remove@Internal public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComments getCTComments()
Copyright 2020 The Apache Software Foundation or its licensors, as applicable.