|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.xslf.usermodel.XSLFTextRun
@Beta public class XSLFTextRun
Represents a run of text within the containing text body. The run element is the lowest level text separation mechanism within a text body.
Method Summary | |
---|---|
XSLFHyperlink |
createHyperlink()
|
double |
getCharacterSpacing()
|
java.awt.Color |
getFontColor()
|
java.lang.String |
getFontFamily()
|
double |
getFontSize()
|
XSLFHyperlink |
getHyperlink()
|
byte |
getPitchAndFamily()
|
protected org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties |
getRPr()
|
java.lang.String |
getText()
|
TextCap |
getTextCap()
|
org.openxmlformats.schemas.drawingml.x2006.main.CTRegularTextRun |
getXmlObject()
|
boolean |
isBold()
|
boolean |
isItalic()
|
boolean |
isStrikethrough()
|
boolean |
isSubscript()
|
boolean |
isSuperscript()
|
boolean |
isUnderline()
|
void |
setBold(boolean bold)
Specifies whether this run of text will be formatted as bold text |
void |
setCharacterSpacing(double spc)
Set the spacing between characters within a text run. |
void |
setFontColor(java.awt.Color color)
|
void |
setFontFamily(java.lang.String typeface)
Specifies the typeface, or name of the font that is to be used for this text run. |
void |
setFontFamily(java.lang.String typeface,
byte charset,
byte pictAndFamily,
boolean isSymbol)
|
void |
setFontSize(double fontSize)
|
void |
setItalic(boolean italic)
|
void |
setStrikethrough(boolean strike)
Specifies whether a run of text will be formatted as strikethrough text. |
void |
setText(java.lang.String text)
|
void |
setUnderline(boolean underline)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public java.lang.String getText()
public void setText(java.lang.String text)
public org.openxmlformats.schemas.drawingml.x2006.main.CTRegularTextRun getXmlObject()
public void setFontColor(java.awt.Color color)
public java.awt.Color getFontColor()
public void setFontSize(double fontSize)
fontSize
- font size in points.
The value of -1
unsets the Sz attribyte from the underlying xml beanpublic double getFontSize()
public double getCharacterSpacing()
public void setCharacterSpacing(double spc)
The spacing is specified in points. Positive values will cause the text to expand, negative values to condense.
spc
- character spacing in points.public void setFontFamily(java.lang.String typeface)
typeface
- the font to apply to this text run.
The value of null
unsets the Typeface attrubute from the underlying xml.public void setFontFamily(java.lang.String typeface, byte charset, byte pictAndFamily, boolean isSymbol)
public java.lang.String getFontFamily()
public byte getPitchAndFamily()
public void setStrikethrough(boolean strike)
strike
- whether a run of text will be formatted as strikethrough text.public boolean isStrikethrough()
public boolean isSuperscript()
public boolean isSubscript()
public TextCap getTextCap()
public void setBold(boolean bold)
bold
- whether this run of text will be formatted as bold textpublic boolean isBold()
public void setItalic(boolean italic)
italic
- whether this run of text is formatted as italic textpublic boolean isItalic()
public void setUnderline(boolean underline)
underline
- whether this run of text is formatted as underlined textpublic boolean isUnderline()
protected org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties getRPr()
public java.lang.String toString()
toString
in class java.lang.Object
public XSLFHyperlink createHyperlink()
public XSLFHyperlink getHyperlink()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |