public class DocxTool
extends java.lang.Object
DOCX toolbox
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
STYLE_NORMAL |
static java.lang.String |
STYLE_SUBTITLE |
static java.lang.String |
STYLE_TITLE |
Constructor and Description |
---|
DocxTool()
Empty constructor, use newDocument to generate the package.
|
DocxTool(java.io.File file)
Load from docx file
|
DocxTool(java.io.InputStream in)
Load from docx stream
|
Modifier and Type | Method and Description |
---|---|
boolean |
add(java.util.List<java.lang.Object> list)
Add objects at the main part
|
boolean |
add(java.lang.Object o)
Add something at the main part
|
void |
addNumberedParagraph(java.lang.String style,
long numId,
long level,
java.lang.String text)
Add a numbered paragraph
|
void |
addNumberedParagraph(java.lang.String style,
long numId,
long level,
java.lang.String text,
int bookmarkId,
java.lang.String bookmarkName)
Add a numbered paragraph with bookmark
|
void |
addNumbering()
Add the default numbering part
|
void |
addNumbering(java.lang.String xml)
Add a numbering part
|
void |
addPageBreak() |
void |
addParagraph(java.lang.String text) |
void |
addStyledParagraph(java.lang.String style,
java.lang.String text)
Add a styled paragraph
|
java.util.List<java.lang.Object> |
convert(java.lang.String xhtml)
Convert the XHTML to a list of docx objects.
|
void |
createBookmark(org.docx4j.wml.P p,
org.docx4j.wml.R r,
java.lang.String bookmark,
int id)
Surround the specified run in the specified paragraph with a bookmark
|
java.util.List<java.lang.Object> |
getContent()
Get all main contents
|
org.docx4j.wml.P.Hyperlink |
getHyperlink(java.lang.String bookmark,
java.lang.String label)
Create a link to a bookmark (w:hyperlink)
|
org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart |
getMainPart()
Get the main document part
|
org.docx4j.wml.PPr |
getNum(java.lang.String style,
long numId,
long level) |
org.docx4j.wml.P |
getNumberedParagraph(java.lang.String style,
long numId,
long level,
java.lang.String text) |
org.docx4j.wml.P |
getNumberedParagraph(java.lang.String style,
long numId,
long level,
java.lang.String text,
int bookmarkId,
java.lang.String bookmarkName) |
org.docx4j.openpackaging.packages.WordprocessingMLPackage |
getPackage()
Get the whole document
|
org.docx4j.wml.Br |
getPageBreak()
Build a page break
|
org.docx4j.wml.P |
getParagraph(java.lang.String text)
Build a simple paragraph
|
org.docx4j.wml.R |
getRun(java.lang.String text)
Build a simple run
|
org.docx4j.wml.PPr |
getStyle(java.lang.String style) |
org.docx4j.wml.P |
getStyledParagraph(java.lang.String style,
java.lang.String text) |
java.lang.String |
getText(java.lang.Object obj)
Get the first text in the docx object
|
org.docx4j.wml.Text |
getText(java.lang.String text)
Build a simple text
|
java.util.List<java.lang.String> |
getTexts()
Get all texts in the document
|
java.util.List<java.lang.String> |
getTexts(java.lang.Object obj)
Get all texts in the docx object
|
java.lang.String |
getXmlNumbering(int numId)
Return w:numbering schema
|
void |
insert(int index,
java.lang.Object o)
Insert something in the main part
|
void |
insertPageBreak(int index) |
void |
insertParagraph(int index,
java.lang.String text) |
void |
newDocument()
Create a new default document
|
void |
newDocument(org.docx4j.model.structure.PageSizePaper sz,
boolean landscape)
Create a new document
|
void |
open(java.io.File file)
Open the document
|
void |
open(java.io.InputStream in)
Open the document
|
java.lang.Object |
remove(int index)
Remove something in the main part
|
java.lang.Object |
remove(java.lang.Object o)
Remove something in the main part
|
void |
replace(java.lang.String toFind,
java.lang.String replacer) |
void |
replaceBookmark(org.docx4j.wml.P p,
org.docx4j.wml.R r,
java.lang.String label,
java.lang.String bookmarkName)
Surround the label with a bookmark text
|
void |
save(java.io.File file)
Write the document into file
|
void |
save(java.io.OutputStream out)
Write the document into output stream
|
java.util.List<java.lang.Object> |
scan(java.lang.Object obj,
java.lang.Class<?> cls)
Search objects corresponding to the class
|
java.util.List<java.lang.Object> |
scan(java.lang.String xpath)
Search objects corresponding to the xpath
|
java.lang.String |
toXHTML(java.io.InputStream input,
java.lang.String encoding)
Convert any HTML to a well-formatted XHTML (jtidy implementation)
|
java.lang.String |
toXHTML(java.lang.String html,
java.lang.String encoding)
Convert any HTML to a well-formatted XHTML
|
public static final java.lang.String STYLE_NORMAL
public static final java.lang.String STYLE_TITLE
public static final java.lang.String STYLE_SUBTITLE
public DocxTool()
public DocxTool(java.io.File file)
public DocxTool(java.io.InputStream in)
public void open(java.io.File file)
file
- Docx filepublic void open(java.io.InputStream in)
in
- Docx input streampublic void newDocument()
public void newDocument(org.docx4j.model.structure.PageSizePaper sz, boolean landscape)
sz
- default is PageSizePaper.A4landscape
- horizontal or notpublic void addNumbering()
public void addNumbering(java.lang.String xml)
xml
- Numbering definition ex: getXmlNumbering(1234);public org.docx4j.openpackaging.packages.WordprocessingMLPackage getPackage()
public org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart getMainPart()
public java.util.List<java.lang.Object> getContent()
public java.util.List<java.lang.Object> scan(java.lang.String xpath)
xpath
- examples: //w:t to search all texts; //w:p paragraphs...public java.util.List<java.lang.Object> scan(java.lang.Object obj, java.lang.Class<?> cls)
obj
- starting pointcls
- examples: Text.class for texts, P.class to search paragraphs...public java.lang.String getText(java.lang.Object obj)
public java.util.List<java.lang.String> getTexts(java.lang.Object obj)
public java.util.List<java.lang.String> getTexts()
public void replace(java.lang.String toFind, java.lang.String replacer)
public void save(java.io.File file)
public void save(java.io.OutputStream out)
public boolean add(java.lang.Object o)
public boolean add(java.util.List<java.lang.Object> list)
public void insert(int index, java.lang.Object o)
public java.lang.Object remove(int index)
public java.lang.Object remove(java.lang.Object o)
public org.docx4j.wml.Text getText(java.lang.String text)
public org.docx4j.wml.R getRun(java.lang.String text)
public org.docx4j.wml.P getParagraph(java.lang.String text)
public void addParagraph(java.lang.String text)
public void insertParagraph(int index, java.lang.String text)
public org.docx4j.wml.Br getPageBreak()
public void addPageBreak()
public void insertPageBreak(int index)
public org.docx4j.wml.PPr getStyle(java.lang.String style)
public org.docx4j.wml.PPr getNum(java.lang.String style, long numId, long level)
public org.docx4j.wml.P getNumberedParagraph(java.lang.String style, long numId, long level, java.lang.String text)
public org.docx4j.wml.P getNumberedParagraph(java.lang.String style, long numId, long level, java.lang.String text, int bookmarkId, java.lang.String bookmarkName)
public void addNumberedParagraph(java.lang.String style, long numId, long level, java.lang.String text)
style
- Default is NormalnumId
- Numbering idlevel
- Leveltext
- Textpublic void addNumberedParagraph(java.lang.String style, long numId, long level, java.lang.String text, int bookmarkId, java.lang.String bookmarkName)
style
- Default is NormalnumId
- Numbering idlevel
- Leveltext
- Textpublic void addStyledParagraph(java.lang.String style, java.lang.String text)
style
- Default is Normaltext
- Textpublic org.docx4j.wml.P getStyledParagraph(java.lang.String style, java.lang.String text)
public void createBookmark(org.docx4j.wml.P p, org.docx4j.wml.R r, java.lang.String bookmark, int id)
p
- paragraphr
- runbookmark
- bookmark nameid
- bookmark idpublic org.docx4j.wml.P.Hyperlink getHyperlink(java.lang.String bookmark, java.lang.String label)
bookmark
- bookmark namelabel
- hyperlink labelpublic void replaceBookmark(org.docx4j.wml.P p, org.docx4j.wml.R r, java.lang.String label, java.lang.String bookmarkName)
public java.util.List<java.lang.Object> convert(java.lang.String xhtml)
public java.lang.String toXHTML(java.lang.String html, java.lang.String encoding)
html
- Sourceencoding
- Use the platform encoding when nullpublic java.lang.String toXHTML(java.io.InputStream input, java.lang.String encoding)
input
- HTML as input streamencoding
- Use the platform encoding when nullpublic java.lang.String getXmlNumbering(int numId)
Copyright (c)2006-2014 Simplicite Software. All Rights Reserved.