|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.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.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface org.apache.poi.sl.usermodel.TextRun |
|---|
TextRun.FieldType, TextRun.TextCap |
| Constructor Summary | |
|---|---|
protected |
XSLFTextRun(org.apache.xmlbeans.XmlObject r,
XSLFTextParagraph p)
|
| Method Summary | |
|---|---|
XSLFHyperlink |
createHyperlink()
Creates a new hyperlink and assigns it to this text run. |
double |
getCharacterSpacing()
|
TextRun.FieldType |
getFieldType()
Experimental method to determine the field type, e.g. |
PaintStyle |
getFontColor()
Returns the font color. |
java.lang.String |
getFontFamily()
Get the font family - convenience method for TextRun.getFontInfo(FontGroup) |
java.lang.String |
getFontFamily(FontGroup fontGroup)
Get the font family - convenience method for TextRun.getFontInfo(FontGroup) |
FontInfo |
getFontInfo(FontGroup fontGroup)
Get the font info for the given font group |
java.lang.Double |
getFontSize()
Returns the font size which is either set directly on this text run or given from the slide layout |
XSLFHyperlink |
getHyperlink()
Return the associated hyperlink |
byte |
getPitchAndFamily()
|
java.lang.String |
getRawText()
|
protected org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties |
getRPr(boolean create)
Return the character properties |
TextRun.TextCap |
getTextCap()
|
org.apache.xmlbeans.XmlObject |
getXmlObject()
Return the text run xmlbeans object. |
boolean |
isBold()
|
boolean |
isItalic()
|
boolean |
isStrikethrough()
|
boolean |
isSubscript()
|
boolean |
isSuperscript()
|
boolean |
isUnderlined()
|
void |
setBaselineOffset(double baselineOffset)
Set the baseline for both the superscript and subscript fonts. |
void |
setBold(boolean bold)
Sets the bold state |
void |
setCharacterSpacing(double spc)
Set the spacing between characters within a text run. |
void |
setFontColor(java.awt.Color color)
Sets the (solid) font color - convenience function |
void |
setFontColor(PaintStyle color)
Sets the font color |
void |
setFontFamily(java.lang.String typeface)
Specifies the typeface, or name of the font that is to be used for this text run - convenience method for calling TextRun.setFontInfo(FontInfo, FontGroup) with just a font name |
void |
setFontFamily(java.lang.String typeface,
FontGroup fontGroup)
Specifies the typeface, or name of the font that is to be used for this text run - convenience method for calling TextRun.setFontInfo(FontInfo, FontGroup) with just a font name |
void |
setFontInfo(FontInfo fontInfo,
FontGroup fontGroup)
Specifies the font to be used for this text run. |
void |
setFontSize(java.lang.Double fontSize)
Sets the font size directly on this text run, if null is given, the font size defaults to the values given from the slide layout |
void |
setItalic(boolean italic)
Sets the italic state |
void |
setStrikethrough(boolean strike)
Sets the strikethrough state |
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 |
setText(java.lang.String text)
|
void |
setUnderlined(boolean underline)
Sets the underlined state |
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
protected XSLFTextRun(org.apache.xmlbeans.XmlObject r,
XSLFTextParagraph p)
| Method Detail |
|---|
public java.lang.String getRawText()
getRawText in interface TextRunpublic void setText(java.lang.String text)
setText in interface TextRunpublic org.apache.xmlbeans.XmlObject getXmlObject()
CTTextField,
CTTextLineBreak or usually a CTRegularTextRun
public void setFontColor(java.awt.Color color)
TextRun
setFontColor in interface TextRuncolor - the colorpublic void setFontColor(PaintStyle color)
TextRun
setFontColor in interface TextRuncolor - the colorDrawPaint.createSolidPaint(Color)public PaintStyle getFontColor()
TextRunPaintStyle.SolidPaint, but but also other classes are possible
getFontColor in interface TextRunDrawPaint.getPaint(java.awt.Graphics2D, PaintStyle),
PaintStyle.SolidPaint.getSolidColor(),
DrawPaint.applyColorTransform(ColorStyle)public void setFontSize(java.lang.Double fontSize)
TextRun
setFontSize in interface TextRunfontSize - font size in points, if null the underlying fontsize will be unsetpublic java.lang.Double getFontSize()
TextRun
getFontSize in interface TextRunpublic 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)
TextRunTextRun.setFontInfo(FontInfo, FontGroup) with just a font name
setFontFamily in interface TextRuntypeface - the font to apply to this text run.
The value of null removes the run specific font setting, so the default setting is activated again.
public void setFontFamily(java.lang.String typeface,
FontGroup fontGroup)
TextRunTextRun.setFontInfo(FontInfo, FontGroup) with just a font name
setFontFamily in interface TextRuntypeface - the font to apply to this text run.
The value of null removes the run specific font setting, so the default setting is activated again.fontGroup - the font group, i.e. the range of glpyhs to be covered.
if null, the font group matching the first character will be returned
public void setFontInfo(FontInfo fontInfo,
FontGroup fontGroup)
TextRun
setFontInfo in interface TextRunfontInfo - the font to apply to this text run.
The value of null removes the run specific font setting, so the default setting is activated again.fontGroup - the font group, i.e. the range of glpyhs to be covered. defaults to latin, if null.public java.lang.String getFontFamily()
TextRunTextRun.getFontInfo(FontGroup)
getFontFamily in interface TextRunpublic java.lang.String getFontFamily(FontGroup fontGroup)
TextRunTextRun.getFontInfo(FontGroup)
getFontFamily in interface TextRunfontGroup - the font group, i.e. the range of glpyhs to be covered.
if null, the font group matching the first character will be returned
public FontInfo getFontInfo(FontGroup fontGroup)
TextRun
getFontInfo in interface TextRunfontGroup - the font group, i.e. the range of glpyhs to be covered.
if null, the font group matching the first character will be returned
null if not setpublic byte getPitchAndFamily()
getPitchAndFamily in interface TextRunpublic void setStrikethrough(boolean strike)
TextRun
setStrikethrough in interface TextRunstrike - set to true for stroked text, false for no strokingpublic boolean isStrikethrough()
isStrikethrough in interface TextRunpublic boolean isSuperscript()
isSuperscript in interface TextRunpublic void setBaselineOffset(double baselineOffset)
The size is specified using a percentage. Positive values indicate superscript, negative values indicate subscript.
baselineOffset - public void setSuperscript(boolean flag)
setBaselineOffset(double)public void setSubscript(boolean flag)
setBaselineOffset(double)public boolean isSubscript()
isSubscript in interface TextRunpublic TextRun.TextCap getTextCap()
getTextCap in interface TextRunpublic void setBold(boolean bold)
TextRun
setBold in interface TextRunbold - set to true for bold text, false for normal weightpublic boolean isBold()
isBold in interface TextRunpublic void setItalic(boolean italic)
TextRun
setItalic in interface TextRunitalic - set to true for italic text, false for non-italicspublic boolean isItalic()
isItalic in interface TextRunpublic void setUnderlined(boolean underline)
TextRun
setUnderlined in interface TextRununderline - set to true for underlined text, false for no underliningpublic boolean isUnderlined()
isUnderlined in interface TextRunprotected org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties getRPr(boolean create)
create - if true, create an empty character properties object if it doesn't exist
public java.lang.String toString()
toString in class java.lang.Objectpublic XSLFHyperlink createHyperlink()
TextRun
createHyperlink in interface TextRunpublic XSLFHyperlink getHyperlink()
TextRun
getHyperlink in interface TextRunpublic TextRun.FieldType getFieldType()
TextRun
getFieldType in interface TextRunnull if text run is not a field
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||