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:
Iterable<XSLFTextParagraph>,IAdjustableShape,AutoShape<XSLFShape,,XSLFTextParagraph> FreeformShape<XSLFShape,,XSLFTextParagraph> PlaceableShape<XSLFShape,,XSLFTextParagraph> Shape<XSLFShape,,XSLFTextParagraph> SimpleShape<XSLFShape,,XSLFTextParagraph> TextShape<XSLFShape,,XSLFTextParagraph> 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 TypeMethodDescriptiongetPath()Gets the shape path.intsetPath(Path2D.Double path) Set the shape pathMethods inherited from class org.apache.poi.xslf.usermodel.XSLFAutoShape
getTextBody, toStringMethods inherited from class org.apache.poi.xslf.usermodel.XSLFTextShape
addNewTextParagraph, appendText, clearText, findDefinedParagraphProperty, findDefinedRunProperty, getBottomInset, getInsets, getLeftInset, getRightInset, getText, getTextAutofit, getTextBody, getTextBodyPr, getTextBodyPr, getTextDirection, getTextHeight, getTextHeight, getTextParagraphs, getTextPlaceholder, getTextRotation, getTextType, getTopInset, getVerticalAlignment, getWordWrap, initTextBody, isHorizontalCentered, iterator, newTextParagraph, resizeToFitText, resizeToFitText, setBottomInset, setHorizontalCentered, setInsets, setLeftInset, setPlaceholder, setRightInset, setText, setTextAutofit, setTextDirection, setTextPlaceholder, setTextRotation, setTopInset, setVerticalAlignment, setWordWrapMethods 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, getLinePaint, getLineTailDecoration, getLineTailLength, getLineTailWidth, getLineWidth, getRotation, getShadow, getShapeType, getStrokeStyle, getXfrm, setAnchor, setFillColor, setFlipHorizontal, setFlipVertical, setLineCap, setLineColor, setLineCompound, setLineDash, setLineHeadDecoration, setLineHeadLength, setLineHeadWidth, setLineTailDecoration, setLineTailLength, setLineTailWidth, setLineWidth, setRotation, setShapeType, setStrokeStyleMethods inherited from class org.apache.poi.xslf.usermodel.XSLFShape
draw, fetchShapeProperty, getBgPr, getBgRef, getChild, getCNvPr, getFillPaint, getGrpSpPr, getParent, getPlaceholder, getPlaceholderDetails, getShapeId, getShapeName, getShapeProperties, getSheet, getSpStyle, getXmlObject, isPlaceholder, selectPaint, selectPaint, selectPaint, selectPaint, selectPaint, selectProperty, setParentMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.poi.sl.draw.geom.IAdjustableShape
getAdjustValueMethods inherited from interface java.lang.Iterable
forEach, iterator, spliteratorMethods inherited from interface org.apache.poi.sl.usermodel.PlaceableShape
getAnchor, getFlipHorizontal, getFlipVertical, getParent, getRotation, getSheet, setAnchor, setFlipHorizontal, setFlipVertical, setRotationMethods inherited from interface org.apache.poi.sl.usermodel.Shape
draw, getAnchor, getParent, getShapeId, getShapeName, getSheetMethods inherited from interface org.apache.poi.sl.usermodel.SimpleShape
createHyperlink, getFillColor, getFillStyle, getGeometry, getHyperlink, getLineDecoration, getPlaceholder, getPlaceholderDetails, getShadow, getShapeType, getStrokeStyle, isPlaceholder, setFillColor, setPlaceholder, setShapeType, setStrokeStyleMethods 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 Details
-
setPath
Description copied from interface:FreeformShapeSet the shape path- Specified by:
setPathin interfaceFreeformShape<XSLFShape,XSLFTextParagraph> - Parameters:
path- shape outline- Returns:
- the number of points written
-
getPath
Description copied from interface:FreeformShapeGets 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:
getPathin interfaceFreeformShape<XSLFShape,XSLFTextParagraph> - Returns:
- the path
-