com.spire.presentation
Class Shape

java.lang.Object
  com.spire.presentation.PptObject
      com.spire.presentation.Shape

All Implemented Interfaces:

IActivePresentation, IShape, ISlideComponent

Direct Known Subclasses:

GroupShape, ShapeNode

public class Shape
extends PptObject
implements ISlideComponent, IShape

Represents a shape on a slide.

Constructor Summary

Shape()

Shape(ActiveSlide parent)

Shape(ActiveSlide parent, PptxBaseXmlElement elem)

Shape(ShapeCollection parent)

Shape(ShapeCollection parent, Container esc, ActiveSlide.Ppt2003Slide ppt)

Method Summary

java.lang.String	getAlternativeText() Gets the alternative text associated with a shape.
java.lang.String	getAlternativeTitle() Gets the alternative title associated with a shape.
ClickHyperlink	getClick() Gets the hyperlink defined for mouse click.
boolean	getDrawIndicatedShape()
EffectDag	getEffectDag() Gets the EffectDag object which contains pixel effects applied to a shape.
FillFormat	getFill() Gets the FillFormat object that contains fill formatting properties for a shape.
GraphicFrame	getFrame() Gets the shape frame's properties.
float	getHeight() Gets the height of the shape.
float	getLeft() Gets the x-coordinate of the upper-left corner of the shape.
TextLineFormat	getLine() Gets the LineFormat object that contains line formatting properties for a shape.
ClickHyperlink	getMouseOver() Gets he hyperlink defined for mouse over.
java.lang.String	getName() Gets the name of a shape.
ActiveSlide	getParent() Gets the parent slide of a shape.
PlaceholderEx	getPlaceholder() Gets the placeholder for a shape.
Presentation	getPresentation() Returns the parent presentation of a slide.
float	getRotation() Gets the number of degrees the specified shape is rotated around the z-axis.
ActiveSlide	getSlide() Gets the parent slide of a shape.
TagCollection	getTagsList() Gets the shape's tags collection.
FormatThreeD	getThreeD() Gets the FormatThreeD object that 3d effect properties for a shape.
float	getTop() Gets the y-coordinate of the upper-left corner of the shape.
float	getWidth() Gets he width of the shape.
int	getZOrderPosition() Gets the position of a shape in the z-order.
boolean	isHidden() Indicates whether the shape is hidden.
void	isHidden(boolean value)
boolean	isTextBox() Indicates whether the shape is TextHolder.
void	removePlaceholder() Removes placeholder from the shape.
void	setAlternativeText(java.lang.String value) Sets the alternative text associated with a shape.
void	setAlternativeTitle(java.lang.String value) Sets the alternative title associated with a shape.
void	setClick(ClickHyperlink value) Sets the hyperlink defined for mouse click.
void	setDrawIndicatedShape(boolean value)
void	setFrame(GraphicFrame value) Sets the shape frame's properties.
void	setHeight(float value) Sets the height of the shape.
void	setLeft(double value) Sets the x-coordinate of the upper-left corner of the shape.
void	setMouseOver(ClickHyperlink value) Sets he hyperlink defined for mouse over.
void	setName(java.lang.String value) Sets the name of a shape.
void	setRotation(float value) Sets the number of degrees the specified shape is rotated around the z-axis.
void	setShapeAlignment(ShapeAlignmentEnum.ShapeAlignment shapeAlignment) Sets the alignment with a shape.
void	setShapeArrange(ShapeAlignmentEnum.ShapeArrange shapeArrange) Sets the arrangement with a shape.
void	setTop(double value) Sets the y-coordinate of the upper-left corner of the shape.
void	setWidth(float value) Sets the width of the shape.

Methods inherited from class com.spire.presentation.PptObject

checkDisposed

Methods inherited from interface com.spire.presentation.IShape

dispose, insertChart, insertPicture, insertSmartArt, insertTable, insertVideo

Constructor Detail

Shape

public Shape(ShapeCollection parent)

Shape

public Shape()

Shape

public Shape(ActiveSlide parent)

Shape

public Shape(ActiveSlide parent,
             PptxBaseXmlElement elem)

Shape

public Shape(ShapeCollection parent,
             Container esc,
             ActiveSlide.Ppt2003Slide ppt)

Method Detail

isTextBox

public boolean isTextBox()

Description copied from interface: IShape

Indicates whether the shape is TextHolder. Read-only .

Specified by:

isTextBox in interface IShape

Returns:

getPlaceholder

public PlaceholderEx getPlaceholder()

Gets the placeholder for a shape. Read-only .

Specified by:

getPlaceholder in interface IShape

Returns:

removePlaceholder

public void removePlaceholder()

Removes placeholder from the shape.

Specified by:

removePlaceholder in interface IShape

getTagsList

public TagCollection getTagsList()

Gets the shape's tags collection. Read-only .

Specified by:

getTagsList in interface IShape

Returns:

getDrawIndicatedShape

public boolean getDrawIndicatedShape()

setDrawIndicatedShape

public void setDrawIndicatedShape(boolean value)

getFrame

public GraphicFrame getFrame()

Gets the shape frame's properties. Read/write .

Specified by:

getFrame in interface IShape

