Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_AUTHOR |
static int |
DEFAULT_AUTHOR_ID |
Constructor and Description |
---|
CommentsTable() |
CommentsTable(PackagePart part) |
Modifier and Type | Method and Description |
---|---|
int |
findAuthor(String author) |
XSSFComment |
findCellComment(CellAddress cellAddress)
Finds the cell comment at cellAddress, if one exists
|
String |
getAuthor(long authorId) |
Iterator<CellAddress> |
getCellAddresses()
Returns all cell addresses that have comments.
|
Map<CellAddress,XSSFComment> |
getCellComments()
Deprecated.
use
getCellAddresses instead |
CTComment |
getCTComment(CellAddress cellRef)
Get the underlying CTComment xmlbean for a comment located at cellRef, if it exists
|
CTComments |
getCTComments()
Returns the underlying CTComments list xmlbean
|
int |
getNumberOfAuthors() |
int |
getNumberOfComments() |
CTComment |
newComment(CellAddress ref)
Create a new comment located` at cell address
|
void |
readFrom(InputStream is) |
void |
referenceUpdated(CellAddress oldReference,
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(OutputStream out) |
_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, isCommited, isCommitted, setCommited, setCommitted, toString
public static final String DEFAULT_AUTHOR
public static final int DEFAULT_AUTHOR_ID
public CommentsTable()
public CommentsTable(PackagePart part) throws IOException
IOException
public void readFrom(InputStream is) throws IOException
IOException
public void writeTo(OutputStream out) throws IOException
IOException
public void referenceUpdated(CellAddress oldReference, 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 int findAuthor(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 CTComment getCTComment(CellAddress cellRef)
cellRef
- the location of the cell commentpublic Iterator<CellAddress> getCellAddresses()
getCellAddresses
in interface Comments
@Removal(version="4.2") @Deprecated public Map<CellAddress,XSSFComment> getCellComments()
getCellAddresses
instead@Internal public 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 CTComments getCTComments()
Copyright © 2010 - 2020 Adobe. All Rights Reserved