Class XSSFSimpleShape

    • Method Detail

      • getTextBody

        @Beta
        public org.apache.poi.xddf.usermodel.text.XDDFTextBody getTextBody()
      • getText

        public String getText()
        Returns the text from all paragraphs in the shape. Paragraphs are separated by new lines.
        Returns:
        text contained within this shape or empty string
      • clearText

        public void clearText()
        Clear all text from this shape
      • setText

        public void setText​(String text)
        Set a single paragraph of text on the shape. Note this will replace all existing paragraphs created on the shape.
        Parameters:
        text - string representing the paragraph text
      • setText

        public void setText​(XSSFRichTextString str)
        Set a single paragraph of text on the shape. Note this will replace all existing paragraphs created on the shape.
        Parameters:
        str - rich text string representing the paragraph text
      • getTextParagraphs

        public List<XSSFTextParagraph> getTextParagraphs()
        Returns a collection of the XSSFTextParagraphs that are attached to this shape
        Returns:
        text paragraphs in this shape
      • addNewTextParagraph

        public XSSFTextParagraph addNewTextParagraph()
        Add a new paragraph run to this shape
        Returns:
        created paragraph run
      • addNewTextParagraph

        public XSSFTextParagraph addNewTextParagraph​(String text)
        Add a new paragraph run to this shape, set to the provided string
        Returns:
        created paragraph run
      • addNewTextParagraph

        public XSSFTextParagraph addNewTextParagraph​(XSSFRichTextString str)
        Add a new paragraph run to this shape, set to the provided rich text string
        Returns:
        created paragraph run
      • setTextHorizontalOverflow

        public void setTextHorizontalOverflow​(TextHorizontalOverflow overflow)
        Sets the type of horizontal overflow for the text.
        Parameters:
        overflow - - the type of horizontal overflow. A null values unsets this property.
      • getTextHorizontalOverflow

        public TextHorizontalOverflow getTextHorizontalOverflow()
        Returns the type of horizontal overflow for the text.
        Returns:
        the type of horizontal overflow
      • setTextVerticalOverflow

        public void setTextVerticalOverflow​(TextVerticalOverflow overflow)
        Sets the type of vertical overflow for the text.
        Parameters:
        overflow - - the type of vertical overflow. A null values unsets this property.
      • getTextVerticalOverflow

        public TextVerticalOverflow getTextVerticalOverflow()
        Returns the type of vertical overflow for the text.
        Returns:
        the type of vertical overflow
      • setVerticalAlignment

        public void setVerticalAlignment​(VerticalAlignment anchor)
        Sets the type of vertical alignment for the text within the shape.
        Parameters:
        anchor - - the type of alignment. A null values unsets this property.
      • getVerticalAlignment

        public VerticalAlignment getVerticalAlignment()
        Returns the type of vertical alignment for the text within the shape.
        Returns:
        the type of vertical alignment
      • setTextDirection

        public void setTextDirection​(TextDirection orientation)
        Sets the vertical orientation of the text
        Parameters:
        orientation - vertical orientation of the text A null values unsets this property.
      • getTextDirection

        public TextDirection getTextDirection()
        Gets the vertical orientation of the text
        Returns:
        vertical orientation of the text
      • getBottomInset

        public double getBottomInset()
        Returns the distance (in points) between the bottom of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.
        Returns:
        the bottom inset in points
      • getLeftInset

        public double getLeftInset()
        Returns the distance (in points) between the left edge of the text frame and the left edge of the inscribed rectangle of the shape that contains the text.
        Returns:
        the left inset in points
      • getRightInset

        public double getRightInset()
        Returns the distance (in points) between the right edge of the text frame and the right edge of the inscribed rectangle of the shape that contains the text.
        Returns:
        the right inset in points
      • getTopInset

        public double getTopInset()
        Returns the distance (in points) between the top of the text frame and the top of the inscribed rectangle of the shape that contains the text.
        Returns:
        the top inset in points
      • setBottomInset

        public void setBottomInset​(double margin)
        Sets the bottom inset.
        Parameters:
        margin - the bottom margin
        See Also:
        getBottomInset()
      • setLeftInset

        public void setLeftInset​(double margin)
        Sets the left inset.
        Parameters:
        margin - the left margin
        See Also:
        getLeftInset()
      • setRightInset

        public void setRightInset​(double margin)
        Sets the right inset.
        Parameters:
        margin - the right margin
        See Also:
        getRightInset()
      • setTopInset

        public void setTopInset​(double margin)
        Sets the top inset.
        Parameters:
        margin - the top margin
        See Also:
        getTopInset()
      • getWordWrap

        public boolean getWordWrap()
        Returns:
        whether to wrap words within the bounding rectangle
      • setWordWrap

        public void setWordWrap​(boolean wrap)
        Parameters:
        wrap - whether to wrap words within the bounding rectangle
      • setTextAutofit

        public void setTextAutofit​(TextAutofit value)
        Specifies that a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside
        Parameters:
        value - type of autofit
      • getTextAutofit

        public TextAutofit getTextAutofit()
        Returns:
        type of autofit
      • getShapeType

        public int getShapeType()
        Gets the shape type, one of the constants defined in ShapeTypes.
        Returns:
        the shape type
        See Also:
        ShapeTypes
      • setShapeType

        public void setShapeType​(int type)
        Sets the shape types.
        Parameters:
        type - the shape type, one of the constants defined in ShapeTypes.
        See Also:
        ShapeTypes
      • getShapeName

        public String getShapeName()
        Specified by:
        getShapeName in interface Shape
        Returns:
        the name of this shape
      • getShapeId

        public int getShapeId()
        Specified by:
        getShapeId in interface SimpleShape
        Returns:
        the shape id, which is unique within the sheet