Package org.apache.poi.xslf.usermodel

Class XSLFTextParagraph

    • Method Detail

      • getText

        public java.lang.String getText()

      • iterator

        public java.util.Iterator<XSLFTextRun> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<XSLFTextRun>

      • addNewTextRun

        public XSLFTextRun addNewTextRun()
        Add a new run of text
        Returns:
        a new run of text

      • addLineBreak

        public XSLFTextRun addLineBreak()
        Insert a line break
        Returns:
        text run representing this line break ('\n')

      • setFontAlign

        public void setFontAlign​(TextParagraph.FontAlign align)
        Specifies the font alignment that is to be applied to the paragraph. Possible values for this include auto, top, center, baseline and bottom. see TextParagraph.FontAlign.
        Parameters:
        align - font align

      • getBulletFont

        public java.lang.String getBulletFont()
        Returns:
        the font to be used on bullet characters within a given paragraph

      • setBulletFont

        public void setBulletFont​(java.lang.String typeface)

      • getBulletCharacter

        public java.lang.String getBulletCharacter()
        Returns:
        the character to be used in place of the standard bullet point

      • setBulletCharacter

        public void setBulletCharacter​(java.lang.String str)

      • getBulletFontColor

        public PaintStyle getBulletFontColor()
        Returns:
        the color of bullet characters within a given paragraph. A null value means to use the text font color.

      • setBulletFontColor

        public void setBulletFontColor​(java.awt.Color color)

      • setBulletFontColor

        public void setBulletFontColor​(PaintStyle color)
        Set the color to be used on bullet characters within a given paragraph.
        Parameters:
        color - the bullet color

      • getBulletFontSize

        public java.lang.Double getBulletFontSize()
        Returns the bullet size that is to be used within a paragraph. This may be specified in two different ways, percentage spacing and font point spacing:

        If bulletSize >= 0, then bulletSize is a percentage of the font size. If bulletSize < 0, then it specifies the size in points

        Returns:
        the bullet size

      • setBulletFontSize

        public void setBulletFontSize​(double bulletSize)
        Sets the bullet size that is to be used within a paragraph. This may be specified in two different ways, percentage spacing and font point spacing:

        If bulletSize >= 0, then bulletSize is a percentage of the font size. If bulletSize < 0, then it specifies the size in points

      • getAutoNumberingScheme

        public AutoNumberingScheme getAutoNumberingScheme()
        Returns:
        the auto numbering scheme, or null if not defined

      • getAutoNumberingStartAt

        public java.lang.Integer getAutoNumberingStartAt()
        Returns:
        the auto numbering starting number, or null if not defined

      • setIndent

        public void setIndent​(java.lang.Double indent)
        Description copied from interface: TextParagraph
        Specifies the indent size that will be applied to the first line of text in the paragraph.
        Specified by:
        setIndent in interface TextParagraph<XSLFShape,​XSLFTextParagraph,​XSLFTextRun>
        Parameters:
        indent - the indent (in points) applied to the first line of text in the paragraph

      • setLeftMargin

        public void setLeftMargin​(java.lang.Double leftMargin)
        Description copied from interface: TextParagraph
        Specifies the left margin of the paragraph. This is specified in addition to the text body inset and applies only to this text paragraph. That is the text body Inset and the LeftMargin attributes are additive with respect to the text position.
        Specified by:
        setLeftMargin in interface TextParagraph<XSLFShape,​XSLFTextParagraph,​XSLFTextRun>
        Parameters:
        leftMargin - the left margin (in points) or null to unset

      • getRightMargin

        public java.lang.Double getRightMargin()
        Description copied from interface: TextParagraph
        Specifies the right margin of the paragraph. This is specified in addition to the text body inset and applies only to this text paragraph. That is the text body Inset and the RightMargin attributes are additive with respect to the text position. The right margin is not support and therefore ignored by the HSLF implementation.
        Specified by:
        getRightMargin in interface TextParagraph<XSLFShape,​XSLFTextParagraph,​XSLFTextRun>
        Returns:
        the right margin of the paragraph, null if unset

      • getTabStop

        public double getTabStop​(int idx)

      • addTabStop

        public void addTabStop​(double value)

      • setLineSpacing

        public void setLineSpacing​(java.lang.Double lineSpacing)
        Description copied from interface: TextParagraph
        This element specifies the vertical line spacing that is to be used within a paragraph. This may be specified in two different ways, percentage spacing and font point spacing:

        If linespacing >= 0, then linespacing is a percentage of normal line height If linespacing < 0, the absolute value of linespacing is the spacing in points

        Examples: 
        
      // spacing will be 120% of the size of the largest text on each line
      paragraph.setLineSpacing(120);

      // spacing will be 200% of the size of the largest text on each line
      paragraph.setLineSpacing(200);

      // spacing will be 48 points
      paragraph.setLineSpacing(-48.0);
        Specified by:
        setLineSpacing in interface TextParagraph<XSLFShape,​XSLFTextParagraph,​XSLFTextRun>
        Parameters:
        lineSpacing - the vertical line spacing

      • getLineSpacing

        public java.lang.Double getLineSpacing()
        Description copied from interface: TextParagraph
        Returns the vertical line spacing that is to be used within a paragraph. This may be specified in two different ways, percentage spacing and font point spacing:

        If linespacing >= 0, then linespacing is a percentage of normal line height. If linespacing < 0, the absolute value of linespacing is the spacing in points

        Specified by:
        getLineSpacing in interface TextParagraph<XSLFShape,​XSLFTextParagraph,​XSLFTextRun>
        Returns:
        the vertical line spacing or null, if unset

      • setSpaceBefore

        public void setSpaceBefore​(java.lang.Double spaceBefore)
        Description copied from interface: TextParagraph
        Set the amount of vertical white space that will be present before the paragraph. This space is specified in either percentage or points:

        If spaceBefore >= 0, then space is a percentage of normal line height. If spaceBefore < 0, the absolute value of linespacing is the spacing in points

        Examples: 
        
      // The paragraph will be formatted to have a spacing before the paragraph text.
      // The spacing will be 200% of the size of the largest text on each line
      paragraph.setSpaceBefore(200);

      // The spacing will be a size of 48 points
      paragraph.setSpaceBefore(-48.0);
        Specified by:
        setSpaceBefore in interface TextParagraph<XSLFShape,​XSLFTextParagraph,​XSLFTextRun>
        Parameters:
        spaceBefore - the vertical white space before the paragraph, null to unset

      • getSpaceBefore

        public java.lang.Double getSpaceBefore()
        Description copied from interface: TextParagraph
        The amount of vertical white space before the paragraph This may be specified in two different ways, percentage spacing and font point spacing:

        If spaceBefore >= 0, then space is a percentage of normal line height. If spaceBefore < 0, the absolute value in points

        Specified by:
        getSpaceBefore in interface TextParagraph<XSLFShape,​XSLFTextParagraph,​XSLFTextRun>
        Returns:
        the vertical white space before the paragraph, or null if unset

      • setSpaceAfter

        public void setSpaceAfter​(java.lang.Double spaceAfter)
        Description copied from interface: TextParagraph
        Set the amount of vertical white space that will be present after the paragraph. This space is specified in either percentage or points:

        If spaceAfter >= 0, then space is a percentage of normal line height. If spaceAfter < 0, the absolute value of linespacing is the spacing in points

        Examples: 
        
      // The paragraph will be formatted to have a spacing after the paragraph text.
      // The spacing will be 200% of the size of the largest text on each line
      paragraph.setSpaceAfter(200);

      // The spacing will be a size of 48 points
      paragraph.setSpaceAfter(-48.0);
        Specified by:
        setSpaceAfter in interface TextParagraph<XSLFShape,​XSLFTextParagraph,​XSLFTextRun>
        Parameters:
        spaceAfter - the vertical white space after the paragraph, null to unset

      • getSpaceAfter

        public java.lang.Double getSpaceAfter()
        Description copied from interface: TextParagraph
        The amount of vertical white space after the paragraph This may be specified in two different ways, percentage spacing and font point spacing:

        If spaceBefore >= 0, then space is a percentage of normal line height. If spaceBefore < 0, the absolute value of linespacing is the spacing in points

        Specified by:
        getSpaceAfter in interface TextParagraph<XSLFShape,​XSLFTextParagraph,​XSLFTextRun>
        Returns:
        the vertical white space after the paragraph or null, if unset

      • setIndentLevel

        public void setIndentLevel​(int level)
        Description copied from interface: TextParagraph
        Specifies the particular level text properties that this paragraph will follow. The value for this attribute formats the text according to the corresponding level paragraph properties defined in the SlideMaster.
        Specified by:
        setIndentLevel in interface TextParagraph<XSLFShape,​XSLFTextParagraph,​XSLFTextRun>
        Parameters:
        level - the level (0 ... 4)

      • isBullet

        public boolean isBullet()
        Returns whether this paragraph has bullets

      • setBullet

        public void setBullet​(boolean flag)
        Parameters:
        flag - whether text in this paragraph has bullets

      • setBulletAutoNumber

        public void setBulletAutoNumber​(AutoNumberingScheme scheme,
                                int startAt)
        Specifies that automatic numbered bullet points should be applied to this paragraph
        Parameters:
        scheme - type of auto-numbering
        startAt - the number that will start number for a given sequence of automatically numbered bullets (1-based).

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • setBulletStyle

        public void setBulletStyle​(java.lang.Object... styles)
        Description copied from interface: TextParagraph
        Sets the bullet styles. If no styles are given, the bullets are omitted. Possible attributes are integer/double (bullet size), Color (bullet color), character (bullet character), string (bullet font), AutoNumberingScheme
        Specified by:
        setBulletStyle in interface TextParagraph<XSLFShape,​XSLFTextParagraph,​XSLFTextRun>

      • getTabStops

        public java.util.List<XSLFTabStop> getTabStops()
        Description copied from interface: TextParagraph
        Get the TabStops - the list can't be and it's entries shouldn't be modified. Opposed to other properties, this method is not cascading to the master sheet, if the property is not defined on the normal slide level, i.e. the tabstops on different levels aren't merged.
        Specified by:
        getTabStops in interface TextParagraph<XSLFShape,​XSLFTextParagraph,​XSLFTextRun>
        Returns:
        the tabstop collection or null if no tabstops are defined