Package org.apache.poi.xssf.usermodel
Class XSSFSimpleShape
java.lang.Object
org.apache.poi.xssf.usermodel.XSSFShape
org.apache.poi.xssf.usermodel.XSSFSimpleShape
- All Implemented Interfaces:
Iterable<XSSFTextParagraph>
,Shape
,SimpleShape
,TextContainer
- Direct Known Subclasses:
XSSFObjectData
,XSSFTextBox
public class XSSFSimpleShape
extends XSSFShape
implements Iterable<XSSFTextParagraph>, SimpleShape, TextContainer
Represents a shape with a predefined geometry in a SpreadsheetML drawing.
Possible shape types are defined in
ShapeTypes
-
Field Summary
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
XSSFSimpleShape
(XSSFDrawing drawing, org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShape ctShape) -
Method Summary
Modifier and TypeMethodDescriptionAdd a new paragraph run to this shapeaddNewTextParagraph
(String text) Add a new paragraph run to this shape, set to the provided stringAdd a new paragraph run to this shape, set to the provided rich text stringvoid
Clear all text from this shape<R> Optional
<R> findDefinedParagraphProperty
(Function<org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraphProperties, Boolean> isSet, Function<org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraphProperties, R> getter) <R> Optional
<R> findDefinedRunProperty
(Function<org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties, Boolean> isSet, Function<org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties, R> getter) double
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.org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShape
double
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.double
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.int
protected org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties
Returns xml bean with shape properties.int
Gets the shape type, one of the constants defined inShapeTypes
.getText()
Returns the text from all paragraphs in the shape.Gets the vertical orientation of the textReturns the type of horizontal overflow for the text.Returns a collection of the XSSFTextParagraphs that are attached to this shapeReturns the type of vertical overflow for the text.double
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 type of vertical alignment for the text within the shape.boolean
iterator()
protected static org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShape
Prototype with the default structure of a new auto-shape.void
setBottomInset
(double margin) Sets the bottom inset.void
setLeftInset
(double margin) Sets the left inset.void
setRightInset
(double margin) Sets the right inset.void
setShapeType
(int type) Sets the shape types.void
Set a single paragraph of text on the shape.void
Set a single paragraph of text on the shape.void
setTextAutofit
(TextAutofit value) Specifies that a shape should be auto-fit to fully contain the text described within it.void
setTextDirection
(TextDirection orientation) Sets the vertical orientation of the textvoid
Sets the type of horizontal overflow for the text.void
setTextVerticalOverflow
(TextVerticalOverflow overflow) Sets the type of vertical overflow for the text.void
setTopInset
(double margin) Sets the top inset.void
Sets the type of vertical alignment for the text within the shape.void
setWordWrap
(boolean wrap) protected void
setXfrm
(org.openxmlformats.schemas.drawingml.x2006.main.CTTransform2D t2d) Methods inherited from class org.apache.poi.xssf.usermodel.XSSFShape
getAnchor, getDrawing, getParent, isNoFill, setFillColor, setLineStyle, setLineStyleColor, setLineWidth, setNoFill
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
Methods inherited from interface org.apache.poi.ss.usermodel.Shape
getAnchor, getParent, isNoFill, setFillColor, setLineStyleColor, setNoFill
-
Constructor Details
-
XSSFSimpleShape
protected XSSFSimpleShape(XSSFDrawing drawing, org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShape ctShape)
-
-
Method Details
-
prototype
protected static org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShape prototype()Prototype with the default structure of a new auto-shape. -
getCTShape
-
getTextBody
-
setXfrm
protected void setXfrm(org.openxmlformats.schemas.drawingml.x2006.main.CTTransform2D t2d) -
iterator
- Specified by:
iterator
in interfaceIterable<XSSFTextParagraph>
-
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
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
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
Returns a collection of the XSSFTextParagraphs that are attached to this shape- Returns:
- text paragraphs in this shape
-
addNewTextParagraph
Add a new paragraph run to this shape- Returns:
- created paragraph run
-
addNewTextParagraph
Add a new paragraph run to this shape, set to the provided string- Returns:
- created paragraph run
-
addNewTextParagraph
Add a new paragraph run to this shape, set to the provided rich text string- Returns:
- created paragraph run
-
setTextHorizontalOverflow
Sets the type of horizontal overflow for the text.- Parameters:
overflow
- - the type of horizontal overflow. Anull
values unsets this property.
-
getTextHorizontalOverflow
Returns the type of horizontal overflow for the text.- Returns:
- the type of horizontal overflow
-
setTextVerticalOverflow
Sets the type of vertical overflow for the text.- Parameters:
overflow
- - the type of vertical overflow. Anull
values unsets this property.
-
getTextVerticalOverflow
Returns the type of vertical overflow for the text.- Returns:
- the type of vertical overflow
-
setVerticalAlignment
Sets the type of vertical alignment for the text within the shape.- Parameters:
anchor
- - the type of alignment. Anull
values unsets this property.
-
getVerticalAlignment
Returns the type of vertical alignment for the text within the shape.- Returns:
- the type of vertical alignment
-
setTextDirection
Sets the vertical orientation of the text- Parameters:
orientation
- vertical orientation of the text Anull
values unsets this property.
-
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:
-
setLeftInset
public void setLeftInset(double margin) Sets the left inset.- Parameters:
margin
- the left margin- See Also:
-
setRightInset
public void setRightInset(double margin) Sets the right inset.- Parameters:
margin
- the right margin- See Also:
-
setTopInset
public void setTopInset(double margin) Sets the top inset.- Parameters:
margin
- the top margin- See Also:
-
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
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
- Returns:
- type of autofit
-
getShapeType
public int getShapeType()Gets the shape type, one of the constants defined inShapeTypes
.- Returns:
- the shape type
- See Also:
-
setShapeType
public void setShapeType(int type) Sets the shape types.- Parameters:
type
- the shape type, one of the constants defined inShapeTypes
.- See Also:
-
getShapeProperties
protected org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties getShapeProperties()Description copied from class:XSSFShape
Returns xml bean with shape properties.- Specified by:
getShapeProperties
in classXSSFShape
- Returns:
- xml bean with shape properties.
-
getShapeName
- Specified by:
getShapeName
in interfaceShape
- Returns:
- the name of this shape
-
getShapeId
public int getShapeId()- Specified by:
getShapeId
in interfaceSimpleShape
- Returns:
- the shape id, which is unique within the sheet
-
findDefinedParagraphProperty
public <R> Optional<R> findDefinedParagraphProperty(Function<org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraphProperties, Boolean> isSet, Function<org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraphProperties, R> getter) - Specified by:
findDefinedParagraphProperty
in interfaceTextContainer
-
findDefinedRunProperty
public <R> Optional<R> findDefinedRunProperty(Function<org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties, Boolean> isSet, Function<org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties, R> getter) - Specified by:
findDefinedRunProperty
in interfaceTextContainer
-