Returns:

setFrame

public void setFrame(GraphicFrame value)

Sets the shape frame's properties. Read/write .

Specified by:

setFrame in interface IShape

getLine

public TextLineFormat getLine()

Gets the LineFormat object that contains line formatting properties for a shape. Read-only .

Specified by:

getLine in interface IShape

Returns:

getThreeD

public FormatThreeD getThreeD()

Gets the FormatThreeD object that 3d effect properties for a shape. Read-only .

Specified by:

getThreeD in interface IShape

Returns:

getEffectDag

public EffectDag getEffectDag()

Gets the EffectDag object which contains pixel effects applied to a shape. Read-only

Specified by:

getEffectDag in interface IShape

Returns:

getFill

public FillFormat getFill()

Gets the FillFormat object that contains fill formatting properties for a shape. Note: can return null for certain types of shapes which don't have fill properties. Read-only .

Specified by:

getFill in interface IShape

Returns:

getClick

public ClickHyperlink getClick()

Gets the hyperlink defined for mouse click. Read/write .

Specified by:

getClick in interface IShape

Returns:

setClick

public void setClick(ClickHyperlink value)

Sets the hyperlink defined for mouse click. Read/write .

Specified by:

setClick in interface IShape

getMouseOver

public ClickHyperlink getMouseOver()

Gets he hyperlink defined for mouse over. Read/write .

Specified by:

getMouseOver in interface IShape

Returns:

setMouseOver

public void setMouseOver(ClickHyperlink value)

Sets he hyperlink defined for mouse over. Read/write .

Specified by:

setMouseOver in interface IShape

isHidden

public boolean isHidden()

Indicates whether the shape is hidden. Read/write .

Specified by:

isHidden in interface IShape

Returns:

isHidden

public void isHidden(boolean value)

Specified by:

isHidden in interface IShape

getParent

public ActiveSlide getParent()

Gets the parent slide of a shape. Read-only .

Specified by:

getParent in interface IShape

Overrides:

getParent in class PptObject

Returns:

getZOrderPosition

public int getZOrderPosition()

Gets the position of a shape in the z-order.

Specified by:

getZOrderPosition in interface IShape

Returns:

Shapes[0] returns the shape at the back of the z-order, and Shapes[Shapes.Count - 1] returns the shape at the front of the z-order.

getRotation

public float getRotation()

Gets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value Read/write .

Specified by:

getRotation in interface IShape

Returns:

setRotation

public void setRotation(float value)

Sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value Read/write .

Specified by:

setRotation in interface IShape

getLeft

public float getLeft()

Gets the x-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

getLeft in interface IShape

Returns:

setLeft

public void setLeft(double value)

Sets the x-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

setLeft in interface IShape

getTop

public float getTop()

Gets the y-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

getTop in interface IShape

Returns:

setTop

public void setTop(double value)

Sets the y-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

setTop in interface IShape

getWidth

public float getWidth()

Gets he width of the shape. Read/write .

Specified by:

getWidth in interface IShape

Returns:

setWidth

public void setWidth(float value)

Sets the width of the shape. Read/write .

Specified by:

setWidth in interface IShape

getHeight

public float getHeight()

Gets the height of the shape. Read/write .

Specified by:

getHeight in interface IShape

Returns:

setHeight

public void setHeight(float value)

Sets the height of the shape. Read/write .

Specified by:

setHeight in interface IShape

setShapeAlignment

public void setShapeAlignment(ShapeAlignmentEnum.ShapeAlignment shapeAlignment)

Sets the alignment with a shape.

Specified by:

setShapeAlignment in interface IShape

setShapeArrange

public void setShapeArrange(ShapeAlignmentEnum.ShapeArrange shapeArrange)

Sets the arrangement with a shape.

Specified by:

setShapeArrange in interface IShape

getAlternativeText

public java.lang.String getAlternativeText()

Gets the alternative text associated with a shape. Read/write .

Specified by:

getAlternativeText in interface IShape

Returns:

setAlternativeText

public void setAlternativeText(java.lang.String value)

Sets the alternative text associated with a shape. Read/write .

Specified by:

setAlternativeText in interface IShape

getAlternativeTitle

public java.lang.String getAlternativeTitle()

Gets the alternative title associated with a shape. Read/write

Specified by:

getAlternativeTitle in interface IShape

Returns:

setAlternativeTitle

public void setAlternativeTitle(java.lang.String value)

Sets the alternative title associated with a shape. Read/write

Specified by:

setAlternativeTitle in interface IShape

getName

public java.lang.String getName()

Gets the name of a shape. Read/write .

Specified by:

getName in interface IShape

Returns:

setName

public void setName(java.lang.String value)

Sets the name of a shape. Read/write .

Specified by:

setName in interface IShape

getSlide

public ActiveSlide getSlide()

Gets the parent slide of a shape. Read-only .

Specified by:

getSlide in interface IShape

Specified by:

getSlide in interface ISlideComponent

Returns:

getPresentation

public Presentation getPresentation()

Returns the parent presentation of a slide. Read-only .

Specified by:

getPresentation in interface IActivePresentation

Specified by:

getPresentation in interface IShape

Returns: