Java org.apache.poi.xwpf.usermodel XWPFParagraph fields, constructors, methods, implement or subclass

Introduction

In this page you can find the methods, fields and constructors for org.apache.poi.xwpf.usermodel XWPFParagraph.

The text is from its open source code.

Subclass

org.apache.poi.xwpf.usermodel.XWPFParagraph has subclasses.
Click this link to see all its subclasses.

Constructor

	XWPFParagraph(CTP prgrph, IBody part)

Method

XWPFRun	createRun() Appends a new run to this paragraph
ParagraphAlignment	getAlignment() Returns the paragraph alignment which shall be applied to text in this paragraph.
IBody	getBody()
Borders	getBorderBetween() Specifies the border which shall be displayed between each paragraph in a set of paragraphs which have the same set of paragraph border settings.
Borders	getBorderBottom() Specifies the border which shall be displayed below a set of paragraphs which have the same set of paragraph border settings.
Borders	getBorderLeft() Specifies the border which shall be displayed on the left side of the page around the specified paragraph.
Borders	getBorderRight() Specifies the border which shall be displayed on the right side of the page around the specified paragraph.
Borders	getBorderTop() Specifies the border which shall be displayed above a set of paragraphs which have the same set of paragraph border settings.
CTP	getCTP()
XWPFDocument	getDocument()
BodyElementType	getElementType() returns the type of the BodyElement Paragraph
String	getFootnoteText() Returns the footnote text of the paragraph
int	getIndentationFirstLine() Specifies the additional indentation which shall be applied to the first line of the parent paragraph.
int	getIndentationHanging() Specifies the indentation which shall be removed from the first line of the parent paragraph, by moving the indentation on the first line back towards the beginning of the direction of text flow.
int	getIndentationLeft() Specifies the indentation which shall be placed between the left text margin for this paragraph and the left edge of that paragraph's content in a left to right paragraph, and the right text margin and the right edge of that paragraph's text in a right to left paragraph If this attribute is omitted, its value shall be assumed to be zero.
int	getIndentationRight() Specifies the indentation which shall be placed between the right text margin for this paragraph and the right edge of that paragraph's content in a left to right paragraph, and the right text margin and the right edge of that paragraph's text in a right to left paragraph If this attribute is omitted, its value shall be assumed to be zero.
List	getIRuns() Return literal runs and sdt/content control objects.
String	getNumFmt() Returns numbering format for this paragraph, eg bullet or lowerLetter.
BigInteger	getNumID() If style exist for this paragraph NumId of the paragraph will be returned.
BigInteger	getNumIlvl() Returns Ilvl of the numeric style for this paragraph.
String	getParagraphText() Returns the text of the paragraph, but not of any objects in the paragraph
BodyType	getPartType() returns the partType of the bodyPart which owns the bodyElement
List	getRuns()
int	getSpacingAfter() Specifies the spacing that should be added after the last line in this paragraph in the document in absolute units.
int	getSpacingAfterLines() Specifies the spacing that should be added after the last line in this paragraph in the document in absolute units.
int	getSpacingBefore() Specifies the spacing that should be added above the first line in this paragraph in the document in absolute units.
int	getSpacingBeforeLines() Specifies the spacing that should be added before the first line in this paragraph in the document in line units.
LineSpacingRule	getSpacingLineRule() Specifies how the spacing between lines is calculated as stored in the line attribute.
String	getStyle()
String	getStyleID() Return styleID of the paragraph if style exist for this paragraph if not, null will be returned
String	getText() Return the textual content of the paragraph, including text from pictures and sdt elements in it.
TextAlignment	getVerticalAlignment() Returns the text vertical alignment which shall be applied to text in this paragraph.
XWPFRun	insertNewRun(int pos) insert a new Run in RunArray
boolean	removeRun(int pos) removes a Run at the position pos in the paragraph
TextSegment	searchText(String searched, PositionInParagraph startPos) this methods parse the paragraph and search for the string searched.
void	setAlignment(ParagraphAlignment align) Specifies the paragraph alignment which shall be applied to text in this paragraph.
void	setBorderBetween(Borders border) Specifies the border which shall be displayed between each paragraph in a set of paragraphs which have the same set of paragraph border settings.
void	setBorderBottom(Borders border) Specifies the border which shall be displayed below a set of paragraphs which have the same set of paragraph border settings.
void	setBorderLeft(Borders border) Specifies the border which shall be displayed on the left side of the page around the specified paragraph.
void	setBorderRight(Borders border) Specifies the border which shall be displayed on the right side of the page around the specified paragraph.
void	setBorderTop(Borders border) Specifies the border which shall be displayed above a set of paragraphs which have the same set of paragraph border settings.
void	setIndentationFirstLine(int indentation) Specifies the additional indentation which shall be applied to the first line of the parent paragraph.
void	setIndentationLeft(int indentation) Specifies the indentation which shall be placed between the left text margin for this paragraph and the left edge of that paragraph's content in a left to right paragraph, and the right text margin and the right edge of that paragraph's text in a right to left paragraph If this attribute is omitted, its value shall be assumed to be zero.
void	setNumID(BigInteger numPos) setNumID of Paragraph
void	setPageBreak(boolean pageBreak) Specifies that when rendering this document in a paginated view, the contents of this paragraph are rendered on the start of a new page in the document.
void	setSpacingAfter(int spaces) Specifies the spacing that should be added after the last line in this paragraph in the document in absolute units.
void	setSpacingBefore(int spaces) Specifies the spacing that should be added above the first line in this paragraph in the document in absolute units.
void	setSpacingLineRule(LineSpacingRule rule) Specifies how the spacing between lines is calculated as stored in the line attribute.
void	setStyle(String styleId) Set the style ID for the paragraph
void	setVerticalAlignment(TextAlignment valign) Specifies the text vertical alignment which shall be applied to text in this paragraph.
void	setWordWrap(boolean wrap)
void	setWordWrapped(boolean wrap) This element specifies whether a consumer shall break Latin text which exceeds the text extents of a line by breaking the word across two lines (breaking on the character level) or by moving the word to the following line (breaking on the word level).