org.apache.poi.xslf.usermodel
Class XSLFFreeformShape

java.lang.Object
  extended by org.apache.poi.xslf.usermodel.XSLFShape
      extended by org.apache.poi.xslf.usermodel.XSLFSimpleShape
          extended by org.apache.poi.xslf.usermodel.XSLFTextShape
              extended by org.apache.poi.xslf.usermodel.XSLFAutoShape
                  extended by 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>

@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.

Author:
Yegor Kozlov

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.poi.sl.usermodel.TextShape
TextShape.TextAutofit, TextShape.TextDirection, TextShape.TextPlaceholder
 
Nested classes/interfaces inherited from interface org.apache.poi.sl.usermodel.SimpleShape
SimpleShape.Placeholder
 
Method Summary
 java.awt.geom.GeneralPath getPath()
          Gets the shape path.
 int setPath(java.awt.geom.GeneralPath path)
          Set the shape path
 
Methods inherited from class org.apache.poi.xslf.usermodel.XSLFAutoShape
getTextBody, initTextBody, toString
 
Methods inherited from class org.apache.poi.xslf.usermodel.XSLFTextShape
addNewTextParagraph, clearText, getBottomInset, getInsets, getLeftInset, getRightInset, getText, getTextAutofit, getTextBodyPr, getTextBodyPr, getTextDirection, getTextHeight, getTextParagraphs, getTextPlaceholder, getTextRotation, getTextType, getTopInset, getVerticalAlignment, getWordWrap, isHorizontalCentered, iterator, 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
getAdjustValue, getAnchor, getFillColor, getFillStyle, getFlipHorizontal, getFlipVertical, getGeometry, getLineCap, getLineColor, getLineCompound, getLineDash, getLineDecoration, getLineHeadDecoration, getLineHeadLength, getLineHeadWidth, getLinePaint, getLineTailDecoration, getLineTailLength, getLineTailWidth, getLineWidth, getRotation, getSafeXfrm, getShadow, getShapeType, getStrokeStyle, getXfrm, isPlaceholder, 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
fetchShapeProperty, getBgPr, getBgRef, getCNvPr, getCTPlaceholder, getFillPaint, getGrpSpPr, getPaint, getParent, getShapeId, getShapeName, getSheet, getSpPr, getSpStyle, getXmlObject, selectPaint, selectPaint, selectPaint, selectPaint, selectPaint, selectProperty, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.poi.sl.usermodel.TextShape
getInsets, getTextDirection, getTextHeight, getTextParagraphs, getTextPlaceholder, getTextRotation, getVerticalAlignment, getWordWrap, isHorizontalCentered, setHorizontalCentered, setInsets, setText, setTextDirection, setTextPlaceholder, setTextRotation, setVerticalAlignment, setWordWrap
 
Methods inherited from interface org.apache.poi.sl.usermodel.SimpleShape
getFillColor, getFillStyle, getGeometry, getLineDecoration, getShadow, getShapeType, getStrokeStyle, isPlaceholder, setFillColor, setShapeType, setStrokeStyle
 
Methods inherited from interface org.apache.poi.sl.usermodel.Shape
getAnchor, getParent, getSheet
 
Methods inherited from interface org.apache.poi.sl.draw.geom.IAdjustableShape
getAdjustValue
 
Methods inherited from interface org.apache.poi.sl.usermodel.PlaceableShape
getAnchor, getFlipHorizontal, getFlipVertical, getParent, getRotation, setAnchor, setFlipHorizontal, setFlipVertical, setRotation
 
Methods inherited from interface java.lang.Iterable
iterator
 

Method Detail

setPath

public int setPath(java.awt.geom.GeneralPath 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.GeneralPath 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


Copyright 2015 The Apache Software Foundation or its licensors, as applicable.