com.aspose.slides.pptx
Class ShapeEx

java.lang.Object
  extended by com.aspose.slides.pptx.ShapeEx
All Implemented Interfaces:
IPresentationComponent, ISlideComponent
Direct Known Subclasses:
GeometryShapeEx, GraphicalObjectEx, GroupShapeEx

public class ShapeEx
extends java.lang.Object
implements ISlideComponent

Represents a shape on a slide.


Method Summary
 void createPropertiesElements(java.lang.String nvPropName, java.lang.String spPropName)
           
 java.lang.String getAlternativeText()
          Returns the alternative text associated with a shape.
 EffectFormatEx getEffectFormat()
          Returns the EffectFormatEx object which contains pixel effects applied to a shape.
 FillFormatEx getFillFormat()
          Returns the FillFormatEx object that contains fill formatting properties for a shape.
 ShapeFrameEx getFrame()
          Returns the shape frame's properties.
 float getHeight()
          Returns the height of a shape.
 HyperlinkEx getHLinkClick()
          Returns the hyperlink defined for mouse click.
 HyperlinkEx getHLinkMouseOver()
          Returns the hyperlink defined for mouse over.
 LineFormatEx getLineFormat()
          Returns the LineFormatEx object that contains line formatting properties for a shape.
 java.lang.String getName()
          Returns the name of a shape.
 com.aspose.slides.pptx.presentationml.PresentationBaseShapeNVPropertiesElement getNonVisualPropElement()
           
 BaseSlideEx getParent()
          Returns the parent slide of a shape.
 PlaceholderEx getPlaceholder()
          Returns the placeholder for a shape.
 PresentationEx getPresentation()
          Returns the parent presentation of a slide.
 ShapeFrameEx getRawFrame()
          Returns the raw shape frame's properties.
 float getRotation()
          Returns or sets the number of degrees the specified shape is rotated around the z-axis.
 long getShapeId()
           
 BaseSlideEx getSlide()
          Returns the parent slide of a shape.
 TagsEx getTags()
          Returns the shape's tags collection.
 ThreeDFormatEx getThreeDFormat()
          Returns the ThreeDFormatEx object that contains line formatting properties for a shape.
 float getWidth()
          Returns the width of a shape.
 float getX()
          Returns the x-coordinate of the upper-left corner of a shape.
 float getY()
          Returns the y-coordinate of the upper-left corner of a shape.
 int getZOrderPosition()
          Returns the position of a shape in the z-order. getShapes().get(0) returns the shape at the back of the z-order, and getShapes().get(getShapes().size() - 1) returns the shape at the front of the z-order.
 boolean isHidden()
          Determines whether the shape is hidden.
 boolean isTextHolder()
          Determines whether the shape is TextHolder.
 void setAlternativeText(java.lang.String value)
          Sets the alternative text associated with a shape.
 void setFrame(ShapeFrameEx value)
          Sets the shape frame's properties.
 void setHeight(float value)
          Sets the height of a shape.
 void setHidden(boolean value)
          Sets whether the shape is hidden.
 void setHLinkClick(HyperlinkEx value)
          Sets the hyperlink defined for mouse click.
 void setHLinkMouseOver(HyperlinkEx value)
          Sets the hyperlink defined for mouse over.
 void setName(java.lang.String name)
          Sets the name of a shape.
 void setRawFrame(ShapeFrameEx value)
          Sets the raw shape frame's properties.
 void setRotation(float value)
           
 void setWidth(float value)
          Sets the width of a shape.
 void setX(float value)
          Sets the x-coordinate of the upper-left corner of a shape.
 void setY(float value)
          Sets the y-coordinate of the upper-left corner of a shape.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

isTextHolder

public boolean isTextHolder()
Determines whether the shape is TextHolder.


getPlaceholder

public PlaceholderEx getPlaceholder()
Returns the placeholder for a shape.


getTags

public TagsEx getTags()
Returns the shape's tags collection.


getRawFrame

public ShapeFrameEx getRawFrame()
Returns the raw shape frame's properties.


