FreeformShape (POI API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.sl.usermodel
Interface FreeformShape<S extends Shape<S,P>,P extends TextParagraph<S,P,?>>

All Superinterfaces:: AutoShape<S,P>, IAdjustableShape, java.lang.Iterable<P>, PlaceableShape<S,P>, Shape<S,P>, SimpleShape<S,P>, TextShape<S,P>

All Known Implementing Classes:: HSLFFreeformShape, XSLFFreeformShape

public interface FreeformShape<S extends Shape<S,P>,P extends TextParagraph<S,P,?>>
extends AutoShape<S,P>
extends AutoShape<S,P>

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.poi.sl.usermodel.TextShape
`TextShape.TextAutofit, TextShape.TextDirection`

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 interface org.apache.poi.sl.usermodel.TextShape
`getInsets, getTextDirection, getTextHeight, getTextParagraphs, getVerticalAlignment, getWordWrap, isHorizontalCentered`

Methods inherited from interface org.apache.poi.sl.usermodel.SimpleShape
`getFillStyle, getGeometry, getLineDecoration, getShadow, getShapeType, getStrokeStyle, isPlaceholder`

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

getPath

java.awt.geom.GeneralPath getPath()

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)

Returns:: the path

setPath

int setPath(java.awt.geom.GeneralPath path)

Set the shape path

Parameters:: path - shape outline
Returns:: the number of points written