org.apache.poi.hslf.usermodel
Class HSLFTextRun

java.lang.Object
  extended by org.apache.poi.hslf.usermodel.HSLFTextRun
All Implemented Interfaces:
TextRun

public final class HSLFTextRun
extends java.lang.Object
implements 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.TextCap
 
Field Summary
protected  POILogger logger
           
 
Constructor Summary
HSLFTextRun(HSLFTextParagraph parentParagraph)
          Create a new wrapper around a rich text string
 
Method Summary
 HSLFHyperlink createHyperlink()
          Creates a new hyperlink and assigns it to this text run.
 TextPropCollection getCharacterStyle()
           
protected  boolean getFlag(int index)
           
 PaintStyle.SolidPaint getFontColor()
          Returns the font color.
 java.lang.String getFontFamily()
           
 int getFontIndex()
          Gets the font index
 java.lang.Double getFontSize()
          Returns the font size which is either set directly on this text run or given from the slide layout
 HSLFHyperlink getHyperlink()
          Return the associated hyperlink
 int getLength()
          Get the length of the text
 byte getPitchAndFamily()
           
 java.lang.String getRawText()
          Fetch the text, in raw storage form
 int getSuperscript()
          Gets the subscript/superscript option
 TextRun.TextCap getTextCap()
           
 HSLFTextParagraph getTextParagraph()
           
 boolean isBold()
           
 boolean isEmbossed()
          Is this text embossed?
 boolean isItalic()
           
 boolean isShadowed()
          Does the text have a shadow?
 boolean isStrikethrough()
           
 boolean isSubscript()
           
 boolean isSuperscript()
           
 boolean isUnderlined()
           
 void setBold(boolean bold)
          Sets the bold state
 void setCharacterStyle(TextPropCollection characterStyle)
           
 void setCharTextPropVal(java.lang.String propName, java.lang.Integer val)
          Sets the value of the given Paragraph TextProp, add if required
 void setEmbossed(boolean flag)
          Is this text embossed?
protected  void setFlag(int index, boolean value)
           
 void setFontColor(java.awt.Color color)
          Sets the (solid) font color - convenience function
 void setFontColor(int bgr)
          Sets color of the text, as a int bgr.
 void setFontColor(PaintStyle color)
          Sets the font color
 void setFontFamily(java.lang.String fontFamily)
          Specifies the typeface, or name of the font that is to be used for this text run.
 void setFontIndex(int idx)
          Sets the font index
 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
protected  void setHyperlink(HSLFHyperlink link)
          Sets the hyperlink - used when parsing the document
 void setItalic(boolean italic)
          Sets the italic state
 void setShadowed(boolean flag)
          Does the text have a shadow?
 void setStrikethrough(boolean flag)
          Sets the strikethrough state
 void setSuperscript(int val)
          Sets the subscript/superscript option
 void setText(java.lang.String text)
          Change the text
 void setUnderlined(boolean underlined)
          Sets the underlined state
 void updateSheet()
          Supply the SlideShow we belong to
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logger

protected POILogger logger
Constructor Detail

HSLFTextRun

public HSLFTextRun(HSLFTextParagraph parentParagraph)
Create a new wrapper around a rich text string

Parameters:
parentParagraph - the parent paragraph
Method Detail

getCharacterStyle

public TextPropCollection getCharacterStyle()

setCharacterStyle

public void setCharacterStyle(TextPropCollection characterStyle)

updateSheet

public void updateSheet()
Supply the SlideShow we belong to


getLength

public int getLength()
Get the length of the text


getRawText

public java.lang.String getRawText()
Fetch the text, in raw storage form

Specified by:
getRawText in interface TextRun

setText

public void setText(java.lang.String text)
Change the text

Specified by:
setText in interface TextRun

getFlag

protected boolean getFlag(int index)

setCharTextPropVal

public void setCharTextPropVal(java.lang.String propName,
                               java.lang.Integer val)
Sets the value of the given Paragraph TextProp, add if required

Parameters:
propName - The name of the Paragraph TextProp
val - The value to set for the TextProp

isBold

public boolean isBold()
Specified by:
isBold in interface TextRun
Returns:
true, if text is bold

setBold

public void setBold(boolean bold)
Description copied from interface: TextRun
Sets the bold state

Specified by:
setBold in interface TextRun
Parameters:
bold - set to true for bold text, false for normal weight

isItalic

public boolean isItalic()
Specified by:
isItalic in interface TextRun
Returns:
true, if text is italic

setItalic

public void setItalic(boolean italic)
Description copied from interface: TextRun
Sets the italic state

Specified by:
setItalic in interface TextRun
Parameters:
italic - set to true for italic text, false for non-italics

isUnderlined

public boolean isUnderlined()
Specified by:
isUnderlined in interface TextRun
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 interface TextRun
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 interface TextRun
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 interface TextRun
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

public java.lang.Double 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 interface TextRun
Returns:
font size in points or null if font size is not set.

setFontSize

public void setFontSize(java.lang.Double fontSize)
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 interface TextRun
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

public void setFontFamily(java.lang.String fontFamily)
Description copied from interface: TextRun
Specifies the typeface, or name of the font that is to be used for this text run.

Specified by:
setFontFamily in interface TextRun
Parameters:
fontFamily - the font to apply to this text run. The value of null unsets the Typeface attrubute from the underlying xml.

getFontFamily

public java.lang.String getFontFamily()
Specified by:
getFontFamily in interface TextRun
Returns:
font family or null if not set

getFontColor

public PaintStyle.SolidPaint getFontColor()
Description copied from interface: TextRun
Returns the font color. This usually returns a PaintStyle.SolidPaint, but but also other classes are possible

Specified by:
getFontColor in interface TextRun
Returns:
font color as PaintStyle
See Also:
DrawPaint.getPaint(java.awt.Graphics2D, PaintStyle), PaintStyle.SolidPaint.getSolidColor(), DrawPaint.applyColorTransform(ColorStyle)

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:
Color

setFontColor

public void setFontColor(java.awt.Color color)
Description copied from interface: TextRun
Sets the (solid) font color - convenience function

Specified by:
setFontColor in interface TextRun
Parameters:
color - the color

setFontColor

public void setFontColor(PaintStyle color)
Description copied from interface: TextRun
Sets the font color

Specified by:
setFontColor in interface TextRun
Parameters:
color - the color
See Also:
DrawPaint.createSolidPaint(Color)

setFlag

protected void setFlag(int index,
                       boolean value)

getTextParagraph

public HSLFTextParagraph getTextParagraph()

getTextCap

public TextRun.TextCap getTextCap()
Specified by:
getTextCap in interface TextRun

isSubscript

public boolean isSubscript()
Specified by:
isSubscript in interface TextRun
Returns:
true, if text is sub scripted

isSuperscript

public boolean isSuperscript()
Specified by:
isSuperscript in interface TextRun
Returns:
true, if text is super scripted

getPitchAndFamily

public byte getPitchAndFamily()
Specified by:
getPitchAndFamily in interface TextRun
Returns:
the pitch and family id or -1 if not applicable

setHyperlink

protected void setHyperlink(HSLFHyperlink link)
Sets the hyperlink - used when parsing the document

Parameters:
link - the hyperlink

getHyperlink

public HSLFHyperlink getHyperlink()
Description copied from interface: TextRun
Return the associated hyperlink

Specified by:
getHyperlink in interface TextRun
Returns:
the associated hyperlink or null if no hyperlink was set

createHyperlink

public HSLFHyperlink 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 interface TextRun
Returns:
the associated hyperlink


Copyright 2016 The Apache Software Foundation or its licensors, as applicable.