setRawFrame

public void setRawFrame(ShapeFrameEx value)
Sets the raw shape frame's properties.

Parameters:
value -

getFrame

public ShapeFrameEx getFrame()
Returns the shape frame's properties.


setFrame

public void setFrame(ShapeFrameEx value)
Sets the shape frame's properties.

Parameters:
value -

getLineFormat

public LineFormatEx getLineFormat()
Returns the LineFormatEx object that contains line formatting properties for a shape.

Returns:
See LineFormatEx.

getThreeDFormat

public ThreeDFormatEx getThreeDFormat()
Returns the ThreeDFormatEx object that contains line formatting properties for a shape.


getEffectFormat

public EffectFormatEx getEffectFormat()
Returns the EffectFormatEx object which contains pixel effects applied to a shape.


getFillFormat

public FillFormatEx getFillFormat()
Returns the FillFormatEx object that contains fill formatting properties for a shape.

Returns:
See FillFormatEx.

getHLinkClick

public HyperlinkEx getHLinkClick()
Returns the hyperlink defined for mouse click.

Returns:
See HyperlinkEx.

setHLinkClick

public void setHLinkClick(HyperlinkEx value)
Sets the hyperlink defined for mouse click.

Parameters:
value - See HyperlinkEx.

getHLinkMouseOver

public HyperlinkEx getHLinkMouseOver()
Returns the hyperlink defined for mouse over.

Returns:
See HyperlinkEx.

setHLinkMouseOver

public void setHLinkMouseOver(HyperlinkEx value)
Sets the hyperlink defined for mouse over.

Parameters:
value - See HyperlinkEx.

isHidden

public boolean isHidden()
Determines whether the shape is hidden.


setHidden

public void setHidden(boolean value)
Sets whether the shape is hidden.

Parameters:
value - true to hide the shape.

getParent

public BaseSlideEx getParent()
Returns the parent slide of a shape.

Returns:
See BaseSlideEx.

getZOrderPosition

public int getZOrderPosition()
Returns the position of a shape in the z-order. getShapes().get(0) returns the shape at the back of the z-order, and getShapes().get(getShapes().size() - 1) returns the shape at the front of the z-order.


getRotation

public float getRotation()
Returns or sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation.


setRotation

public void setRotation(float value)

getX

public float getX()
Returns the x-coordinate of the upper-left corner of a shape.


setX

public void setX(float value)
Sets the x-coordinate of the upper-left corner of a shape.


getY

public float getY()
Returns the y-coordinate of the upper-left corner of a shape.


setY

public void setY(float value)
Sets the y-coordinate of the upper-left corner of a shape.


getWidth

public float getWidth()
Returns the width of a shape.


setWidth

public void setWidth(float value)
Sets the width of a shape.


getHeight

public float getHeight()
Returns the height of a shape.


setHeight

public void setHeight(float value)
Sets the height of a shape.


getShapeId

public long getShapeId()

getAlternativeText

public java.lang.String getAlternativeText()
Returns the alternative text associated with a shape.


getNonVisualPropElement

public com.aspose.slides.pptx.presentationml.PresentationBaseShapeNVPropertiesElement getNonVisualPropElement()

setAlternativeText

public void setAlternativeText(java.lang.String value)
Sets the alternative text associated with a shape.

Parameters:
value - new alternative text.

getName

public java.lang.String getName()
Returns the name of a shape.


setName

public void setName(java.lang.String name)
Sets the name of a shape.

Parameters:
name - new name of a shape.

getSlide

public BaseSlideEx getSlide()
Returns the parent slide of a shape.

Specified by:
getSlide in interface ISlideComponent
See Also:
ISlideComponent.getSlide()

getPresentation

public PresentationEx getPresentation()
Returns the parent presentation of a slide.

Specified by:
getPresentation in interface IPresentationComponent
See Also:
IPresentationComponent.getPresentation()

createPropertiesElements

public void createPropertiesElements(java.lang.String nvPropName,
                                     java.lang.String spPropName)