Package org.apache.poi.xwpf.usermodel

Class XWPFFieldRun

java.lang.Object

org.apache.poi.xwpf.usermodel.XWPFRun

org.apache.poi.xwpf.usermodel.XWPFFieldRun

All Implemented Interfaces:

CharacterRun, IRunElement, ISDTContents

public class XWPFFieldRun
extends XWPFRun

A run of text which is part of a field, such as Title of Page number or Author. Any given Field may be made up of multiple of these.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.xwpf.usermodel.XWPFRun

XWPFRun.FontCharRange

Constructor Summary

Constructors

Constructor	Description
XWPFFieldRun(CTSimpleField field, CTR run, IRunBody p)

Method Summary

Modifier and Type	Method	Description
CTSimpleField	getCTField()
String	getFieldInstruction()
void	setFieldInstruction(String instruction)

Methods inherited from class org.apache.poi.xwpf.usermodel.XWPFRun

addBreak, addBreak, addBreak, addCarriageReturn, addChart, addPicture, addPicture, addTab, getCharacterSpacing, getColor, getCTR, getDocument, getEmbeddedPictures, getEmphasisMark, getFontFamily, getFontFamily, getFontName, getFontSize, getFontSizeAsDouble, getKerning, getLang, getParagraph, getParent, getPhonetic, getPictureText, getStyle, getText, getTextHighlightColor, getTextHightlightColor, getTextPosition, getTextScale, getUnderline, getUnderlineColor, getUnderlineThemeColor, getVerticalAlignment, isBold, isCapitalized, isDoubleStrikeThrough, isEmbossed, isHighlighted, isImprinted, isItalic, isShadowed, isSmallCaps, isStrike, isStrikeThrough, isVanish, removeBreak, removeCarriageReturn, removeTab, setBold, setCapitalized, setCharacterSpacing, setColor, setDoubleStrikethrough, setEmbossed, setEmphasisMark, setFontFamily, setFontFamily, setFontSize, setFontSize, setImprinted, setItalic, setKerning, setLang, setShadow, setSmallCaps, setStrike, setStrikeThrough, setStyle, setSubscript, setText, setText, setTextHighlightColor, setTextPosition, setTextScale, setUnderline, setUnderlineColor, setUnderlineThemeColor, setVanish, setVerticalAlignment, text, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

XWPFFieldRun

public XWPFFieldRun(CTSimpleField field,
 CTR run,
 IRunBody p)

Method Details

getCTField

@Internal
public CTSimpleField getCTField()

getFieldInstruction

public String getFieldInstruction()

setFieldInstruction

public void setFieldInstruction(String instruction)