XDGFShape (poi-ooxml 5.1.0 API)

java.lang.Object
- org.apache.poi.xdgf.usermodel.XDGFSheet
- - org.apache.poi.xdgf.usermodel.XDGFShape

```
public class XDGFShape
extends XDGFSheet
```
A shape is a collection of Geometry Visualization, Format, Text, Images, and Shape Data in a Drawing Page.

Field Summary
- Fields inherited from class org.apache.poi.xdgf.usermodel.XDGFSheet
  _cells, _character, _document, _geometry, _sections, _sheet

Constructor Summary

Constructors
Constructor and Description
`XDGFShape(com.microsoft.schemas.office.visio.x2012.main.ShapeSheetType shapeSheet, XDGFBaseContents parentPage, XDGFDocument document)`
`XDGFShape(XDGFShape parent, com.microsoft.schemas.office.visio.x2012.main.ShapeSheetType shapeSheet, XDGFBaseContents parentPage, XDGFDocument document)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Double`	`getAngle()`
`Double`	`getBeginX()`
`Double`	`getBeginY()`
`Rectangle2D.Double`	`getBounds()`
`Path2D.Double`	`getBoundsAsPath()`
`XDGFCell`	`getCell(String cellName)` A cell is really just a setting
`Double`	`getEndX()`
`Double`	`getEndY()`
`Boolean`	`getFlipX()`
`Boolean`	`getFlipY()`
`Color`	`getFontColor()`
`Double`	`getFontSize()`
`GeometrySection`	`getGeometryByIdx(long idx)`
`Iterable<GeometrySection>`	`getGeometrySections()`
`Double`	`getHeight()`
`long`	`getID()`
`Integer`	`getLineCap()`
`Color`	`getLineColor()`
`Integer`	`getLinePattern()`
`Double`	`getLineWeight()`
`Double`	`getLocPinX()`
`Double`	`getLocPinY()`
`XDGFShape`	`getMasterShape()`
`String`	`getName()`
`XDGFShape`	`getParentShape()`
`protected AffineTransform`	`getParentTransform()` Returns a transform that can translate shape-local coordinates to the coordinates of its parent shape
`Path2D.Double`	`getPath()`
`Double`	`getPinX()`
`Double`	`getPinY()`
`List<XDGFShape>`	`getShapes()` Only available if this shape is a shape group, may be null
`String`	`getShapeType()`
`Stroke`	`getStroke()`
`String`	`getSymbolName()`
`XDGFText`	`getText()`
`String`	`getTextAsString()`
`XDGFShape`	`getTopmostParentShape()`
`Double`	`getTxtAngle()`
`Double`	`getTxtHeight()`
`Double`	`getTxtLocPinX()`
`Double`	`getTxtLocPinY()`
`Double`	`getTxtPinX()`
`Double`	`getTxtPinY()`
`Double`	`getTxtWidth()`
`String`	`getType()`
`Double`	`getWidth()`
`com.microsoft.schemas.office.visio.x2012.main.ShapeSheetType`	`getXmlObject()`
`boolean`	`hasGeometry()`
`boolean`	`hasMaster()`
`boolean`	`hasMasterShape()`
`boolean`	`hasParent()`
`boolean`	`hasShapes()`
`boolean`	`hasText()`
`boolean`	`isDeleted()`
`boolean`	`isShape1D()`
`boolean`	`isTopmost()`
`protected void`	`readProperties()`
`protected void`	`setupMaster(XDGFPageContents pageContents, XDGFMasterContents master)` Setup top level shapes Shapes that have a 'Master' attribute refer to a specific master in the page, whereas shapes with a 'MasterShape' attribute refer to a subshape of a Master.
`protected void`	`setupSectionMasters()`
`String`	`toString()`
`void`	`visitShapes(ShapeVisitor visitor, AffineTransform tr, int level)` The visitor will first visit this shape, then it's children This is useful because exceptions will be marked with the shapes as it propagates up the shape hierarchy.
`void`	`visitShapes(ShapeVisitor visitor, int level)` The visitor will first visit this shape, then it's children.

Methods inherited from class org.apache.poi.xdgf.usermodel.XDGFSheet
getDocument, getFillStyle, getLineStyle, getSection, getTextStyle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XDGFShape

public XDGFShape(com.microsoft.schemas.office.visio.x2012.main.ShapeSheetType shapeSheet,
                 XDGFBaseContents parentPage,
                 XDGFDocument document)

XDGFShape

public XDGFShape(XDGFShape parent,
                 com.microsoft.schemas.office.visio.x2012.main.ShapeSheetType shapeSheet,
                 XDGFBaseContents parentPage,
                 XDGFDocument document)

Method Detail

toString
```
public String toString()
```
Overrides:

toString in class Object

readProperties
```
protected void readProperties()
```

setupMaster
```
protected void setupMaster(XDGFPageContents pageContents,
                           XDGFMasterContents master)
```
Setup top level shapes Shapes that have a 'Master' attribute refer to a specific master in the page, whereas shapes with a 'MasterShape' attribute refer to a subshape of a Master.

setupSectionMasters
```
protected void setupSectionMasters()
```

getXmlObject

@Internal
public com.microsoft.schemas.office.visio.x2012.main.ShapeSheetType getXmlObject()

getID
```
public long getID()
```

getType
```
public String getType()
```

getTextAsString
```
public String getTextAsString()
```

hasText
```
public boolean hasText()
```

