diff options
Diffstat (limited to 'src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFComment.java')
| -rw-r--r-- | src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFComment.java | 412 |
1 files changed, 390 insertions, 22 deletions
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFComment.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFComment.java index 0df8111117..f9ee63fc44 100644 --- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFComment.java +++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFComment.java @@ -16,43 +16,411 @@ ==================================================================== */ package org.apache.poi.xwpf.usermodel; -import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTComment; -import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP; +import org.apache.poi.ooxml.POIXMLDocumentPart; +import org.apache.xmlbeans.XmlCursor; +import org.apache.xmlbeans.XmlObject; +import org.openxmlformats.schemas.wordprocessingml.x2006.main.*; + +import java.util.ArrayList; +import java.util.Calendar; +import java.util.Collections; +import java.util.List; /** * Sketch of XWPF comment class - * - * @author Yury Batrakov (batrakov at gmail.com) */ -public class XWPFComment { - protected String id; - protected String author; - protected StringBuilder text; - - public XWPFComment(CTComment comment, XWPFDocument document) { - text = new StringBuilder(64); - id = comment.getId().toString(); - author = comment.getAuthor(); - - for (CTP ctp : comment.getPArray()) { - if(text.length() > 0) { - text.append("\n"); +public class XWPFComment implements IBody { + + protected CTComment ctComment; + protected XWPFComments comments; + protected XWPFDocument document; + private List<XWPFParagraph> paragraphs = new ArrayList<>(); + private List<XWPFTable> tables = new ArrayList<>(); + private List<IBodyElement> bodyElements = new ArrayList<>(); + + public XWPFComment(CTComment ctComment, XWPFComments comments) { + this.comments = comments; + this.ctComment = ctComment; + this.document = comments.getXWPFDocument(); + init(); + } + + protected void init() { + XmlCursor cursor = ctComment.newCursor(); + cursor.selectPath("./*"); + while (cursor.toNextSelection()) { + XmlObject o = cursor.getObject(); + if (o instanceof CTP) { + XWPFParagraph p = new XWPFParagraph((CTP) o, this); + bodyElements.add(p); + paragraphs.add(p); + } else if (o instanceof CTTbl) { + XWPFTable t = new XWPFTable((CTTbl) o, this); + bodyElements.add(t); + tables.add(t); + } else if (o instanceof CTSdtBlock) { + XWPFSDT c = new XWPFSDT((CTSdtBlock) o, this); + bodyElements.add(c); + } + + } + cursor.dispose(); + } + + /** + * Get the Part to which the comment belongs, which you need for adding + * relationships to other parts + * + * @return {@link POIXMLDocumentPart} that contains the comment. + * @see org.apache.poi.xwpf.usermodel.IBody#getPart() + */ + @Override + public POIXMLDocumentPart getPart() { + return comments; + } + + /** + * Get the part type {@link BodyType} of the comment. + * + * @return The {@link BodyType} value. + * @see org.apache.poi.xwpf.usermodel.IBody#getPartType() + */ + @Override + public BodyType getPartType() { + return BodyType.COMMENT; + } + + /** + * Gets the body elements ({@link IBodyElement}) of the comment. + * + * @return List of body elements. + */ + @Override + public List<IBodyElement> getBodyElements() { + return Collections.unmodifiableList(bodyElements); + } + + /** + * Returns the paragraph(s) that holds the text of the comment. + */ + @Override + public List<XWPFParagraph> getParagraphs() { + return Collections.unmodifiableList(paragraphs); + } + + /** + * Get the list of {@link XWPFTable}s in the comment. + * + * @return List of tables + */ + @Override + public List<XWPFTable> getTables() { + return Collections.unmodifiableList(tables); + } + + @Override + public XWPFParagraph getParagraph(CTP p) { + for (XWPFParagraph paragraph : paragraphs) { + if (paragraph.getCTP().equals(p)) + return paragraph; + } + return null; + } + + @Override + public XWPFTable getTable(CTTbl ctTable) { + for (XWPFTable table : tables) { + if (table == null) + return null; + if (table.getCTTbl().equals(ctTable)) + return table; + } + return null; + } + + @Override + public XWPFParagraph getParagraphArray(int pos) { + if (pos >= 0 && pos < paragraphs.size()) { + return paragraphs.get(pos); + } + return null; + } + + @Override + public XWPFTable getTableArray(int pos) { + if (pos >= 0 && pos < tables.size()) { + return tables.get(pos); + } + return null; + } + + @Override + public XWPFParagraph insertNewParagraph(XmlCursor cursor) { + if (isCursorInCmt(cursor)) { + String uri = CTP.type.getName().getNamespaceURI(); + String localPart = "p"; + cursor.beginElement(localPart, uri); + cursor.toParent(); + CTP p = (CTP) cursor.getObject(); + XWPFParagraph newP = new XWPFParagraph(p, this); + XmlObject o = null; + while (!(o instanceof CTP) && (cursor.toPrevSibling())) { + o = cursor.getObject(); + } + if ((!(o instanceof CTP)) || o == p) { + paragraphs.add(0, newP); + } else { + int pos = paragraphs.indexOf(getParagraph((CTP) o)) + 1; + paragraphs.add(pos, newP); + } + int i = 0; + XmlCursor p2 = p.newCursor(); + cursor.toCursor(p2); + p2.dispose(); + while (cursor.toPrevSibling()) { + o = cursor.getObject(); + if (o instanceof CTP || o instanceof CTTbl) + i++; + } + bodyElements.add(i, newP); + p2 = p.newCursor(); + cursor.toCursor(p2); + cursor.toEndToken(); + p2.dispose(); + return newP; + } + return null; + } + + private boolean isCursorInCmt(XmlCursor cursor) { + XmlCursor verify = cursor.newCursor(); + verify.toParent(); + boolean result = (verify.getObject() == this.ctComment); + verify.dispose(); + return result; + } + + @Override + public XWPFTable insertNewTbl(XmlCursor cursor) { + if (isCursorInCmt(cursor)) { + String uri = CTTbl.type.getName().getNamespaceURI(); + String localPart = "tbl"; + cursor.beginElement(localPart, uri); + cursor.toParent(); + CTTbl t = (CTTbl) cursor.getObject(); + XWPFTable newT = new XWPFTable(t, this); + cursor.removeXmlContents(); + XmlObject o = null; + while (!(o instanceof CTTbl) && (cursor.toPrevSibling())) { + o = cursor.getObject(); + } + if (!(o instanceof CTTbl)) { + tables.add(0, newT); + } else { + int pos = tables.indexOf(getTable((CTTbl) o)) + 1; + tables.add(pos, newT); + } + int i = 0; + XmlCursor cursor2 = t.newCursor(); + while (cursor2.toPrevSibling()) { + o = cursor2.getObject(); + if (o instanceof CTP || o instanceof CTTbl) { + i++; + } } + cursor2.dispose(); + bodyElements.add(i, newT); + cursor2 = t.newCursor(); + cursor.toCursor(cursor2); + cursor.toEndToken(); + cursor2.dispose(); + return newT; + } + return null; + } + + @Override + public void insertTable(int pos, XWPFTable table) { + bodyElements.add(pos, table); + int i = 0; + for (CTTbl tbl : ctComment.getTblList()) { + if (tbl == table.getCTTbl()) { + break; + } + i++; + } + tables.add(i, table); + + } + + @Override + public XWPFTableCell getTableCell(CTTc cell) { + XmlCursor cursor = cell.newCursor(); + cursor.toParent(); + XmlObject o = cursor.getObject(); + if (!(o instanceof CTRow)) { + cursor.dispose(); + return null; + } + CTRow row = (CTRow) o; + cursor.toParent(); + o = cursor.getObject(); + cursor.dispose(); + if (!(o instanceof CTTbl)) { + return null; + } + CTTbl tbl = (CTTbl) o; + XWPFTable table = getTable(tbl); + if (table == null) { + return null; + } + XWPFTableRow tableRow = table.getRow(row); + return tableRow.getTableCell(cell); + } + + /** + * Get the {@link XWPFDocument} the comment is part of. + * + * @see org.apache.poi.xwpf.usermodel.IBody#getXWPFDocument() + */ + @Override + public XWPFDocument getXWPFDocument() { + return document; + } - XWPFParagraph p = new XWPFParagraph(ctp, document); + public String getText() { + StringBuilder text = new StringBuilder(); + for (XWPFParagraph p : paragraphs) { + if (text.length() > 0) { + text.append("\n"); + } text.append(p.getText()); } + return text.toString(); + } + + public XWPFParagraph createParagraph() { + XWPFParagraph paragraph = new XWPFParagraph(ctComment.addNewP(), this); + paragraphs.add(paragraph); + bodyElements.add(paragraph); + return paragraph; } + public void removeParagraph(XWPFParagraph paragraph) { + if (paragraphs.contains(paragraph)) { + CTP ctP = paragraph.getCTP(); + XmlCursor c = ctP.newCursor(); + c.removeXml(); + c.dispose(); + paragraphs.remove(paragraph); + bodyElements.remove(paragraph); + } + } + + public void removeTable(XWPFTable table) { + if (tables.contains(table)) { + CTTbl ctTbl = table.getCTTbl(); + XmlCursor c = ctTbl.newCursor(); + c.removeXml(); + c.dispose(); + tables.remove(table); + bodyElements.remove(table); + } + } + + public XWPFTable createTable(int rows, int cols) { + XWPFTable table = new XWPFTable(ctComment.addNewTbl(), this, rows, + cols); + tables.add(table); + bodyElements.add(table); + return table; + } + + /** + * Gets the underlying CTComment object for the comment. + * + * @return CTComment object + */ + public CTComment getCtComment() { + return ctComment; + } + + /** + * The owning object for this comment + * + * @return The {@link XWPFComments} object that contains this comment. + */ + public XWPFComments getComments() { + return comments; + } + + /** + * Get a unique identifier for the current comment. The restrictions on the + * id attribute, if any, are defined by the parent XML element. If this + * attribute is omitted, then the document is non-conformant. + * + * @return string id + */ public String getId() { - return id; + return ctComment.getId().toString(); } + /** + * Get the author of the current comment + * + * @return author of the current comment + */ public String getAuthor() { - return author; + return ctComment.getAuthor(); } - public String getText() { - return text.toString(); + /** + * Specifies the author for the current comment If this attribute is + * omitted, then no author shall be associated with the parent annotation + * type. + * + * @param author author of the current comment + */ + public void setAuthor(String author) { + ctComment.setAuthor(author); + } + + /** + * Get the initials of the author of the current comment + * + * @return initials the initials of the author of the current comment + */ + public String getInitials() { + return ctComment.getInitials(); + } + + /** + * Specifies the initials of the author of the current comment + * + * @param initials the initials of the author of the current comment + */ + public void setInitials(String initials) { + ctComment.setInitials(initials); } + + /** + * Get the date information of the current comment + * + * @return the date information for the current comment. + */ + public Calendar getDate() { + return ctComment.getDate(); + } + + /** + * Specifies the date information for the current comment. If this attribute + * is omitted, then no date information shall be associated with the parent + * annotation type. + * + * @param date the date information for the current comment. + */ + public void setDate(Calendar date) { + ctComment.setDate(date); + } + } |