Package org.apache.poi.xwpf.usermodel
Class XWPFTableCell
- java.lang.Object
-
- org.apache.poi.xwpf.usermodel.XWPFTableCell
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXWPFTableCell.XWPFVertAlign
-
Constructor Summary
Constructors Constructor Description XWPFTableCell(CTTc cell, XWPFTableRow tableRow, IBody part)If a table cell does not include at least one block-level element, then this document shall be considered corrupt
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description XWPFParagraphaddParagraph()Add a Paragraph to this Table CellvoidaddParagraph(XWPFParagraph p)add a Paragraph to this TableCelljava.util.List<IBodyElement>getBodyElements()returns an Iterator with paragraphs and tablesjava.lang.StringgetColor()Get cell color.CTTcgetCTTc()XWPFParagraphgetParagraph(CTP p)Returns the paragraph corresponding to the providedCTP.XWPFParagraphgetParagraphArray(int pos)Returns the paragraph that of position posjava.util.List<XWPFParagraph>getParagraphs()returns a list of paragraphsPOIXMLDocumentPartgetPart()get the to which the TableCell belongsBodyTypegetPartType()get the PartType of the body, for example DOCUMENT, HEADER, FOOTER, FOOTNOTE,XWPFTablegetTable(CTTbl ctTable)get a table by its CTTbl-ObjectXWPFTablegetTableArray(int pos)Returns the table at position posXWPFTableCellgetTableCell(CTTc cell)get the TableCell which belongs to the TableCellXWPFTableRowgetTableRow()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.java.lang.StringgetText()java.lang.StringgetTextRecursively()extracts all text recursively through embedded tables and embedded SDTsXWPFTableCell.XWPFVertAligngetVerticalAlignment()Get the vertical alignment of the cell.intgetWidth()doublegetWidthDecimal()Get the table width as a decimal value.TableWidthTypegetWidthType()Get the width type for the table, as anSTTblWidth.Enumvalue.XWPFDocumentgetXWPFDocument()Return XWPFDocumentXWPFParagraphinsertNewParagraph(XmlCursor cursor)add a new paragraph at position of the cursorXWPFTableinsertNewTbl(XmlCursor cursor)inserts a new Table at the cursor position.voidinsertTable(int pos, XWPFTable table)inserts an existing XWPFTable to the arrays bodyElements and tablesvoidremoveParagraph(int pos)removes a paragraph of this tablecellvoidremoveTable(int pos)removes a table of this table cellvoidsetColor(java.lang.String rgbStr)Set cell color.voidsetParagraph(XWPFParagraph p)voidsetText(java.lang.String text)voidsetVerticalAlignment(XWPFTableCell.XWPFVertAlign vAlign)Set the vertical alignment of the cell.voidsetWidth(java.lang.String widthValue)Set the width to the value "auto", an integer value (20ths of a point), or a percentage ("nn.nn%").voidsetWidthType(TableWidthType widthType)Set the width value type for the table.
-
-
-
Constructor Detail
-
XWPFTableCell
public XWPFTableCell(CTTc cell, XWPFTableRow tableRow, IBody part)
If a table cell does not include at least one block-level element, then this document shall be considered corrupt
-
-
Method Detail
-
getBodyElements
public java.util.List<IBodyElement> getBodyElements()
returns an Iterator with paragraphs and tables- Specified by:
getBodyElementsin interfaceIBody
-
setParagraph
public void setParagraph(XWPFParagraph p)
-
getParagraphs
public java.util.List<XWPFParagraph> getParagraphs()
returns a list of paragraphs- Specified by:
getParagraphsin interfaceIBody
-
addParagraph
public XWPFParagraph addParagraph()
Add a Paragraph to this Table Cell- Returns:
- The paragraph which was added
-
addParagraph
public void addParagraph(XWPFParagraph p)
add a Paragraph to this TableCell- Parameters:
p- the paragraph which has to be added
-
removeParagraph
public void removeParagraph(int pos)
removes a paragraph of this tablecell- Parameters:
pos- The position in the list of paragraphs, 0-based
-
getParagraph
public XWPFParagraph getParagraph(CTP p)
Description copied from interface:IBodyReturns the paragraph corresponding to the providedCTP.- Specified by:
getParagraphin interfaceIBody- Parameters:
p- is instance of CTP and is searching for an XWPFParagraph- Returns:
- The paragraph corresponding to the
CTP, ornullif there is no corresponding paragraph in this body.
-
getTableRow
public XWPFTableRow getTableRow()
-
getColor
public java.lang.String getColor()
Get cell color. Note that this method only returns the "fill" value.- Returns:
- RGB string of cell color
-
setColor
public void setColor(java.lang.String rgbStr)
Set cell color. This sets some associated values; for finer control you may want to access these elements individually.- Parameters:
rgbStr- - the desired cell color, in the hex form "RRGGBB".
-
getVerticalAlignment
public XWPFTableCell.XWPFVertAlign getVerticalAlignment()
Get the vertical alignment of the cell.- Returns:
- the cell alignment enum value or
nullif no vertical alignment is set.
-
setVerticalAlignment
public void setVerticalAlignment(XWPFTableCell.XWPFVertAlign vAlign)
Set the vertical alignment of the cell.- Parameters:
vAlign- - the desired alignment enum value
-
insertNewParagraph
public XWPFParagraph insertNewParagraph(XmlCursor cursor)
add a new paragraph at position of the cursor- Specified by:
insertNewParagraphin interfaceIBody- Parameters:
cursor- The XmlCursor structure created with XmlBeans- Returns:
- the inserted paragraph
-
insertNewTbl
public XWPFTable insertNewTbl(XmlCursor cursor)
Description copied from interface:IBodyinserts a new Table at the cursor position.- Specified by:
insertNewTblin interfaceIBody
-
getParagraphArray
public XWPFParagraph getParagraphArray(int pos)
Description copied from interface:IBodyReturns the paragraph that of position pos- Specified by:
getParagraphArrayin interfaceIBody
-
getPart
public POIXMLDocumentPart getPart()
get the to which the TableCell belongs
-
getPartType
public BodyType getPartType()
Description copied from interface:IBodyget the PartType of the body, for example DOCUMENT, HEADER, FOOTER, FOOTNOTE,- Specified by:
getPartTypein interfaceIBody- Returns:
- the PartType of the body
-
getTableArray
public XWPFTable getTableArray(int pos)
Description copied from interface:IBodyReturns the table at position pos- Specified by:
getTableArrayin interfaceIBody
-
getTables
public java.util.List<XWPFTable> getTables()
Description copied from interface:IBodyReturn the table(s) that holds the text of the IBodyPart, for complex cases where a paragraph isn't used.
-
insertTable
public void insertTable(int pos, XWPFTable table)inserts an existing XWPFTable to the arrays bodyElements and tables- Specified by:
insertTablein interfaceIBody
-
removeTable
public void removeTable(int pos)
removes a table of this table cell- Parameters:
pos- The position in the list of tables, 0-based
-
getText
public java.lang.String getText()
-
setText
public void setText(java.lang.String text)
-
getTextRecursively
public java.lang.String getTextRecursively()
extracts all text recursively through embedded tables and embedded SDTs
-
getTableCell
public XWPFTableCell getTableCell(CTTc cell)
get the TableCell which belongs to the TableCell- Specified by:
getTableCellin interfaceIBody
-
getXWPFDocument
public XWPFDocument getXWPFDocument()
Description copied from interface:IBodyReturn XWPFDocument- Specified by:
getXWPFDocumentin interfaceIBody
-
getWidthDecimal
public double getWidthDecimal()
Get the table width as a decimal value.If the width type is DXA or AUTO, then the value will always have a fractional part of zero (because these values are really integers). If the with type is percentage, then value may have a non-zero fractional part.
- Returns:
- Width value as a double-precision decimal.
- Since:
- 4.0.0
-
getWidthType
public TableWidthType getWidthType()
Get the width type for the table, as anSTTblWidth.Enumvalue. A table width can be specified as an absolute measurement (an integer number of twips), a percentage, or the value "AUTO".- Returns:
- The width type.
- Since:
- 4.0.0
-
setWidth
public void setWidth(java.lang.String widthValue)
Set the width to the value "auto", an integer value (20ths of a point), or a percentage ("nn.nn%").- Parameters:
widthValue- String matching one of "auto", [0-9]+, or [0-9]+(\.[0-9]+)%.- Since:
- 4.0.0
-
setWidthType
public void setWidthType(TableWidthType widthType)
Set the width value type for the table.If the width type is changed from the current type and the currently-set value is not consistent with the new width type, the value is reset to the default value for the specified width type.
- Parameters:
widthType- Width type- Since:
- 4.0.0
-
getWidth
public int getWidth()
-
-