com.aspose.slides
Class ShapeEx

java.lang.Object
  extended by com.aspose.slides.ShapeEx
Direct Known Subclasses:
GeometryShapeEx, GraphicalObjectEx, GroupShapeEx

public class ShapeEx
extends java.lang.Object

Represents a shape on a slide.


Method Summary
 PlaceholderEx addPlaceholder(PlaceholderEx placeholder)
           Adds a new placeholder if there is no and sets placeholder properties to a specified one.
 EffectFormatDataEx createEffectFormatData()
           Creates the EffectFormatDataEx object that contains all effects applyed to a shape, included inherited.
 FillFormatDataEx createFillFormatData()
           Creates the FillFormatDataEx object that contains all fill formatting properties for a shape, included inherited.
 LineFormatDataEx createLineFormatData()
           Creates the LineFormatDataEx object that contains all line formatting properties for a shape, included inherited.
 ThreeDFormatDataEx createThreeDFormatData()
           Creates the ThreeDFormatDataEx object that contains volume properties and 3D transformation of a shape, included inherited.
 java.lang.String getAlternativeText()
           Returns or sets 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 or sets the shape frame's properties.
 float getHeight()
           Returns or sets the height of the shape.
 boolean getHidden()
           Determines whether the shape is hidden.
 HyperlinkEx getHLinkClick()
           Returns or sets the hyperlink defined for mouse click.
 HyperlinkEx getHLinkMouseOver()
           Returns or sets 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 or sets the name of a shape.
 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 or sets the raw shape frame's properties.
 float getRotation()
           Returns or sets the number of degrees the specified shape is rotated around the z-axis.
 BaseSlideEx getSlide()
           Returns the parent slide of a shape.
 TagExCollection getTags()
           Returns the shape's tags collection.
 ThreeDFormatEx getThreeDFormat()
           Returns the ThreeDFormatEx object that 3d effect properties for a shape.
 float getWidth()
           Returns or sets the width of the shape.
 float getX()
           Returns or sets the x-coordinate of the upper-left corner of the shape.
 float getY()
           Returns or sets the y-coordinate of the upper-left corner of the shape.
 int getZOrderPosition()
           Returns the position of a shape in the z-order.
 boolean isTextHolder()
           Determines whether the shape is TextHolder.
 void removePlaceholder()
           Removes placeholder from the shape.
 void setAlternativeText(java.lang.String value)
           
 void setFrame(ShapeFrameEx value)
           
 void setHeight(float value)
           
 void setHidden(boolean value)
           
 void setHLinkClick(HyperlinkEx value)
           
 void setHLinkMouseOver(HyperlinkEx value)
           
 void setName(java.lang.String value)
           
 void setRawFrame(ShapeFrameEx value)
           
 void setRotation(float value)
           
 void setWidth(float value)
           
 void setX(float value)
           
 void setY(float value)
           
 
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. Read-only bool.


getPlaceholder

public PlaceholderEx getPlaceholder()

Returns the placeholder for a shape. Read-only PlaceholderEx.


removePlaceholder

public void removePlaceholder()

Removes placeholder from the shape.


addPlaceholder

public PlaceholderEx addPlaceholder(PlaceholderEx placeholder)

Adds a new placeholder if there is no and sets placeholder properties to a specified one.

Parameters:
placeholder - Placeholder to copy content from.
Returns:
New PlaceholderEx.

getTags

public TagExCollection getTags()

Returns the shape's tags collection. Read-only TagExCollection.


getRawFrame

public ShapeFrameEx getRawFrame()

Returns or sets the raw shape frame's properties. Read/write ShapeFrameEx.


setRawFrame

public void setRawFrame(ShapeFrameEx value)

getFrame

public ShapeFrameEx getFrame()

Returns or sets the shape frame's properties. Read/write ShapeFrameEx.


setFrame

public void setFrame(ShapeFrameEx value)

getLineFormat

public LineFormatEx getLineFormat()

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


getThreeDFormat

public ThreeDFormatEx getThreeDFormat()

Returns the ThreeDFormatEx object that 3d effect properties for a shape. Read-only ThreeDFormatEx. Note: can return null for certain types of shapes which don't have 3d properties.


getEffectFormat

public EffectFormatEx getEffectFormat()

Returns the EffectFormatEx object which contains pixel effects applied to a shape. Read-only EffectFormatEx Note: can return null for certain types of shapes which don't have effect properties.


getFillFormat

public FillFormatEx getFillFormat()

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


createLineFormatData

public LineFormatDataEx createLineFormatData()

Creates the LineFormatDataEx object that contains all line formatting properties for a shape, included inherited.

Returns:
LineFormatDataEx.

createFillFormatData

public FillFormatDataEx createFillFormatData()

Creates the FillFormatDataEx object that contains all fill formatting properties for a shape, included inherited.

Returns:
FillFormatDataEx.

createEffectFormatData

public EffectFormatDataEx createEffectFormatData()

Creates the EffectFormatDataEx object that contains all effects applyed to a shape, included inherited.

Returns:
EffectFormatDataEx.

createThreeDFormatData

public ThreeDFormatDataEx createThreeDFormatData()

Creates the ThreeDFormatDataEx object that contains volume properties and 3D transformation of a shape, included inherited.

Returns:
FillFormatDataEx.

getHLinkClick

public HyperlinkEx getHLinkClick()

Returns or sets the hyperlink defined for mouse click. Read/write HyperlinkEx.


setHLinkClick

public void setHLinkClick(HyperlinkEx value)

getHLinkMouseOver

public HyperlinkEx getHLinkMouseOver()

Returns or sets the hyperlink defined for mouse over. Read/write HyperlinkEx.


setHLinkMouseOver

public void setHLinkMouseOver(HyperlinkEx value)

getHidden

public boolean getHidden()

Determines whether the shape is hidden. Read/write bool.


setHidden

public void setHidden(boolean value)

getParent

public BaseSlideEx getParent()

Returns the parent slide of a shape. Read-only BaseSlideEx.


getZOrderPosition

public int getZOrderPosition()

Returns the position of a shape in the z-order. 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. Read-only int.


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. Read/write float.


setRotation

public void setRotation(float value)

getX

public float getX()

Returns or sets the x-coordinate of the upper-left corner of the shape. Read/write int.


setX

public void setX(float value)

getY

public float getY()

Returns or sets the y-coordinate of the upper-left corner of the shape. Read/write int.


setY

public void setY(float value)

getWidth

public float getWidth()

Returns or sets the width of the shape. Read/write int.


setWidth

public void setWidth(float value)

getHeight

public float getHeight()

Returns or sets the height of the shape. Read/write int.


setHeight

public void setHeight(float value)

getAlternativeText

public java.lang.String getAlternativeText()

Returns or sets the alternative text associated with a shape. Read/write string.


setAlternativeText

public void setAlternativeText(java.lang.String value)

getName

public java.lang.String getName()

Returns or sets the name of a shape. Read/write string.


setName

public void setName(java.lang.String value)

getSlide

public BaseSlideEx getSlide()

Returns the parent slide of a shape. Read-only BaseSlideEx.


getPresentation

public PresentationEx getPresentation()

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