Package org.apache.poi.hslf.usermodel
Class HSLFTextRun
java.lang.Object
org.apache.poi.hslf.usermodel.HSLFTextRun
- All Implemented Interfaces:
TextRun
Represents a run of text, all with the same style
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.poi.sl.usermodel.TextRun
TextRun.FieldType, TextRun.TextCap
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionHSLFTextRun
(HSLFTextParagraph parentParagraph) Create a new wrapper around a rich text string -
Method Summary
Modifier and TypeMethodDescriptionCreates a new hyperlink and assigns it to this text run.Experimental method to determine the field type, e.g.protected boolean
getFlag
(int index) Returns the font color.Get the font family - convenience method forTextRun.getFontInfo(FontGroup)
getFontFamily
(FontGroup fontGroup) Get the font family - convenience method forTextRun.getFontInfo(FontGroup)
int
Gets the font indexgetFontInfo
(FontGroup fontGroup) Get the font info for the given font groupReturns the font size which is either set directly on this text run or given from the slide layoutReturn the associated hyperlinkint
Get the length of the textbyte
Fetch the text, in raw storage formint
Gets the subscript/superscript optionboolean
isBold()
boolean
Is this text embossed?boolean
isItalic()
boolean
Does the text have a shadow?boolean
boolean
boolean
boolean
void
setBold
(boolean bold) Sets the bold statevoid
setCharacterStyle
(TextPropCollection characterStyle) void
setCharTextPropVal
(String propName, Integer val) Sets the value of the given Paragraph TextProp, add if requiredvoid
setEmbossed
(boolean flag) Is this text embossed?protected void
setFlag
(int index, boolean value) void
setFontColor
(int bgr) Sets color of the text, as a int bgr.void
setFontColor
(Color color) Sets the (solid) font color - convenience functionvoid
setFontColor
(PaintStyle color) Sets the font colorvoid
setFontFamily
(String typeface) Specifies the typeface, or name of the font that is to be used for this text run - convenience method for callingTextRun.setFontInfo(FontInfo, FontGroup)
with just a font namevoid
setFontFamily
(String typeface, FontGroup fontGroup) Specifies the typeface, or name of the font that is to be used for this text run - convenience method for callingTextRun.setFontInfo(FontInfo, FontGroup)
with just a font namevoid
setFontIndex
(int idx) Sets the font indexvoid
setFontInfo
(FontInfo fontInfo, FontGroup fontGroup) Specifies the font to be used for this text run.void
setFontSize
(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 layoutprotected void
setHyperlink
(HSLFHyperlink link) Sets the hyperlink - used when parsing the documentvoid
setItalic
(boolean italic) Sets the italic statevoid
setShadowed
(boolean flag) Does the text have a shadow?void
setStrikethrough
(boolean flag) Sets the strikethrough statevoid
setSuperscript
(int val) Sets the subscript/superscript optionvoid
Change the textvoid
setUnderlined
(boolean underlined) Sets the underlined statevoid
Supply the SlideShow we belong to
-
Field Details
-
logger
-
-
Constructor Details
-
HSLFTextRun
Create a new wrapper around a rich text string- Parameters:
parentParagraph
- the parent paragraph
-
-
Method Details
-
getCharacterStyle
-
setCharacterStyle
-
updateSheet
public void updateSheet()Supply the SlideShow we belong to -
getLength
public int getLength()Get the length of the text -
getRawText
Fetch the text, in raw storage form- Specified by:
getRawText
in interfaceTextRun
-
setText
Change the text -
getFlag
protected boolean getFlag(int index) -
setCharTextPropVal
Sets the value of the given Paragraph TextProp, add if required- Parameters:
propName
- The name of the Paragraph TextPropval
- The value to set for the TextProp
-
isBold
public boolean isBold() -
setBold
public void setBold(boolean bold) Description copied from interface:TextRun
Sets the bold state -
isItalic
public boolean isItalic() -
setItalic
public void setItalic(boolean italic) Description copied from interface:TextRun
Sets the italic state -
isUnderlined
public boolean isUnderlined()- Specified by:
isUnderlined
in interfaceTextRun
- Returns:
- true, if text is underlined
-
setUnderlined
public void setUnderlined(boolean underlined) Description copied from interface:TextRun
Sets the underlined state- Specified by:
setUnderlined
in interfaceTextRun
- Parameters:
underlined
- set to true for underlined text, false for no underlining
-
isShadowed
public boolean isShadowed()Does the text have a shadow? -
setShadowed
public void setShadowed(boolean flag) Does the text have a shadow? -
isEmbossed
public boolean isEmbossed()Is this text embossed? -
setEmbossed
public void setEmbossed(boolean flag) Is this text embossed? -
isStrikethrough
public boolean isStrikethrough()- Specified by:
isStrikethrough
in interfaceTextRun
- Returns:
- true, if text is stroked
-
setStrikethrough
public void setStrikethrough(boolean flag) Description copied from interface:TextRun
Sets the strikethrough state- Specified by:
setStrikethrough
in interfaceTextRun
- Parameters:
flag
- set to true for stroked text, false for no stroking
-
getSuperscript
public int getSuperscript()Gets the subscript/superscript option- Returns:
- the percentage of the font size. If the value is positive, it is superscript, otherwise it is subscript
-
setSuperscript
public void setSuperscript(int val) Sets the subscript/superscript option- Parameters:
val
- the percentage of the font size. If the value is positive, it is superscript, otherwise it is subscript
-
getFontSize
Description copied from interface:TextRun
Returns the font size which is either set directly on this text run or given from the slide layout- Specified by:
getFontSize
in interfaceTextRun
- Returns:
- font size in points or null if font size is not set.
-
setFontSize
Description copied from interface:TextRun
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- Specified by:
setFontSize
in interfaceTextRun
- Parameters:
fontSize
- font size in points, if null the underlying fontsize will be unset
-
getFontIndex
public int getFontIndex()Gets the font index -
setFontIndex
public void setFontIndex(int idx) Sets the font index -
setFontFamily
Description copied from interface:TextRun
Specifies the typeface, or name of the font that is to be used for this text run - convenience method for callingTextRun.setFontInfo(FontInfo, FontGroup)
with just a font name- Specified by:
setFontFamily
in interfaceTextRun
- Parameters:
typeface
- the font to apply to this text run. The value ofnull
removes the run specific font setting, so the default setting is activated again.
-
setFontFamily
Description copied from interface:TextRun
Specifies the typeface, or name of the font that is to be used for this text run - convenience method for callingTextRun.setFontInfo(FontInfo, FontGroup)
with just a font name- Specified by:
setFontFamily
in interfaceTextRun
- Parameters:
typeface
- the font to apply to this text run. The value ofnull
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. ifnull
, the font group matching the first character will be returned
-
setFontInfo
Description copied from interface:TextRun
Specifies the font to be used for this text run.- Specified by:
setFontInfo
in interfaceTextRun
- Parameters:
fontInfo
- the font to apply to this text run. The value ofnull
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, ifnull
.
-
getFontFamily
Description copied from interface:TextRun
Get the font family - convenience method forTextRun.getFontInfo(FontGroup)
- Specified by:
getFontFamily
in interfaceTextRun
- Returns:
- font family or null if not set
-
getFontFamily
Description copied from interface:TextRun
Get the font family - convenience method forTextRun.getFontInfo(FontGroup)
- Specified by:
getFontFamily
in interfaceTextRun
- Parameters:
fontGroup
- the font group, i.e. the range of glpyhs to be covered. ifnull
, the font group matching the first character will be returned- Returns:
- font family or null if not set
-
getFontInfo
Description copied from interface:TextRun
Get the font info for the given font group- Specified by:
getFontInfo
in interfaceTextRun
- Parameters:
fontGroup
- the font group, i.e. the range of glpyhs to be covered. ifnull
, the font group matching the first character will be returned- Returns:
- font info or
null
if not set
-
getFontColor
Description copied from interface:TextRun
Returns the font color. This usually returns aPaintStyle.SolidPaint
, but but also other classes are possible- Specified by:
getFontColor
in interfaceTextRun
- Returns:
- font color as PaintStyle
- See Also:
-
setFontColor
public void setFontColor(int bgr) Sets color of the text, as a int bgr. (PowerPoint stores as BlueGreenRed, not the more usual RedGreenBlue)- See Also:
-
setFontColor
Description copied from interface:TextRun
Sets the (solid) font color - convenience function- Specified by:
setFontColor
in interfaceTextRun
- Parameters:
color
- the color
-
setFontColor
Description copied from interface:TextRun
Sets the font color- Specified by:
setFontColor
in interfaceTextRun
- Parameters:
color
- the color- See Also:
-
setFlag
protected void setFlag(int index, boolean value) -
getTextParagraph
-
getTextCap
- Specified by:
getTextCap
in interfaceTextRun
-
isSubscript
public boolean isSubscript()- Specified by:
isSubscript
in interfaceTextRun
- Returns:
- true, if text is sub scripted
-
isSuperscript
public boolean isSuperscript()- Specified by:
isSuperscript
in interfaceTextRun
- Returns:
- true, if text is super scripted
-
getPitchAndFamily
public byte getPitchAndFamily()- Specified by:
getPitchAndFamily
in interfaceTextRun
- Returns:
- the pitch and family id or -1 if not applicable
-
setHyperlink
Sets the hyperlink - used when parsing the document- Parameters:
link
- the hyperlink
-
getHyperlink
Description copied from interface:TextRun
Return the associated hyperlink- Specified by:
getHyperlink
in interfaceTextRun
- Returns:
- the associated hyperlink or null if no hyperlink was set
-
createHyperlink
Description copied from interface:TextRun
Creates a new hyperlink and assigns it to this text run. If the text run has already a hyperlink assigned, return it instead- Specified by:
createHyperlink
in interfaceTextRun
- Returns:
- the associated hyperlink
-
getFieldType
Description copied from interface:TextRun
Experimental method to determine the field type, e.g. slide number- Specified by:
getFieldType
in interfaceTextRun
- Returns:
- the field type or
null
if text run is not a field
-