org.apache.poi.xslf.usermodel

Class XSLFShape

java.lang.Object

org.apache.poi.xslf.usermodel.XSLFShape

All Implemented Interfaces:

Shape<XSLFShape,XSLFTextParagraph>

Direct Known Subclasses:

XSLFGraphicFrame, XSLFGroupShape, XSLFShadow, XSLFSimpleShape

@Beta
public abstract class XSLFShape
extends Object
implements Shape<XSLFShape,XSLFTextParagraph>

Base super-class class for all shapes in PresentationML

Method Summary

Modifier and Type	Method and Description
void	draw(Graphics2D graphics, Rectangle2D bounds) Convenience method to draw a single shape
XSLFShapeContainer	getParent()
Placeholder	getPlaceholder()
XSLFPlaceholderDetails	getPlaceholderDetails()
int	getShapeId() Returns a unique identifier for this shape within the current slide.
String	getShapeName()
XSLFSheet	getSheet()
XmlObject	getXmlObject()
boolean	isPlaceholder()
void	setParent(XSLFShapeContainer parent)
void	setPlaceholder(Placeholder placeholder)

Methods inherited from class java.lang.Object

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

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

getAnchor

Method Detail

getXmlObject

public final XmlObject getXmlObject()

Returns:

the xml bean holding this shape's data

getSheet

public XSLFSheet getSheet()

Specified by:

getSheet in interface Shape<XSLFShape,XSLFTextParagraph>

Returns:

the sheet this shape belongs to

getShapeName

public String getShapeName()

Specified by:

getShapeName in interface Shape<XSLFShape,XSLFTextParagraph>

Returns:

human-readable name of this shape, e.g. "Rectange 3"

getShapeId

public int getShapeId()

Description copied from interface: Shape

Returns a unique identifier for this shape within the current slide. This ID may be used to assist in uniquely identifying this object so that it can be referred to by other parts of the document.

If multiple objects within the same slide share the same id attribute value, then the document shall be considered non-conformant.

Specified by:

getShapeId in interface Shape<XSLFShape,XSLFTextParagraph>

Returns:

unique id of this shape

setParent

public void setParent(XSLFShapeContainer parent)

getParent

public XSLFShapeContainer getParent()

Specified by:

getParent in interface Shape<XSLFShape,XSLFTextParagraph>

isPlaceholder

public boolean isPlaceholder()

getPlaceholder

public Placeholder getPlaceholder()

See Also:

PlaceholderDetails.getPlaceholder()

setPlaceholder

public void setPlaceholder(Placeholder placeholder)

See Also:

PlaceholderDetails.setPlaceholder(Placeholder)

getPlaceholderDetails

public XSLFPlaceholderDetails getPlaceholderDetails()

See Also:

SimpleShape.getPlaceholderDetails()

draw

public void draw(Graphics2D graphics,
                 Rectangle2D bounds)

Description copied from interface: Shape

Convenience method to draw a single shape

Specified by:

draw in interface Shape<XSLFShape,XSLFTextParagraph>

Parameters:

graphics - the graphics context

bounds - the rectangle to fit the shape to. if null, the bounds of the shape are used.