|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.xwpf.usermodel.XWPFFootnote
public class XWPFFootnote
Constructor Summary | |
---|---|
XWPFFootnote(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn note,
XWPFFootnotes xFootnotes)
|
|
XWPFFootnote(XWPFDocument document,
org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn body)
|
Method Summary | |
---|---|
XWPFParagraph |
addNewParagraph(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP paragraph)
add a new paragraph to the end of the footnote |
XWPFTable |
addNewTbl(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl table)
add a new table to the end of the footnote |
java.util.List<IBodyElement> |
getBodyElements()
Returns an Iterator with paragraphs and tables, in the order that they occur in the text. |
org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn |
getCTFtnEdn()
|
POIXMLDocumentPart |
getOwner()
|
XWPFParagraph |
getParagraph(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP p)
if there is a corresponding XWPFParagraph of the parameter ctTable in the paragraphList of this header or footer
the method will return this paragraph
if there is no corresponding XWPFParagraph the method will return null |
XWPFParagraph |
getParagraphArray(int pos)
Returns the paragraph that holds the text of the header or footer. |
java.util.List<XWPFParagraph> |
getParagraphs()
Returns the paragraph(s) that holds the text of the header or footer. |
POIXMLDocumentPart |
getPart()
returns the Part, to which the body belongs, which you need for adding relationship to other parts |
BodyType |
getPartType()
get the PartType of the body |
java.util.List<XWPFPictureData> |
getPictures()
|
XWPFTable |
getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl ctTable)
if there is a corresponding XWPFTable of the parameter ctTable in the tableList of this header
the method will return this table
if there is no corresponding XWPFTable the method will return null |
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 |
java.util.List<XWPFTable> |
getTables()
Return the table(s) that holds the text of the IBodyPart, for complex cases where a paragraph isn't used. |
XWPFDocument |
getXWPFDocument()
Return XWPFDocument |
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 |
java.util.Iterator<XWPFParagraph> |
iterator()
|
void |
setCTFtnEdn(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn footnote)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XWPFFootnote(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn note, XWPFFootnotes xFootnotes)
public XWPFFootnote(XWPFDocument document, org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn body)
Method Detail |
---|
public java.util.List<XWPFParagraph> getParagraphs()
IBody
getParagraphs
in interface IBody
public java.util.Iterator<XWPFParagraph> iterator()
iterator
in interface java.lang.Iterable<XWPFParagraph>
public java.util.List<XWPFTable> getTables()
IBody
getTables
in interface IBody
public java.util.List<XWPFPictureData> getPictures()
public java.util.List<IBodyElement> getBodyElements()
IBody
getBodyElements
in interface IBody
public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn getCTFtnEdn()
public void setCTFtnEdn(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn footnote)
public XWPFTable getTableArray(int pos)
IBody
getTableArray
in interface IBody
pos
- in table array
IBody.getTableArray(int)
public void insertTable(int pos, XWPFTable table)
insertTable
in interface IBody
pos
- table
- IBody.insertTable(int pos, XWPFTable table)
public XWPFTable getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl ctTable)
XWPFTable
of the parameter ctTable in the tableList of this header
the method will return this table
if there is no corresponding XWPFTable
the method will return null
getTable
in interface IBody
ctTable
- IBody.getTable(CTTbl ctTable)
public XWPFParagraph getParagraph(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP p)
XWPFParagraph
of the parameter ctTable in the paragraphList of this header or footer
the method will return this paragraph
if there is no corresponding XWPFParagraph
the method will return null
getParagraph
in interface IBody
p
- is instance of CTP and is searching for an XWPFParagraph
IBody.getParagraph(CTP p)
public XWPFParagraph getParagraphArray(int pos)
getParagraphArray
in interface IBody
IBody.getParagraphArray(int pos)
public XWPFTableCell getTableCell(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc cell)
getTableCell
in interface IBody
cell
- IBody.getTableCell(CTTc cell)
public POIXMLDocumentPart getOwner()
public XWPFTable insertNewTbl(org.apache.xmlbeans.XmlCursor cursor)
IBody
insertNewTbl
in interface IBody
cursor
-
IBody.insertNewTbl(XmlCursor cursor)
public XWPFParagraph insertNewParagraph(org.apache.xmlbeans.XmlCursor cursor)
insertNewParagraph
in interface IBody
cursor
-
IBody.insertNewParagraph(XmlCursor cursor)
public XWPFTable addNewTbl(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl table)
table
-
public XWPFParagraph addNewParagraph(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP paragraph)
paragraph
-
public XWPFDocument getXWPFDocument()
IBody
getXWPFDocument
in interface IBody
IBody.getXWPFDocument()
public POIXMLDocumentPart getPart()
getPart
in interface IBody
IBody.getPart()
public BodyType getPartType()
getPartType
in interface IBody
IBody.getPartType()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |