Package org.apache.poi.xslf.usermodel

Class XSLFFreeformShape

java.lang.Object

org.apache.poi.xslf.usermodel.XSLFShape

org.apache.poi.xslf.usermodel.XSLFSimpleShape

org.apache.poi.xslf.usermodel.XSLFTextShape

org.apache.poi.xslf.usermodel.XSLFAutoShape

org.apache.poi.xslf.usermodel.XSLFFreeformShape

All Implemented Interfaces:

java.lang.Iterable<XSLFTextParagraph>, IAdjustableShape, AutoShape<XSLFShape,XSLFTextParagraph>, FreeformShape<XSLFShape,XSLFTextParagraph>, PlaceableShape<XSLFShape,XSLFTextParagraph>, Shape<XSLFShape,XSLFTextParagraph>, SimpleShape<XSLFShape,XSLFTextParagraph>, TextShape<XSLFShape,XSLFTextParagraph>, org.apache.poi.xddf.usermodel.text.TextContainer

@Beta
public class XSLFFreeformShape
extends XSLFAutoShape
implements FreeformShape<XSLFShape,XSLFTextParagraph>

Represents a custom geometric shape. This shape will consist of a series of lines and curves described within a creation path.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.poi.sl.usermodel.TextShape

TextShape.TextAutofit, TextShape.TextDirection, TextShape.TextPlaceholder

Method Summary

Modifier and Type	Method	Description
java.awt.geom.Path2D.Double	getPath()	Gets the shape path.
int	setPath(java.awt.geom.Path2D.Double path)	Set the shape path

Methods inherited from class org.apache.poi.xslf.usermodel.XSLFAutoShape

toString

Methods inherited from class org.apache.poi.xslf.usermodel.XSLFTextShape

addNewTextParagraph, appendText, clearText, findDefinedParagraphProperty, findDefinedRunProperty, getBottomInset, getInsets, getLeftInset, getRightInset, getText, getTextAutofit, getTextBody, getTextDirection, getTextHeight, getTextHeight, getTextParagraphs, getTextPlaceholder, getTextRotation, getTextType, getTopInset, getVerticalAlignment, getWordWrap, isHorizontalCentered, iterator, resizeToFitText, resizeToFitText, setBottomInset, setHorizontalCentered, setInsets, setLeftInset, setPlaceholder, setRightInset, setText, setTextAutofit, setTextDirection, setTextPlaceholder, setTextRotation, setTopInset, setVerticalAlignment, setWordWrap

Methods inherited from class org.apache.poi.xslf.usermodel.XSLFSimpleShape

createHyperlink, getAdjustValue, getAnchor, getFillColor, getFillStyle, getFlipHorizontal, getFlipVertical, getGeometry, getHyperlink, getLineCap, getLineColor, getLineCompound, getLineDash, getLineDecoration, getLineHeadDecoration, getLineHeadLength, getLineHeadWidth, getLineTailDecoration, getLineTailLength, getLineTailWidth, getLineWidth, getRotation, getShadow, getShapeType, getStrokeStyle, setAnchor, setFillColor, setFlipHorizontal, setFlipVertical, setLineCap, setLineColor, setLineCompound, setLineDash, setLineHeadDecoration, setLineHeadLength, setLineHeadWidth, setLineTailDecoration, setLineTailLength, setLineTailWidth, setLineWidth, setRotation, setShapeType, setStrokeStyle

Methods inherited from class org.apache.poi.xslf.usermodel.XSLFShape

draw, getParent, getPlaceholder, getPlaceholderDetails, getShapeId, getShapeName, getSheet, getXmlObject, isPlaceholder, setParent

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.poi.sl.draw.geom.IAdjustableShape

getAdjustValue

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.apache.poi.sl.usermodel.PlaceableShape

getAnchor, getFlipHorizontal, getFlipVertical, getParent, getRotation, getSheet, setAnchor, setFlipHorizontal, setFlipVertical, setRotation

Methods inherited from interface org.apache.poi.sl.usermodel.Shape

draw, getAnchor, getParent, getShapeId, getShapeName, getSheet

Methods inherited from interface org.apache.poi.sl.usermodel.SimpleShape

createHyperlink, getFillColor, getFillStyle, getGeometry, getHyperlink, getLineDecoration, getPlaceholder, getPlaceholderDetails, getShadow, getShapeType, getStrokeStyle, isPlaceholder, setFillColor, setPlaceholder, setShapeType, setStrokeStyle

Methods inherited from interface org.apache.poi.sl.usermodel.TextShape

appendText, getInsets, getText, getTextDirection, getTextHeight, getTextHeight, getTextParagraphs, getTextPlaceholder, getTextRotation, getVerticalAlignment, getWordWrap, isHorizontalCentered, resizeToFitText, resizeToFitText, setHorizontalCentered, setInsets, setText, setTextDirection, setTextPlaceholder, setTextRotation, setVerticalAlignment, setWordWrap

Method Detail

setPath

public int setPath(java.awt.geom.Path2D.Double path)

Description copied from interface: FreeformShape

Set the shape path

Specified by:

setPath in interface FreeformShape<XSLFShape,XSLFTextParagraph>

Parameters:

path - shape outline

Returns:

the number of points written

getPath

public java.awt.geom.Path2D.Double getPath()

Description copied from interface: FreeformShape

Gets the shape path.

The path is translated in the shape's coordinate system, i.e. freeform.getPath().getBounds2D() equals to freeform.getAnchor() (small discrepancies are possible due to rounding errors)

Specified by:

getPath in interface FreeformShape<XSLFShape,XSLFTextParagraph>

Returns:

the path