Package io.keikai.doc.io.schema.docx

Class DOCXDocument

java.lang.Object

io.keikai.doc.io.schema.docx.AbstractVisitable

io.keikai.doc.io.schema.docx.AbstractBody

io.keikai.doc.io.schema.docx.DOCXDocument

All Implemented Interfaces:

ICTElement, IDOCXVisitable<java.lang.Object>, IXWPFElement

public class DOCXDocument
extends AbstractBody

Internal Use Only.

Document Definition.

Represents w:document in xml.

Author:

Jamson Chan

Field Summary

Fields inherited from class io.keikai.doc.io.schema.docx.AbstractBody

_bodyElements

Constructor Summary

Constructors

Constructor	Description
DOCXDocument(org.apache.poi.xwpf.usermodel.XWPFDocument xwpfDocument)	Create a new Document by given XWPFDocument.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	accept(IDOCXVisitor visitor)	Accepts a visitor.
DOCXP	createParagraph()	Create a new Paragraph.
DOCXTbl	createTable()	Create a new Table.
org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDocument1	getCT()	Returns the CT object of current element.
DOCXFtr	getFooterById(java.lang.String id)	Returns the DOCXFtr by the given id.
DOCXHdr	getHeaderById(java.lang.String id)	Returns the DOCXHdr by the given id.
IXWPFElement	getParent()	Returns the parent element of current element.
DOCXSectPr	getSectPr()	Returns the DOCXSectPr of this document (equals to the last section of the whole docx file).
DOCXSectPr	getSectPr(boolean create)	Returns the DOCXSectPr of this document (equals to the last section of the whole docx file).
DOCXSettings	getSettings()	Returns the settings of this document.
org.apache.poi.xwpf.usermodel.XWPFDocument	getXWPF()	Returns the XWPF object of current element.
void	write(java.io.OutputStream os)	Write the document to the given file output stream.

Methods inherited from class io.keikai.doc.io.schema.docx.AbstractBody

getBodyElements

Methods inherited from class io.keikai.doc.io.schema.docx.AbstractVisitable

addTempData, getTempData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DOCXDocument

public DOCXDocument(org.apache.poi.xwpf.usermodel.XWPFDocument xwpfDocument)

Create a new Document by given XWPFDocument.

Parameters:

xwpfDocument - the XWPFDocument object.

Method Detail

getCT

public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDocument1 getCT()

Description copied from interface: ICTElement

Returns the CT object of current element.

accept

public java.lang.Object accept(IDOCXVisitor visitor)

Description copied from interface: IDOCXVisitable

Accepts a visitor.

getXWPF

public org.apache.poi.xwpf.usermodel.XWPFDocument getXWPF()

Description copied from interface: IXWPFElement

Returns the XWPF object of current element.

Specified by:

getXWPF in interface IXWPFElement

Overrides:

getXWPF in class AbstractBody

getParent

public IXWPFElement getParent()

Description copied from interface: IXWPFElement

Returns the parent element of current element.

write

public void write(java.io.OutputStream os)
           throws java.io.IOException

Write the document to the given file output stream.

Parameters:

os - the OutputStream.

Throws:

java.io.IOException - if an I/O error occurs.

getSettings

public DOCXSettings getSettings()

Returns the settings of this document.

Represents the xml file at word/settings.xml.

Returns:

the DOCXSettings object.

createParagraph

public DOCXP createParagraph()

Description copied from class: AbstractBody

Create a new Paragraph.

Specified by:

createParagraph in class AbstractBody

Returns:

the new Paragraph.

createTable

public DOCXTbl createTable()

Description copied from class: AbstractBody

Create a new Table.

Specified by:

createTable in class AbstractBody

Returns:

the new Table.

getSectPr

public DOCXSectPr getSectPr()

Returns the DOCXSectPr of this document (equals to the last section of the whole docx file).

Returns:

the DOCXSectPr object.

getSectPr

public DOCXSectPr getSectPr(boolean create)

Returns the DOCXSectPr of this document (equals to the last section of the whole docx file).

Represents the following element tag in the schema: w:sectPr.

Parameters:

create - whether to create a new section properties if not exist.

Returns:

the DOCXSectPr object.

getHeaderById

public DOCXHdr getHeaderById(java.lang.String id)

Returns the DOCXHdr by the given id.

Parameters:

id - the header id.

Returns:

the DOCXHdr object.

getFooterById

public DOCXFtr getFooterById(java.lang.String id)

Returns the DOCXFtr by the given id.

Parameters:

id - the footer id.

Returns:

the DOCXFtr object.