|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.POIXMLDocumentPart
org.apache.poi.POIXMLDocument
org.apache.poi.xwpf.usermodel.XWPFDocument
public class XWPFDocument
Experimental class to do low level processing of docx files. If you're using these low level classes, then you will almost certainly need to refer to the OOXML specifications from http://www.ecma-international.org/publications/standards/Ecma-376.htm WARNING - APIs expected to change rapidly
Field Summary |
---|
Fields inherited from class org.apache.poi.POIXMLDocument |
---|
DOCUMENT_CREATOR, OLE_OBJECT_REL_TYPE, PACK_OBJECT_REL_TYPE |
Fields inherited from class org.apache.poi.POIXMLDocumentPart |
---|
DEFAULT_XML_OPTIONS |
Fields inherited from interface org.apache.poi.xwpf.usermodel.Document |
---|
PICTURE_TYPE_DIB, PICTURE_TYPE_EMF, PICTURE_TYPE_JPEG, PICTURE_TYPE_PICT, PICTURE_TYPE_PNG, PICTURE_TYPE_WMF |
Constructor Summary | |
---|---|
XWPFDocument()
|
|
XWPFDocument(java.io.InputStream is)
|
|
XWPFDocument(OPCPackage pkg)
|
Method Summary | |
---|---|
int |
addPicture(byte[] pictureData,
int format)
Adds a picture to the document. |
int |
addPicture(java.io.InputStream is,
int format)
Adds a picture to the document. |
XWPFParagraph |
createParagraph()
Appends a new paragraph to this document |
XWPFTable |
createTable()
Create an empty table with one row and one column as default. |
XWPFTable |
createTable(int rows,
int cols)
Create an empty table with a number of rows and cols specified |
void |
createTOC()
|
void |
enforceCommentsProtection()
Enforce the Comments protection. In the documentProtection tag inside settings.xml file, it sets the value of enforcement to "1" (w:enforcement="1") and the value of edit to comments (w:edit="comments") sample snippet from settings.xml |
void |
enforceFillingFormsProtection()
Enforce the Filling Forms protection. In the documentProtection tag inside settings.xml file, it sets the value of enforcement to "1" (w:enforcement="1") and the value of edit to forms (w:edit="forms") sample snippet from settings.xml |
void |
enforceReadonlyProtection()
Enforces the readOnly protection. In the documentProtection tag inside settings.xml file, it sets the value of enforcement to "1" (w:enforcement="1") and the value of edit to readOnly (w:edit="readOnly") sample snippet from settings.xml |
void |
enforceTrackedChangesProtection()
Enforce the Tracked Changes protection. In the documentProtection tag inside settings.xml file, it sets the value of enforcement to "1" (w:enforcement="1") and the value of edit to trackedChanges (w:edit="trackedChanges") sample snippet from settings.xml |
java.util.List |
getAllEmbedds()
Get the document's embedded files. |
java.util.List |
getAllPackagePictures()
|
java.util.List |
getAllPictures()
|
java.util.List |
getBodyElements()
returns an Iterator with paragraphs and tables |
XWPFComment |
getCommentByID(java.lang.String id)
|
XWPFComment[] |
getComments()
|
org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDocument1 |
getDocument()
Returns the low level document base object |
XWPFFootnote |
getEndnoteByID(int id)
|
XWPFFooter |
getFooterArray(int pos)
|
java.util.List |
getFooterList()
|
XWPFFootnote |
getFootnoteByID(int id)
|
java.util.Collection |
getFootnotes()
|
XWPFHeader |
getHeaderArray(int pos)
|
XWPFHeaderFooterPolicy |
getHeaderFooterPolicy()
Returns the policy on headers and footers, which also provides a way to get at them. |
java.util.List |
getHeaderList()
|
XWPFHyperlink |
getHyperlinkByID(java.lang.String id)
|
XWPFHyperlink[] |
getHyperlinks()
|
XWPFParagraph |
getLastParagraph()
|
int |
getNextPicNameNumber(int format)
get the next free ImageNumber |
XWPFNumbering |
getNumbering()
getNumbering |
XWPFParagraph |
getParagraph(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP p)
get the paragraph with the CTP class p |
XWPFParagraph |
getParagraphArray(int pos)
Returns the paragraph that of position pos |
int |
getParagraphPos(int pos)
get with the position of a Paragraph in the bodyelement array list the position of this paragraph in the paragraph array list |
java.util.List |
getParagraphs()
Returns the paragraph(s) that holds the text of the header or footer. |
java.util.Iterator |
getParagraphsIterator()
|
IBody |
getPart()
returns the Part, to which the body belongs, which you need for adding relationship to other parts Actually it is needed of the class XWPFTableCell. |
PackagePart |
getPartById(java.lang.String id)
Get the document part that's defined as the given relationship of the core document. |
BodyType |
getPartType()
get the PartType of the body, for example DOCUMENT, HEADER, FOOTER, FOOTNOTE, |
XWPFPictureData |
getPictureDataByID(java.lang.String blipID)
returns the PictureData by blipID |
java.lang.Integer |
getPosOfParagraph(XWPFParagraph p)
get position of the paragraph |
java.lang.Integer |
getPosOfTable(XWPFTable t)
|
org.openxmlformats.schemas.wordprocessingml.x2006.main.CTStyles |
getStyle()
Returns the styles object used |
XWPFStyles |
getStyles()
get Styles |
XWPFTable |
getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl ctTbl)
get a table by its CTTbl-Object |
XWPFTable |
getTableArray(int pos)
Returns the table at position pos |
XWPFTableCell |
getTableCell(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc cell)
get the TableCell which belongs to the TableCell |
int |
getTablePos(int pos)
get with the position of a table in the bodyelement array list the position of this table in the table array list |
java.util.List |
getTables()
Return the table(s) that holds the text of the IBodyPart, for complex cases where a paragraph isn't used. |
java.util.Iterator |
getTablesIterator()
|
java.lang.String |
getTblStyle(XWPFTable table)
|
XWPFParagraph |
insertNewParagraph(org.apache.xmlbeans.XmlCursor cursor)
add a new paragraph at position of the cursor |
XWPFTable |
insertNewTbl(org.apache.xmlbeans.XmlCursor cursor)
inserts a new Table at the cursor position. |
void |
insertTable(int pos,
XWPFTable table)
inserts an existing XWPFTable to the arrays bodyElements and tables |
boolean |
isEnforcedCommentsProtection()
Verifies that the documentProtection tag in settings.xml file specifies that the protection is enforced (w:enforcement="1") and that the kind of protection is comments (w:edit="comments") sample snippet from settings.xml |
boolean |
isEnforcedFillingFormsProtection()
Verifies that the documentProtection tag in settings.xml file specifies that the protection is enforced (w:enforcement="1") and that the kind of protection is forms (w:edit="forms") sample snippet from settings.xml |
boolean |
isEnforcedReadonlyProtection()
Verifies that the documentProtection tag in settings.xml file specifies that the protection is enforced (w:enforcement="1") and that the kind of protection is readOnly (w:edit="readOnly") sample snippet from settings.xml |
boolean |
isEnforcedTrackedChangesProtection()
Verifies that the documentProtection tag in settings.xml file specifies that the protection is enforced (w:enforcement="1") and that the kind of protection is trackedChanges (w:edit="trackedChanges") sample snippet from settings.xml |
boolean |
removeBodyElement(int pos)
remove a BodyElement from bodyElements array list |
void |
removeProtectionEnforcement()
Remove protection enforcement. In the documentProtection tag inside settings.xml file it sets the value of enforcement to "0" (w:enforcement="0") |
void |
setParagraph(XWPFParagraph paragraph,
int pos)
copies content of a paragraph to a existing paragraph in the list paragraphs at position pos |
void |
setTable(int pos,
XWPFTable table)
Replace content of table in array tables at position pos with a |
Methods inherited from class org.apache.poi.POIXMLDocument |
---|
getPackage, getProperties, hasOOXMLHeader, openPackage, write |
Methods inherited from class org.apache.poi.POIXMLDocumentPart |
---|
createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelations, removeRelation, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public XWPFDocument(OPCPackage pkg) throws java.io.IOException
java.io.IOException
public XWPFDocument(java.io.InputStream is) throws java.io.IOException
java.io.IOException
public XWPFDocument()
Method Detail |
---|
public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDocument1 getDocument()
public java.util.List getBodyElements()
getBodyElements
in interface IBody
IBody.getBodyElements()
public java.util.List getParagraphs()
IBody
getParagraphs
in interface IBody
IBody.getParagraphs()
public java.util.List getTables()
IBody
getTables
in interface IBody
IBody.getTables()
public XWPFTable getTableArray(int pos)
IBody
getTableArray
in interface IBody
IBody.getTableArray(int)
public java.util.List getFooterList()
public XWPFFooter getFooterArray(int pos)
public java.util.List getHeaderList()
public XWPFHeader getHeaderArray(int pos)
public java.lang.String getTblStyle(XWPFTable table)
public XWPFHyperlink getHyperlinkByID(java.lang.String id)
public XWPFFootnote getFootnoteByID(int id)
public XWPFFootnote getEndnoteByID(int id)
public java.util.Collection getFootnotes()
public XWPFHyperlink[] getHyperlinks()
public XWPFComment getCommentByID(java.lang.String id)
public XWPFComment[] getComments()
public PackagePart getPartById(java.lang.String id)
public XWPFHeaderFooterPolicy getHeaderFooterPolicy()
public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTStyles getStyle() throws org.apache.xmlbeans.XmlException, java.io.IOException
org.apache.xmlbeans.XmlException
java.io.IOException
public java.util.List getAllEmbedds() throws OpenXML4JException
getAllEmbedds
in class POIXMLDocument
OpenXML4JException
public int getParagraphPos(int pos)
pos
- position of the paragraph in the bodyelement array list
public int getTablePos(int pos)
pos
- position of the table in the bodyelement array list
public XWPFParagraph insertNewParagraph(org.apache.xmlbeans.XmlCursor cursor)
insertNewParagraph
in interface IBody
cursor
- public XWPFTable insertNewTbl(org.apache.xmlbeans.XmlCursor cursor)
IBody
insertNewTbl
in interface IBody
public java.lang.Integer getPosOfParagraph(XWPFParagraph p)
p
- public java.lang.Integer getPosOfTable(XWPFTable t)
public XWPFParagraph createParagraph()
public boolean removeBodyElement(int pos)
pos
-
public void setParagraph(XWPFParagraph paragraph, int pos)
paragraph
- pos
- public XWPFParagraph getLastParagraph()
public XWPFTable createTable()
public XWPFTable createTable(int rows, int cols)
rows
- cols
-
public void createTOC()
public void setTable(int pos, XWPFTable table)
pos
- table
- public boolean isEnforcedReadonlyProtection()
<w:settings ... > <w:documentProtection w:edit="readOnly" w:enforcement="1"/>
public boolean isEnforcedFillingFormsProtection()
<w:settings ... > <w:documentProtection w:edit="forms" w:enforcement="1"/>
public boolean isEnforcedCommentsProtection()
<w:settings ... > <w:documentProtection w:edit="comments" w:enforcement="1"/>
public boolean isEnforcedTrackedChangesProtection()
<w:settings ... > <w:documentProtection w:edit="trackedChanges" w:enforcement="1"/>
public void enforceReadonlyProtection()
<w:settings ... > <w:documentProtection w:edit="readOnly" w:enforcement="1"/>
public void enforceFillingFormsProtection()
<w:settings ... > <w:documentProtection w:edit="forms" w:enforcement="1"/>
public void enforceCommentsProtection()
<w:settings ... > <w:documentProtection w:edit="comments" w:enforcement="1"/>
public void enforceTrackedChangesProtection()
<w:settings ... > <w:documentProtection w:edit="trackedChanges" w:enforcement="1"/>
public void removeProtectionEnforcement()
public void insertTable(int pos, XWPFTable table)
insertTable
in interface IBody
pos
- table
- public java.util.List getAllPictures()
public java.util.List getAllPackagePictures()
public int addPicture(java.io.InputStream is, int format) throws java.io.IOException, InvalidFormatException
is
- The stream to read image fromformat
- The format of the picture.
getAllPictures()
.
InvalidFormatException
java.io.IOException
public int addPicture(byte[] pictureData, int format) throws InvalidFormatException
pictureData
- The bytes to read image fromformat
- The format of the picture.
getAllPictures()
.
InvalidFormatException
public int getNextPicNameNumber(int format) throws InvalidFormatException
format
-
InvalidFormatException
public XWPFPictureData getPictureDataByID(java.lang.String blipID)
blipID
-
java.lang.Exception
public XWPFNumbering getNumbering()
public XWPFStyles getStyles()
public XWPFParagraph getParagraph(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP p)
getParagraph
in interface IBody
p
-
public XWPFTable getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl ctTbl)
getTable
in interface IBody
ctTbl
-
IBody.getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl)
public java.util.Iterator getTablesIterator()
public java.util.Iterator getParagraphsIterator()
public XWPFParagraph getParagraphArray(int pos)
getParagraphArray
in interface IBody
IBody.getParagraphArray(int)
public IBody getPart()
getPart
in interface IBody
IBody.getPart()
public BodyType getPartType()
getPartType
in interface IBody
IBody.getPartType()
public XWPFTableCell getTableCell(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc cell)
getTableCell
in interface IBody
cell
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |