Package org.apache.poi.hslf.usermodel

Class 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

    • Constructor Detail

      • HSLFTextRun

        public HSLFTextRun​(HSLFTextParagraph parentParagraph)
        Create a new wrapper around a rich text string
        Parameters:
        parentParagraph - the parent paragraph

    • Method Detail

      • 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

      • 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 typeface)
        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 calling TextRun.setFontInfo(FontInfo, FontGroup) with just a font name
        Specified by:
        setFontFamily in interface TextRun
        Parameters:
        typeface - 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.

      • setFontFamily

        public void setFontFamily​(java.lang.String typeface,
                          FontGroup fontGroup)
        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 calling TextRun.setFontInfo(FontInfo, FontGroup) with just a font name
        Specified by:
        setFontFamily in interface TextRun
        Parameters:
        typeface - 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

      • setFontInfo

        public void setFontInfo​(FontInfo fontInfo,
                        FontGroup fontGroup)
        Description copied from interface: TextRun
        Specifies the font to be used for this text run.
        Specified by:
        setFontInfo in interface TextRun
        Parameters:
        fontInfo - 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.

      • getFontFamily

        public java.lang.String getFontFamily​(FontGroup fontGroup)
        Description copied from interface: TextRun
        Get the font family - convenience method for TextRun.getFontInfo(FontGroup)
        Specified by:
        getFontFamily in interface TextRun
        Parameters:
        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
        Returns:
        font family or null if not set

      • getFontInfo

        public HSLFFontInfo getFontInfo​(FontGroup fontGroup)
        Description copied from interface: TextRun
        Get the font info for the given font group
        Specified by:
        getFontInfo in interface TextRun
        Parameters:
        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
        Returns:
        font info or null if not set

      • 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

      • 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

      • 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

      • getFieldType

        public TextRun.FieldType getFieldType()
        Description copied from interface: TextRun
        Experimental method to determine the field type, e.g. slide number
        Specified by:
        getFieldType in interface TextRun
        Returns:
        the field type or null if text run is not a field