getCell
```
public XDGFCell getCell(String cellName)
```
Description copied from class: XDGFSheet

A cell is really just a setting

Overrides:

getCell in class XDGFSheet

Parameters:

cellName - The particular setting you want

getGeometryByIdx

public GeometrySection getGeometryByIdx(long idx)

getShapes
```
public List<XDGFShape> getShapes()
```
Only available if this shape is a shape group, may be null

getName
```
public String getName()
```

getShapeType
```
public String getShapeType()
```

getSymbolName
```
public String getSymbolName()
```

getMasterShape
```
public XDGFShape getMasterShape()
```

getParentShape
```
public XDGFShape getParentShape()
```
Returns:

The parent shape if this is a subshape, null otherwise

getTopmostParentShape

public XDGFShape getTopmostParentShape()

hasMaster
```
public boolean hasMaster()
```

hasMasterShape
```
public boolean hasMasterShape()
```

hasParent
```
public boolean hasParent()
```

hasShapes
```
public boolean hasShapes()
```

isTopmost
```
public boolean isTopmost()
```

isShape1D
```
public boolean isShape1D()
```

isDeleted
```
public boolean isDeleted()
```

getText
```
public XDGFText getText()
```

getPinX
```
public Double getPinX()
```

getPinY
```
public Double getPinY()
```

getWidth
```
public Double getWidth()
```

getHeight
```
public Double getHeight()
```

getLocPinX
```
public Double getLocPinX()
```

getLocPinY
```
public Double getLocPinY()
```

getBeginX
```
public Double getBeginX()
```

getBeginY
```
public Double getBeginY()
```

getEndX
```
public Double getEndX()
```

getEndY
```
public Double getEndY()
```

getAngle
```
public Double getAngle()
```

getFlipX
```
public Boolean getFlipX()
```

getFlipY
```
public Boolean getFlipY()
```

getTxtPinX
```
public Double getTxtPinX()
```

getTxtPinY
```
public Double getTxtPinY()
```

getTxtLocPinX
```
public Double getTxtLocPinX()
```

getTxtLocPinY
```
public Double getTxtLocPinY()
```

getTxtAngle
```
public Double getTxtAngle()
```

getTxtWidth
```
public Double getTxtWidth()
```

getTxtHeight
```
public Double getTxtHeight()
```

getLineCap
```
public Integer getLineCap()
```
Overrides:

getLineCap in class XDGFSheet

getLineColor
```
public Color getLineColor()
```
Overrides:

getLineColor in class XDGFSheet

getLinePattern
```
public Integer getLinePattern()
```
Overrides:

getLinePattern in class XDGFSheet

getLineWeight
```
public Double getLineWeight()
```
Overrides:

getLineWeight in class XDGFSheet

getFontColor
```
public Color getFontColor()
```
Overrides:

getFontColor in class XDGFSheet

getFontSize
```
public Double getFontSize()
```
Overrides:

getFontSize in class XDGFSheet

getStroke
```
public Stroke getStroke()
```

getGeometrySections

public Iterable<GeometrySection> getGeometrySections()

getBounds
```
public Rectangle2D.Double getBounds()
```
Returns:

rectangle in local coordinates

getBoundsAsPath
```
public Path2D.Double getBoundsAsPath()
```
Returns:

returns bounds as a path in local coordinates, which is userful if you need to transform to global coordinates Warning: Don't use this for 1d objects, and will fail for infinite line objects

getPath
```
public Path2D.Double getPath()
```
Returns:

The outline of the shape in local coordinates

hasGeometry
```
public boolean hasGeometry()
```

getParentTransform
```
protected AffineTransform getParentTransform()
```
Returns a transform that can translate shape-local coordinates to the coordinates of its parent shape

visitShapes
```
public void visitShapes(ShapeVisitor visitor,
                        AffineTransform tr,
                        int level)
```
The visitor will first visit this shape, then it's children This is useful because exceptions will be marked with the shapes as it propagates up the shape hierarchy.

visitShapes
```
public void visitShapes(ShapeVisitor visitor,
                        int level)
```
The visitor will first visit this shape, then it's children. No transform is calculated for this visit This is useful because exceptions will be marked with the shapes as it propagates up the shape hierarchy.

Class XDGFShape

Field Summary

Fields inherited from class org.apache.poi.xdgf.usermodel.XDGFSheet

Constructor Summary

Method Summary

Methods inherited from class org.apache.poi.xdgf.usermodel.XDGFSheet

Methods inherited from class java.lang.Object

Constructor Detail

XDGFShape

XDGFShape

Method Detail

toString

readProperties

setupMaster

setupSectionMasters

getXmlObject

getID

getType

getTextAsString

hasText

getCell

getGeometryByIdx

getShapes

getName

getShapeType

getSymbolName

getMasterShape

getParentShape

getTopmostParentShape

hasMaster

hasMasterShape

hasParent

hasShapes

isTopmost

isShape1D

isDeleted

getText

getPinX

getPinY

getWidth

getHeight

getLocPinX

getLocPinY

getBeginX

getBeginY

getEndX

getEndY

getAngle

getFlipX

getFlipY

getTxtPinX

getTxtPinY

getTxtLocPinX

getTxtLocPinY

getTxtAngle

getTxtWidth

getTxtHeight

getLineCap

getLineColor

getLinePattern

getLineWeight

getFontColor

getFontSize

getStroke

getGeometrySections

getBounds

getBoundsAsPath

getPath

hasGeometry

getParentTransform

visitShapes

visitShapes