Package org.apache.poi.xssf.usermodel
Class XSSFTextRun
java.lang.Object
org.apache.poi.xssf.usermodel.XSSFTextRun
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
Modifier and TypeMethodDescriptiondouble
double
byte
protected org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties
getRPr()
getText()
org.openxmlformats.schemas.drawingml.x2006.main.CTRegularTextRun
boolean
isBold()
boolean
isItalic()
boolean
boolean
boolean
boolean
void
setBaselineOffset
(double baselineOffset) Set the baseline for both the superscript and subscript fonts.void
setBold
(boolean bold) Specifies whether this run of text will be formatted as bold textvoid
setCharacterSpacing
(double spc) Set the spacing between characters within a text run.void
Specifies the typeface, or name of the font that is to be used for this text run.void
setFontColor
(Color color) void
setFontFamily
(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
setSubscript
(boolean flag) Set whether the text in this run is formatted as subscript.void
setSuperscript
(boolean flag) Set whether the text in this run is formatted as superscript.void
void
setUnderline
(boolean underline) toString()
-
Method Details
-
getText
-
setText
-
getXmlObject
public org.openxmlformats.schemas.drawingml.x2006.main.CTRegularTextRun getXmlObject() -
setFontColor
-
getFontColor
-
setFontSize
public void setFontSize(double fontSize) - Parameters:
fontSize
- font size in points. The value of-1
unsets the Sz attribute from the underlying xml bean
-
getFontSize
public double getFontSize()- Returns:
- font size in points or -1 if font size is not set.
-
getCharacterSpacing
public double getCharacterSpacing()- Returns:
- the spacing between characters within a text run, If this attribute is omitted then a value of 0 or no adjustment is assumed.
-
setCharacterSpacing
public void setCharacterSpacing(double spc) Set the spacing between characters within a text run.The spacing is specified in points. Positive values will cause the text to expand, negative values to condense.
- Parameters:
spc
- character spacing in points.
-
setFont
Specifies the typeface, or name of the font that is to be used for this text run.- Parameters:
typeface
- the font to apply to this text run. The value ofnull
unsets the Typeface attribute from the underlying xml.
-
setFontFamily
-
getFontFamily
- Returns:
- font family or null if not set
-
getPitchAndFamily
public byte getPitchAndFamily() -
setStrikethrough
public void setStrikethrough(boolean strike) Specifies whether a run of text will be formatted as strikethrough text.- Parameters:
strike
- whether a run of text will be formatted as strikethrough text.
-
isStrikethrough
public boolean isStrikethrough()- Returns:
- whether a run of text will be formatted as strikethrough text. Default is false.
-
isSuperscript
public boolean isSuperscript()- Returns:
- whether a run of text will be formatted as a superscript text. Default is false.
-
setBaselineOffset
public void setBaselineOffset(double baselineOffset) Set the baseline for both the superscript and subscript fonts.The size is specified using a percentage. Positive values indicate superscript, negative values indicate subscript.
- Parameters:
baselineOffset
-
-
setSuperscript
public void setSuperscript(boolean flag) Set whether the text in this run is formatted as superscript. Default base line offset is 30%- See Also:
-
setSubscript
public void setSubscript(boolean flag) Set whether the text in this run is formatted as subscript. Default base line offset is -25%.- See Also:
-
isSubscript
public boolean isSubscript()- Returns:
- whether a run of text will be formatted as a superscript text. Default is false.
-
getTextCap
- Returns:
- whether a run of text will be formatted as a superscript text. Default is false.
-
setBold
public void setBold(boolean bold) Specifies whether this run of text will be formatted as bold text- Parameters:
bold
- whether this run of text will be formatted as bold text
-
isBold
public boolean isBold()- Returns:
- whether this run of text is formatted as bold text
-
setItalic
public void setItalic(boolean italic) - Parameters:
italic
- whether this run of text is formatted as italic text
-
isItalic
public boolean isItalic()- Returns:
- whether this run of text is formatted as italic text
-
setUnderline
public void setUnderline(boolean underline) - Parameters:
underline
- whether this run of text is formatted as underlined text
-
isUnderline
public boolean isUnderline()- Returns:
- whether this run of text is formatted as underlined text
-
getRPr
protected org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties getRPr() -
toString
-