|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.xwpf.usermodel.XWPFRun
public class XWPFRun
XWPFRun object defines a region of text with a common set of properties
Constructor Summary | |
---|---|
protected |
XWPFRun(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR r,
XWPFParagraph p)
|
Method Summary | |
---|---|
org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR |
getCTR()
|
java.lang.String |
getFontFamily()
Specifies the fonts which shall be used to display the text contents of this run. |
java.math.BigInteger |
getFontSize()
Specifies the font size which shall be applied to all non complex script characters in the contents of this run when displayed. |
XWPFParagraph |
getParagraph()
|
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. |
java.lang.String |
getText()
Return the string content of this text run |
java.math.BigInteger |
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()
Specifies that the contents of this run should be displayed along with an underline appearing directly below the character heigh |
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 |
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 |
isStrike()
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 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 |
setFontFamily(java.lang.String fontFamily)
Specifies the fonts which shall be used to display the text contents of this run. |
void |
setFontSize(java.math.BigInteger size)
Specifies the font size which shall be applied to all non complex script characters in the contents of this run when displayed. |
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 |
setStrike(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(java.lang.String value)
Sets the text of this text run |
void |
setTextPosition(java.math.BigInteger 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 heigh If this element is not present, the default value is to leave the formatting applied at previous level in the style hierarchy. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected XWPFRun(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR r, XWPFParagraph p)
r
- the CTR bean which holds the run attributesp
- the parent paragraphMethod Detail |
---|
public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR getCTR()
public XWPFParagraph getParagraph()
public boolean isBold()
true
if the bold property is appliedpublic void setBold(boolean value)
false
(or an equivalent) shall
result in the current setting remaining unchanged. However, when used as
direct formatting, setting this property to true or false shall set the
absolute state of the resulting property.
If this element is not present, the default value is to leave the
formatting applied at previous level in the style hierarchy. If this
element is never applied in the style hierarchy, then bold shall not be
applied to non-complex script characters.
value
- true
if the bold property is applied to
this runpublic java.lang.String getText()
null
if not setpublic void setText(java.lang.String value)
value
- the literal text which shall be displayed in the documentpublic boolean isItalic()
true
if the italic property is appliedpublic void setItalic(boolean value)
false
(or an equivalent) shall
result in the current setting remaining unchanged. However, when used as
direct formatting, setting this property to true or false shall set the
absolute state of the resulting property.
If this element is not present, the default value is to leave the
formatting applied at previous level in the style hierarchy. If this
element is never applied in the style hierarchy, then bold shall not be
applied to non-complex script characters.
value
- true
if the italic property is applied to
this runpublic UnderlinePatterns getUnderline()
UnderlinePatterns
public void setUnderline(UnderlinePatterns value)
value
- -
underline type: all possible patterns that could be applied
public boolean isStrike()
true
if the strike property is appliedpublic void setStrike(boolean value)
value
- true
if the strike property is applied to
this runpublic VerticalAlign getSubscript()
all possible value that could be applyed to this run
public void setSubscript(VerticalAlign valign)
valign
- VerticalAlign
public java.lang.String getFontFamily()
public void setFontFamily(java.lang.String fontFamily)
fontFamily
- public java.math.BigInteger getFontSize()
public void setFontSize(java.math.BigInteger size)
size
- public java.math.BigInteger getTextPosition()
public void setTextPosition(java.math.BigInteger val)
val
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |