Example usage for Java org.apache.poi.xwpf.usermodel XWPFRun fields, constructors, methods, implement or subclass
The text is from its open source code.
| void | addBreak() Specifies that a break shall be placed at the current location in the run content. |
| void | addBreak(BreakType type) Specifies that a break shall be placed at the current location in the run content. |
| void | addBreak(BreakClear clear) Specifies that a break shall be placed at the current location in the run content. |
| void | addCarriageReturn() Specifies that a carriage return shall be placed at the current location in the run content. |
| XWPFPicture | addPicture(InputStream pictureData, int pictureType, String filename, int width, int height) Adds a picture to the run. |
| void | addTab() Specifies that a tab shall be placed at the current location in the run content. |
| int | getCharacterSpacing() |
| String | getColor() Get text color. |
| CTR | getCTR() Get the currently used CTR object |
| XWPFDocument | getDocument() |
| List | getEmbeddedPictures() Returns the embedded pictures of the run. |
| String | getFontFamily() Gets the fonts which shall be used to display the text contents of this run. |
| int | getFontSize() Specifies the font size which shall be applied to all non complex script characters in the contents of this run when displayed. |
| int | getKerning() |
| XWPFParagraph | getParagraph() Get the currently referenced paragraph, or null if a SDT object |
| IRunBody | getParent() Get the currently referenced paragraph/SDT object |
| String | getPictureText() Returns text embedded in pictures |
| VerticalAlign | getSubscript() Specifies the alignment which shall be applied to the contents of this run in relation to the default appearance of the run's text. |
| String | getText(int pos) Return the string content of this text run |
| int | getTextPosition() This element specifies the amount by which text shall be raised or lowered for this run in relation to the default baseline of the surrounding non-positioned text. |
| UnderlinePatterns | getUnderline() Get the underline setting for the run. |
| STVerticalAlignRun.Enum | getVerticalAlignment() Get the vertical alignment value |
| boolean | isBold() Whether the bold property shall be applied to all non-complex script characters in the contents of this run when displayed in a document |
| boolean | isCapitalized() |
| boolean | isDoubleStrikeThrough() Specifies that the contents of this run shall be displayed with a double horizontal line through the center of the line. |
| boolean | isEmbossed() |
| boolean | isHighlighted() |
| boolean | isImprinted() |
| boolean | isItalic() Whether the italic property should be applied to all non-complex script characters in the contents of this run when displayed in a document. |
| boolean | isShadowed() |
| boolean | isSmallCaps() |
| boolean | isStrike() |
| boolean | isStrikeThrough() Specifies that the contents of this run shall be displayed with a single horizontal line through the center of the line. |
| void | setBold(boolean value) Whether the bold property shall be applied to all non-complex script characters in the contents of this run when displayed in a document. |
| void | setCapitalized(boolean value) |
| void | setCharacterSpacing(int twips) |
| void | setColor(String rgbStr) Set text color. |
| void | setDoubleStrikethrough(boolean value) Specifies that the contents of this run shall be displayed with a double horizontal line through the center of the line. |
| void | setEmbossed(boolean value) |
| void | setFontFamily(String fontFamily) Specifies the fonts which shall be used to display the text contents of this run. |
| void | setFontSize(int size) Specifies the font size which shall be applied to all non complex script characters in the contents of this run when displayed. |
| void | setImprinted(boolean value) |
| void | setItalic(boolean value) Whether the bold property shall be applied to all non-complex script characters in the contents of this run when displayed in a document
This formatting property is a toggle property, which specifies that its behavior differs between its use within a style definition and its use as direct formatting. |
| void | setKerning(int kern) |
| void | setShadow(boolean value) |
| void | setSmallCaps(boolean value) |
| void | setStrike(boolean value) |
| void | setStrikeThrough(boolean value) Specifies that the contents of this run shall be displayed with a single horizontal line through the center of the line. |
| void | setSubscript(VerticalAlign valign) Specifies the alignment which shall be applied to the contents of this run in relation to the default appearance of the run's text. |
| void | setText(String value) Sets the text of this text run |
| void | setText(String value, int pos) Sets the text of this text run in the |
| void | setTextPosition(int val) This element specifies the amount by which text shall be raised or lowered for this run in relation to the default baseline of the surrounding non-positioned text. |
| void | setUnderline(UnderlinePatterns value) Specifies that the contents of this run should be displayed along with an underline appearing directly below the character height. |
| void | setVerticalAlignment(String verticalAlignment) Set the vertical alignment of the run. |
| String | text() Returns the string version of the text, with tabs and carriage returns in place of their xml equivalents. |
| String | toString() Returns the string version of the text and the phonetic string |