ShapeBase (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.Node
- - com.aspose.words.CompositeNode
  - - com.aspose.words.ShapeBase

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable

Direct Known Subclasses:

GroupShape, Shape
```
public abstract class ShapeBase
extends CompositeNode
```
Base class for objects in the drawing layer, such as an AutoShape, freeform, OLE object, ActiveX control, or picture.
This is an abstract class. The two derived classes that you can instantiate are Shape and GroupShape.

A shape is a node in the document tree.

If the shape is a child of a Paragraph object, then the shape is said to be "top-level". Top-level shapes are measured and positioned in points.

A shape can also occur as a child of a GroupShape object when several shapes are grouped. Child shapes of a group shape are positioned in the coordinate space and units defined by the getCoordSize() / setCoordSize(java.awt.Dimension) and getCoordOrigin() / setCoordOrigin(java.awt.Point) properties of the parent group shape.

A shape can be positioned inline with text or floating. The positioning method is controlled using the getWrapType() / setWrapType(int) property.

When a shape is floating, it is positioned relative to something (e.g the current paragraph, the margin or the page). The relative positioning of the shape is specified using the getRelativeHorizontalPosition() / setRelativeHorizontalPosition(int) and getRelativeVerticalPosition() / setRelativeVerticalPosition(int) properties.

A floating shape be positioned explicitly using the getLeft() / setLeft(double) and getTop() / setTop(double) properties or aligned relative to some other object using the getHorizontalAlignment() / setHorizontalAlignment(int) and getVerticalAlignment() / setVerticalAlignment(int) properties.

See Also:

Shape, GroupShape

Constructor Summary

Constructors
Modifier Constructor and Description

protected ShapeBase(DocumentBase doc, byte markupLanguage)
Initializes a new instance of this class.

Constructors
Modifier	Constructor and Description
`protected`	`ShapeBase(DocumentBase doc, byte markupLanguage)` Initializes a new instance of this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.awt.geom.Rectangle2D.Float`	`adjustWithEffects(java.awt.geom.Rectangle2D.Float source)` Adds to the source rectangle values of the effect extent and returns the final rectangle.
`boolean`	`canHaveImage()` Returns true if the shape type allows the shape to have an image.
`void`	`clearRunAttrs()`
`java.lang.Object`	`fetchInheritedRunAttr(int fontAttr)`
`java.lang.Object`	`fetchInheritedShapeAttr(int key)` Reserved for system use.
`java.lang.Object`	`fetchShapeAttr(int key)` Reserved for system use.
`boolean`	`getAllowOverlap()` Gets a value that specifies whether this shape can overlap other shapes.
`java.lang.String`	`getAlternativeText()` Defines alternative text to be displayed instead of a graphic.
`boolean`	`getAnchorLocked()` Specifies whether the shape's anchor is locked.
`boolean`	`getAspectRatioLocked()` Specifies whether the shape's aspect ratio is locked.
`boolean`	`getBehindText()` Specifies whether the shape is below or above text.
`double`	`getBottom()` Gets the position of the bottom edge of the containing block of the shape.
`java.awt.geom.Rectangle2D.Float`	`getBounds()` Gets the location and size of the containing block of the shape.
`java.awt.geom.Rectangle2D.Float`	`getBoundsInPoints()` Gets the location and size of the containing block of the shape in points, relative to the anchor of the topmost shape.
`java.awt.geom.Rectangle2D.Float`	`getBoundsWithEffects()` Gets final extent that this shape object has after applying drawing effects.
`java.awt.Point`	`getCoordOrigin()` The coordinates at the top-left corner of the containing block of this shape.
`java.awt.Dimension`	`getCoordSize()` The width and height of the coordinate space inside the containing block of this shape.
`java.lang.Object`	`getDirectRunAttr(int fontAttr)`
`java.lang.Object`	`getDirectShapeAttr(int key)` Reserved for system use.
`double`	`getDistanceBottom()` Gets the distance (in points) between the document text and the bottom edge of the shape.
`double`	`getDistanceLeft()` Gets the distance (in points) between the document text and the left edge of the shape.
`double`	`getDistanceRight()` Gets the distance (in points) between the document text and the right edge of the shape.
`double`	`getDistanceTop()` Gets the distance (in points) between the document text and the top edge of the shape.
`DocumentBase`	`getDocument_IInline()`
`Fill`	`getFill()` Gets fill formatting for the shape.
`java.awt.Color`	`getFillableBackColor()`
`java.awt.Color`	`getFillableForeColor()`
`byte[]`	`getFillableImageBytes()`
`double`	`getFillableTransparency()`
`boolean`	`getFillableVisible()`
`java.awt.Color`	`getFilledColor()`
`int`	`getFillType()`
`int`	`getFlipOrientation()` Switches the orientation of a shape.
`Font`	`getFont()` Provides access to the font formatting of this object.
`double`	`getGradientAngle()`
`GradientStopCollection`	`getGradientStops()`
`int`	`getGradientStyle()`
`int`	`getGradientVariant()`
`double`	`getHeight()` Gets the height of the containing block of the shape.
`int`	`getHorizontalAlignment()` Specifies how the shape is positioned horizontally.
`java.lang.String`	`getHRef()` Gets the full hyperlink address for a shape.
`double`	`getLeft()` Gets the position of the left edge of the containing block of the shape.
`byte`	`getMarkupLanguage()` Gets MarkupLanguage used for this graphic object.
`java.lang.String`	`getName()` Gets the optional shape name.
`boolean`	`getOn()`
`double`	`getOpacity()`
`Paragraph`	`getParentParagraph_IInline()`
`Paragraph`	`getParentParagraph()` Returns the immediate parent paragraph.
`int`	`getPatternType()`
`int`	`getPresetTexture()`
`int`	`getRelativeHorizontalPosition()` Specifies relative to what the shape is positioned horizontally.
`int`	`getRelativeVerticalPosition()` Specifies relative to what the shape is positioned vertically.
`double`	`getRight()` Gets the position of the right edge of the containing block of the shape.
`boolean`	`getRotateWithObject()`
`double`	`getRotation()` Defines the angle (in degrees) that a shape is rotated.
`java.lang.String`	`getScreenTip()` Defines the text displayed when the mouse pointer moves over the shape.
`ShadowFormat`	`getShadowFormat()` Gets shadow formatting for the shape.
`ShapeRenderer`	`getShapeRenderer()` Creates and returns an object that can be used to render this shape into an image.
`int`	`getShapeType()` Gets the shape type.
`java.awt.geom.Point2D.Float`	`getSizeInPoints()` Gets the size of the shape in points.
`java.lang.String`	`getTarget()` Gets the target frame for the shape hyperlink.
`int`	`getTextureAlignment()`
`java.lang.String`	`getTitle()` Gets the title (caption) of the current shape object.
`double`	`getTop()` Gets the position of the top edge of the containing block of the shape.
`int`	`getVerticalAlignment()` Specifies how the shape is positioned vertically.
`double`	`getWidth()` Gets the width of the containing block of the shape.
`int`	`getWrapSide()` Specifies how the text is wrapped around the shape.
`int`	`getWrapType()` Defines whether the shape is inline or floating.
`int`	`getZOrder_IShape()`
`int`	`getZOrder()` Determines the display order of overlapping shapes.
`boolean`	`isDecorative()` Gets the flag that specifies whether the shape is decorative in the document.
`void`	`isDecorative(boolean value)` Sets the flag that specifies whether the shape is decorative in the document.
`boolean`	`isDeleteRevision()` Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
`boolean`	`isGroup()` Returns true if this is a group shape.
`boolean`	`isHorizontalRule()` Returns true if this shape is a horizontal rule.
`boolean`	`isImage()` Returns true if this shape is an image shape.
`boolean`	`isInline()` A quick way to determine if this shape is positioned inline with text.
`boolean`	`isInsertRevision()` Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
`boolean`	`isLayoutInCell()` Gets a flag indicating whether the shape is displayed inside a table or outside of it.
`void`	`isLayoutInCell(boolean value)` Sets a flag indicating whether the shape is displayed inside a table or outside of it.
`boolean`	`isMoveFromRevision()` Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
`boolean`	`isMoveToRevision()` Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
`boolean`	`isSignatureLine()` Indicates that shape is a SignatureLine.
`boolean`	`isTopLevel()` Returns true if this shape is not a child of a group shape.
`boolean`	`isWordArt()` Returns true if this shape is a WordArt object.
`java.awt.geom.Point2D.Float`	`localToParent(java.awt.geom.Point2D.Float value)` Converts a value from the local coordinate space into the coordinate space of the parent shape.
`void`	`oneColorGradient(int style, int variant, double degree)`
`void`	`patterned(int patternType)`
`void`	`presetTextured(int presetTexture)`
`void`	`removeMoveRevisions()`
`void`	`removeRunAttr(int key)`
`void`	`removeShapeAttr(int key)` Reserved for system use.
`void`	`setAllowOverlap(boolean value)` Sets a value that specifies whether this shape can overlap other shapes.
`void`	`setAlternativeText(java.lang.String value)` Defines alternative text to be displayed instead of a graphic.
`void`	`setAnchorLocked(boolean value)` Specifies whether the shape's anchor is locked.
`void`	`setAspectRatioLocked(boolean value)` Specifies whether the shape's aspect ratio is locked.
`void`	`setBehindText(boolean value)` Specifies whether the shape is below or above text.
`void`	`setBounds(java.awt.geom.Rectangle2D.Float value)` Sets the location and size of the containing block of the shape.
`void`	`setCoordOrigin(java.awt.Point value)` The coordinates at the top-left corner of the containing block of this shape.
`void`	`setCoordSize(java.awt.Dimension value)` The width and height of the coordinate space inside the containing block of this shape.
`void`	`setDistanceBottom(double value)` Sets the distance (in points) between the document text and the bottom edge of the shape.
`void`	`setDistanceLeft(double value)` Sets the distance (in points) between the document text and the left edge of the shape.
`void`	`setDistanceRight(double value)` Sets the distance (in points) between the document text and the right edge of the shape.
`void`	`setDistanceTop(double value)` Sets the distance (in points) between the document text and the top edge of the shape.
`void`	`setFillableBackColor(java.awt.Color value)`
`void`	`setFillableForeColor(java.awt.Color value)`
`void`	`setFillableTransparency(double value)`
`void`	`setFillableVisible(boolean value)`
`void`	`setFilledColor(java.awt.Color value)`
`void`	`setFlipOrientation(int value)` Switches the orientation of a shape.
`void`	`setGradientAngle(double value)`
`void`	`setHeight(double value)` Sets the height of the containing block of the shape.
`void`	`setHorizontalAlignment(int value)` Specifies how the shape is positioned horizontally.
`void`	`setHRef(java.lang.String value)` Sets the full hyperlink address for a shape.
`void`	`setImage(byte[] imageBytes)`
`void`	`setLeft(double value)` Sets the position of the left edge of the containing block of the shape.
`void`	`setName(java.lang.String value)` Sets the optional shape name.
`void`	`setOn(boolean value)`
`void`	`setOpacity(double value)`
`void`	`setRelativeHorizontalPosition(int value)` Specifies relative to what the shape is positioned horizontally.
`void`	`setRelativeVerticalPosition(int value)` Specifies relative to what the shape is positioned vertically.
`void`	`setRotateWithObject(boolean value)`
`void`	`setRotation(double value)` Defines the angle (in degrees) that a shape is rotated.
`void`	`setRunAttr(int fontAttr, java.lang.Object value)`
`void`	`setScreenTip(java.lang.String value)` Defines the text displayed when the mouse pointer moves over the shape.
`void`	`setShapeAttr(int key, java.lang.Object value)` Reserved for system use.
`void`	`setTarget(java.lang.String value)` Sets the target frame for the shape hyperlink.
`void`	`setTextureAlignment(int value)`
`void`	`setTitle(java.lang.String value)` Sets the title (caption) of the current shape object.
`void`	`setTop(double value)` Sets the position of the top edge of the containing block of the shape.
`void`	`setVerticalAlignment(int value)` Specifies how the shape is positioned vertically.
`void`	`setWidth(double value)` Sets the width of the containing block of the shape.
`void`	`setWrapSide(int value)` Specifies how the text is wrapped around the shape.
`void`	`setWrapType(int value)` Defines whether the shape is inline or floating.
`void`	`setZOrder_IShape(int value)`
`void`	`setZOrder(int value)` Determines the display order of overlapping shapes.
`void`	`solid()`
`void`	`twoColorGradient(int style, int variant)`

Methods inherited from class com.aspose.words.CompositeNode
acceptChildren, acceptCore, appendChild, coreRemoveSelfOnly, getChild, getChildNodes, getChildNodes, getContainer, getCount, getCurrentNode, getFirstChild, getLastChild, getNextMatchingNode, getText, hasChildNodes, indexOf, insertAfter, insertBefore, isComposite, iterator, prependChild, removeAllChildren, removeChild, removeSmartTags, selectNodes, selectSingleNode

Methods inherited from class com.aspose.words.Node
accept, dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getDocument, getNextSibling, getNodeType, getParentNode, getPreviousSibling, getRange, memberwiseClone, nextPreOrder, nodeTypeToString, previousPreOrder, remove, setCustomNodeId, toString, toString, toString, visitorActionToBool

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - ShapeBase
```
protected ShapeBase(DocumentBase doc,
                    byte markupLanguage)
```
    Initializes a new instance of this class.
- Method Detail
  - getShapeRenderer
```
public ShapeRenderer getShapeRenderer()
                               throws java.lang.Exception
```
    Creates and returns an object that can be used to render this shape into an image.
    This method just invokes the ShapeRenderer constructor and passes this object as a parameter.
    
    Returns:
    
    The renderer object for this shape.
    
    Throws:
    
    java.lang.Exception
  - getParentParagraph_IInline
```
public Paragraph getParentParagraph_IInline()
```
  - getDocument_IInline
```
public DocumentBase getDocument_IInline()
```
  - getZOrder_IShape
```
public int getZOrder_IShape()
```
  - setZOrder_IShape
```
public void setZOrder_IShape(int value)
```
  - getDirectShapeAttr
```
public java.lang.Object getDirectShapeAttr(int key)
```
    Reserved for system use. IShapeAttrSource.
  - fetchInheritedShapeAttr
```
public java.lang.Object fetchInheritedShapeAttr(int key)
```
    Reserved for system use. IShapeAttrSource.
  - fetchShapeAttr
```
public java.lang.Object fetchShapeAttr(int key)
```
    Reserved for system use. IShapeAttrSource.
  - setShapeAttr
```
public void setShapeAttr(int key,
                         java.lang.Object value)
```
    Reserved for system use. IShapeAttrSource.
  - removeShapeAttr
```
public void removeShapeAttr(int key)
```
    Reserved for system use. IShapeAttrSource.
  - removeMoveRevisions
```
public void removeMoveRevisions()
```
  - getDirectRunAttr
```
public java.lang.Object getDirectRunAttr(int fontAttr)
```
  - fetchInheritedRunAttr
```
public java.lang.Object fetchInheritedRunAttr(int fontAttr)
```
  - setRunAttr
```
public void setRunAttr(int fontAttr,
                       java.lang.Object value)
```
  - removeRunAttr
```
public void removeRunAttr(int key)
```
  - clearRunAttrs
```
public void clearRunAttrs()
```
  - solid
```
public void solid()
```
  - getPresetTexture
```
public int getPresetTexture()
                     throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getPatternType
```
public int getPatternType()
                   throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - presetTextured
```
public void presetTextured(int presetTexture)
```
  - patterned
```
public void patterned(int patternType)
```
  - twoColorGradient
```
public void twoColorGradient(int style,
                             int variant)
```
  - oneColorGradient
```
public void oneColorGradient(int style,
                             int variant,
                             double degree)
```
  - setImage
```
public void setImage(byte[] imageBytes)
```
  - getFilledColor
```
public java.awt.Color getFilledColor()
```
  - setFilledColor
```
public void setFilledColor(java.awt.Color value)
```
  - getOn
```
public boolean getOn()
```
  - setOn
```
public void setOn(boolean value)
```
  - getOpacity
```
public double getOpacity()
```
  - setOpacity
```
public void setOpacity(double value)
```
  - getFillableImageBytes
```
public byte[] getFillableImageBytes()
                             throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getFillableForeColor
```
public java.awt.Color getFillableForeColor()
```
  - setFillableForeColor
```
public void setFillableForeColor(java.awt.Color value)
```
  - getFillableBackColor
```
public java.awt.Color getFillableBackColor()
```
  - setFillableBackColor
```
public void setFillableBackColor(java.awt.Color value)
```
  - getFillableVisible
```
public boolean getFillableVisible()
```
  - setFillableVisible
```
public void setFillableVisible(boolean value)
```
  - getFillableTransparency
```
public double getFillableTransparency()
```
  - setFillableTransparency
```
public void setFillableTransparency(double value)
```
  - getRotateWithObject
```
public boolean getRotateWithObject()
```
  - setRotateWithObject
```
public void setRotateWithObject(boolean value)
```
  - getFillType
```
public int getFillType()
```
  - getTextureAlignment
```
public int getTextureAlignment()
```
  - setTextureAlignment
```
public void setTextureAlignment(int value)
```
  - getGradientAngle
```
public double getGradientAngle()
```
  - setGradientAngle
```
public void setGradientAngle(double value)
```
  - getGradientVariant
```
public int getGradientVariant()
```
  - getGradientStyle
```
public int getGradientStyle()
```
  - getGradientStops
```
public GradientStopCollection getGradientStops()
```
  - localToParent
```
public java.awt.geom.Point2D.Float localToParent(java.awt.geom.Point2D.Float value)
```
    Converts a value from the local coordinate space into the coordinate space of the parent shape.
  - getFill
```
public Fill getFill()
```
    Gets fill formatting for the shape.
    
    Returns:
    
    Fill formatting for the shape.
  - getShadowFormat
```
public ShadowFormat getShadowFormat()
```
    Gets shadow formatting for the shape.
    
    Returns:
    
    Shadow formatting for the shape.
  - getScreenTip
```
public java.lang.String getScreenTip()
```
    Defines the text displayed when the mouse pointer moves over the shape.
    The default value is an empty string.
    
    Returns:
    
    The corresponding String value.
  - setScreenTip
```
public void setScreenTip(java.lang.String value)
```
    Defines the text displayed when the mouse pointer moves over the shape.
    The default value is an empty string.
    
    Parameters:
    
    value - The corresponding String value.
  - getHRef
```
public java.lang.String getHRef()
```
    Gets the full hyperlink address for a shape.
    The default value is an empty string.
    
    Below are examples of valid values for this property:
    
    Full URI: https://www.aspose.com/.
    
    Full file name: C:\\My Documents\\SalesReport.doc.
    
    Relative URI: ../../../resource.txt
    
    Relative file name: ..\\My Documents\\SalesReport.doc.
    
    Bookmark within another document: https://www.aspose.com/Products/Default.aspx#Suites
    
    Bookmark within this document: #BookmakName.
    
    Returns:
    
    The full hyperlink address for a shape.
  - setHRef
```
public void setHRef(java.lang.String value)
```
    Sets the full hyperlink address for a shape.
    The default value is an empty string.
    
    Below are examples of valid values for this property:
    
    Full URI: https://www.aspose.com/.
    
    Full file name: C:\\My Documents\\SalesReport.doc.
    
    Relative URI: ../../../resource.txt
    
    Relative file name: ..\\My Documents\\SalesReport.doc.
    
    Bookmark within another document: https://www.aspose.com/Products/Default.aspx#Suites
    
    Bookmark within this document: #BookmakName.
    
    Parameters:
    
    value - The full hyperlink address for a shape.
  - getTarget
```
public java.lang.String getTarget()
```
    Gets the target frame for the shape hyperlink.
    The default value is an empty string.
    
    Returns:
    
    The target frame for the shape hyperlink.
  - setTarget
```
public void setTarget(java.lang.String value)
```
    Sets the target frame for the shape hyperlink.
    The default value is an empty string.
    
    Parameters:
    
    value - The target frame for the shape hyperlink.
  - getAlternativeText
```
public java.lang.String getAlternativeText()
```
    Defines alternative text to be displayed instead of a graphic.
    The default value is an empty string.
    
    Returns:
    
    The corresponding String value.
  - setAlternativeText
```
public void setAlternativeText(java.lang.String value)
```
    Defines alternative text to be displayed instead of a graphic.
    The default value is an empty string.
    
    Parameters:
    
    value - The corresponding String value.
  - isDecorative
```
public boolean isDecorative()
```
    Gets the flag that specifies whether the shape is decorative in the document. Note that shape having not empty getAlternativeText() / setAlternativeText(java.lang.String) cannot be decorative.
    
    Returns:
    
    The flag that specifies whether the shape is decorative in the document.
  - isDecorative
```
public void isDecorative(boolean value)
```
    Sets the flag that specifies whether the shape is decorative in the document. Note that shape having not empty getAlternativeText() / setAlternativeText(java.lang.String) cannot be decorative.
    
    Parameters:
    
    value - The flag that specifies whether the shape is decorative in the document.
  - getTitle
```
public java.lang.String getTitle()
```
    Gets the title (caption) of the current shape object.
    Default is empty string.
    
    Cannot be null, but can be an empty string.
    
    Returns:
    
    The title (caption) of the current shape object.
  - setTitle
```
public void setTitle(java.lang.String value)
```
    Sets the title (caption) of the current shape object.
    Default is empty string.
    
    Cannot be null, but can be an empty string.
    
    Parameters:
    
    value - The title (caption) of the current shape object.
  - getName
```
public java.lang.String getName()
```
    Gets the optional shape name.
    Default is empty string.
    
    Cannot be null, but can be an empty string.
    
    Returns:
    
    The optional shape name.
  - setName
```
public void setName(java.lang.String value)
```
    Sets the optional shape name.
    Default is empty string.
    
    Cannot be null, but can be an empty string.
    
    Parameters:
    
    value - The optional shape name.
  - isInsertRevision
```
public boolean isInsertRevision()
```
    Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
    
    Returns:
    
    True if this object was inserted in Microsoft Word while change tracking was enabled.
  - isDeleteRevision
```
public boolean isDeleteRevision()
```
    Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
    
    Returns:
    
    True if this object was deleted in Microsoft Word while change tracking was enabled.
  - isMoveFromRevision
```
public boolean isMoveFromRevision()
```
    Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
    
    Returns:
    
    true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
  - isMoveToRevision
```
public boolean isMoveToRevision()
```
    Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
    
    Returns:
    
    true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
  - isTopLevel
```
public boolean isTopLevel()
```
    Returns true if this shape is not a child of a group shape.
    
    Returns:
    
    True if this shape is not a child of a group shape.
  - isGroup
```
public boolean isGroup()
```
    Returns true if this is a group shape.
    
    Returns:
    
    True if this is a group shape.
  - isImage
```
public boolean isImage()
```
    Returns true if this shape is an image shape.
    
    Returns:
    
    True if this shape is an image shape.
  - isHorizontalRule
```
public boolean isHorizontalRule()
```
    Returns true if this shape is a horizontal rule.
    
    Returns:
    
    True if this shape is a horizontal rule.
  - isWordArt
```
public boolean isWordArt()
```
    Returns true if this shape is a WordArt object. Works till 2007 compatibility mode. In 2010 and higher compatibility mode WordArt is just a TextBox with fancy fonts.
    
    Returns:
    
    True if this shape is a WordArt object.
  - canHaveImage
```
public boolean canHaveImage()
```
    Returns true if the shape type allows the shape to have an image.
    Although Microsoft Word has a special shape type for images, it appears that in Microsoft Word documents any shape except a group shape can have an image, therefore this property returns true for all shapes except GroupShape.
    
    Returns:
    
    True if the shape type allows the shape to have an image.
  - getAnchorLocked
```
public boolean getAnchorLocked()
```
    Specifies whether the shape's anchor is locked.
    The default value is false.
    
    Has effect only for top level shapes.
    
    This property affects behavior of the shape's anchor in Microsoft Word. When the anchor is not locked, moving the shape in Microsoft Word can move the shape's anchor too.
    
    Returns:
    
    The corresponding boolean value.
  - setAnchorLocked
```
public void setAnchorLocked(boolean value)
```
    Specifies whether the shape's anchor is locked.
    The default value is false.
    
    Has effect only for top level shapes.
    
    This property affects behavior of the shape's anchor in Microsoft Word. When the anchor is not locked, moving the shape in Microsoft Word can move the shape's anchor too.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getAspectRatioLocked
```
public boolean getAspectRatioLocked()
```
    Specifies whether the shape's aspect ratio is locked.
    The default value depends on the getShapeType(), for the ShapeType.Image it is true but for the other shape types it is false.
    
    Has effect for top level shapes only.
    
    Returns:
    
    The corresponding boolean value.
  - setAspectRatioLocked
```
public void setAspectRatioLocked(boolean value)
```
    Specifies whether the shape's aspect ratio is locked.
    The default value depends on the getShapeType(), for the ShapeType.Image it is true but for the other shape types it is false.
    
    Has effect for top level shapes only.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getAllowOverlap
```
public boolean getAllowOverlap()
```
    Gets a value that specifies whether this shape can overlap other shapes.
    This property affects behavior of the shape in Microsoft Word. Aspose.Words ignores the value of this property.
    
    This property is applicable only to top level shapes.
    
    The default value is true.
    
    Returns:
    
    A value that specifies whether this shape can overlap other shapes.
  - setAllowOverlap
```
public void setAllowOverlap(boolean value)
```
    Sets a value that specifies whether this shape can overlap other shapes.
    This property affects behavior of the shape in Microsoft Word. Aspose.Words ignores the value of this property.
    
    This property is applicable only to top level shapes.
    
    The default value is true.
    
    Parameters:
    
    value - A value that specifies whether this shape can overlap other shapes.
  - getBehindText
```
public boolean getBehindText()
```
    Specifies whether the shape is below or above text.
    Has effect only for top level shapes.
    
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
    
    See Also:
    
    getZOrder(), setZOrder(int)
  - setBehindText
```
public void setBehindText(boolean value)
```
    Specifies whether the shape is below or above text.
    Has effect only for top level shapes.
    
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
    
    See Also:
    
    getZOrder(), setZOrder(int)
  - isInline
```
public boolean isInline()
```
    A quick way to determine if this shape is positioned inline with text.
    Has effect only for top level shapes.
    
    Returns:
    
    The corresponding boolean value.
  - getLeft
```
public double getLeft()
```
    Gets the position of the left edge of the containing block of the shape.
    For a top-level shape, the value is in points and relative to the shape anchor.
    
    For shapes in a group, the value is in the coordinate space and units of the parent group.
    
    The default value is 0.
    
    Has effect only for floating shapes.
    
    Returns:
    
    The position of the left edge of the containing block of the shape.
  - setLeft
```
public void setLeft(double value)
```
    Sets the position of the left edge of the containing block of the shape.
    For a top-level shape, the value is in points and relative to the shape anchor.
    
    For shapes in a group, the value is in the coordinate space and units of the parent group.
    
    The default value is 0.
    
    Has effect only for floating shapes.
    
    Parameters:
    
    value - The position of the left edge of the containing block of the shape.
  - getTop
```
public double getTop()
```
    Gets the position of the top edge of the containing block of the shape.
    For a top-level shape, the value is in points and relative to the shape anchor.
    
    For shapes in a group, the value is in the coordinate space and units of the parent group.
    
    The default value is 0.
    
    Has effect only for floating shapes.
    
    Returns:
    
    The position of the top edge of the containing block of the shape.
  - setTop
```
public void setTop(double value)
```
    Sets the position of the top edge of the containing block of the shape.
    For a top-level shape, the value is in points and relative to the shape anchor.
    
    For shapes in a group, the value is in the coordinate space and units of the parent group.
    
    The default value is 0.
    
    Has effect only for floating shapes.
    
    Parameters:
    
    value - The position of the top edge of the containing block of the shape.
  - getRight
```
public double getRight()
```
    Gets the position of the right edge of the containing block of the shape.
    For a top-level shape, the value is in points and relative to the shape anchor.
    
    For shapes in a group, the value is in the coordinate space and units of the parent group.
    
    Returns:
    
    The position of the right edge of the containing block of the shape.
  - getBottom
```
public double getBottom()
```
    Gets the position of the bottom edge of the containing block of the shape.
    For a top-level shape, the value is in points and relative to the shape anchor.
    
    For shapes in a group, the value is in the coordinate space and units of the parent group.
    
    Returns:
    
    The position of the bottom edge of the containing block of the shape.
  - getWidth
```
public double getWidth()
```
    Gets the width of the containing block of the shape.
    For a top-level shape, the value is in points.
    
    For shapes in a group, the value is in the coordinate space and units of the parent group.
    
    The default value is 0.
    
    Returns:
    
    The width of the containing block of the shape.
  - setWidth
```
public void setWidth(double value)
              throws java.lang.Exception
```
    Sets the width of the containing block of the shape.
    For a top-level shape, the value is in points.
    
    For shapes in a group, the value is in the coordinate space and units of the parent group.
    
    The default value is 0.
    
    Parameters:
    
    value - The width of the containing block of the shape.
    
    Throws:
    
    java.lang.Exception
  - getHeight
```
public double getHeight()
```
    Gets the height of the containing block of the shape.
    For a top-level shape, the value is in points.
    
    For shapes in a group, the value is in the coordinate space and units of the parent group.
    
    The default value is 0.
    
    Returns:
    
    The height of the containing block of the shape.
  - setHeight
```
public void setHeight(double value)
               throws java.lang.Exception
```
    Sets the height of the containing block of the shape.
    For a top-level shape, the value is in points.
    
    For shapes in a group, the value is in the coordinate space and units of the parent group.
    
    The default value is 0.
    
    Parameters:
    
    value - The height of the containing block of the shape.
    
    Throws:
    
    java.lang.Exception
  - getDistanceTop
```
public double getDistanceTop()
```
    Gets the distance (in points) between the document text and the top edge of the shape.
    The default value is 0.
    
    Has effect only for top level shapes.
    
    Returns:
    
    The distance (in points) between the document text and the top edge of the shape.
  - setDistanceTop
```
public void setDistanceTop(double value)
```
    Sets the distance (in points) between the document text and the top edge of the shape.
    The default value is 0.
    
    Has effect only for top level shapes.
    
    Parameters:
    
    value - The distance (in points) between the document text and the top edge of the shape.
  - getDistanceBottom
```
public double getDistanceBottom()
```
    Gets the distance (in points) between the document text and the bottom edge of the shape.
    The default value is 0.
    
    Has effect only for top level shapes.
    
    Returns:
    
    The distance (in points) between the document text and the bottom edge of the shape.
  - setDistanceBottom
```
public void setDistanceBottom(double value)
```
    Sets the distance (in points) between the document text and the bottom edge of the shape.
    The default value is 0.
    
    Has effect only for top level shapes.
    
    Parameters:
    
    value - The distance (in points) between the document text and the bottom edge of the shape.
  - getDistanceLeft
```
public double getDistanceLeft()
```
    Gets the distance (in points) between the document text and the left edge of the shape.
    The default value is 1/8 inch.
    
    Has effect only for top level shapes.
    
    Returns:
    
    The distance (in points) between the document text and the left edge of the shape.
  - setDistanceLeft
```
public void setDistanceLeft(double value)
```
    Sets the distance (in points) between the document text and the left edge of the shape.
    The default value is 1/8 inch.
    
    Has effect only for top level shapes.
    
    Parameters:
    
    value - The distance (in points) between the document text and the left edge of the shape.
  - getDistanceRight
```
public double getDistanceRight()
```
    Gets the distance (in points) between the document text and the right edge of the shape.
    The default value is 1/8 inch.
    
    Has effect only for top level shapes.
    
    Returns:
    
    The distance (in points) between the document text and the right edge of the shape.
  - setDistanceRight
```
public void setDistanceRight(double value)
```
    Sets the distance (in points) between the document text and the right edge of the shape.
    The default value is 1/8 inch.
    
    Has effect only for top level shapes.
    
    Parameters:
    
    value - The distance (in points) between the document text and the right edge of the shape.
  - getRotation
```
public double getRotation()
```
    Defines the angle (in degrees) that a shape is rotated. Positive value corresponds to clockwise rotation angle.
    The default value is 0.
    
    Returns:
    
    The corresponding double value.
  - setRotation
```
public void setRotation(double value)
```
    Defines the angle (in degrees) that a shape is rotated. Positive value corresponds to clockwise rotation angle.
    The default value is 0.
    
    Parameters:
    
    value - The corresponding double value.
  - getZOrder
```
public int getZOrder()
```
    Determines the display order of overlapping shapes.
    Has effect only for top level shapes.
    
    The default value is 0.
    
    The number represents the stacking precedence. A shape with a higher number will be displayed as if it were overlapping (in "front" of) a shape with a lower number.
    
    The order of overlapping shapes is independent for shapes in the header and in the main text of the document.
    
    The display order of child shapes in a group shape is determined by their order inside the group shape.
    
    Returns:
    
    The corresponding int value.
    
    See Also:
    
    getBehindText(), setBehindText(boolean)
  - setZOrder
```
public void setZOrder(int value)
```
    Determines the display order of overlapping shapes.
    Has effect only for top level shapes.
    
    The default value is 0.
    
    The number represents the stacking precedence. A shape with a higher number will be displayed as if it were overlapping (in "front" of) a shape with a lower number.
    
    The order of overlapping shapes is independent for shapes in the header and in the main text of the document.
    
    The display order of child shapes in a group shape is determined by their order inside the group shape.
    
    Parameters:
    
    value - The corresponding int value.
    
    See Also:
    
    getBehindText(), setBehindText(boolean)
  - getParentParagraph
```
public Paragraph getParentParagraph()
```
    Returns the immediate parent paragraph. For child shapes of a group shape and child shapes of an Office Math object always returns null.
    
    Returns:
    
    The immediate parent paragraph.
  - getBounds
```
public java.awt.geom.Rectangle2D.Float getBounds()
```
    Gets the location and size of the containing block of the shape. Ignores aspect ratio lock upon setting.
    For a top-level shape, the value is in points and relative to the shape anchor.
    
    For shapes in a group, the value is in the coordinate space and units of the parent group.
    
    Returns:
    
    The location and size of the containing block of the shape.
  - setBounds
```
public void setBounds(java.awt.geom.Rectangle2D.Float value)
```
    Sets the location and size of the containing block of the shape. Ignores aspect ratio lock upon setting.
    For a top-level shape, the value is in points and relative to the shape anchor.
    
    For shapes in a group, the value is in the coordinate space and units of the parent group.
    
    Parameters:
    
    value - The location and size of the containing block of the shape.
  - getBoundsInPoints
```
public java.awt.geom.Rectangle2D.Float getBoundsInPoints()
```
    Gets the location and size of the containing block of the shape in points, relative to the anchor of the topmost shape.
    
    Returns:
    
    The location and size of the containing block of the shape in points, relative to the anchor of the topmost shape.
  - getBoundsWithEffects
```
public java.awt.geom.Rectangle2D.Float getBoundsWithEffects()
```
    Gets final extent that this shape object has after applying drawing effects. Value is measured in points.
    
    Returns:
    
    Final extent that this shape object has after applying drawing effects.
  - adjustWithEffects
```
public java.awt.geom.Rectangle2D.Float adjustWithEffects(java.awt.geom.Rectangle2D.Float source)
```
    Adds to the source rectangle values of the effect extent and returns the final rectangle.
  - getShapeType
```
public int getShapeType()
```
    Gets the shape type.
    
    Returns:
    
    The shape type. The returned value is one of ShapeType constants.
  - getMarkupLanguage
```
public byte getMarkupLanguage()
```
    Gets MarkupLanguage used for this graphic object.
    
    Returns:
    
    MarkupLanguage used for this graphic object. The returned value is one of ShapeMarkupLanguage constants.
  - getSizeInPoints
```
public java.awt.geom.Point2D.Float getSizeInPoints()
```
    Gets the size of the shape in points. Gets the size of the shape in points.
    Point2D.Float is used as return type because we need in float dimension values here. One should to assume that Point2D's x == width and y == height.
    
    Returns:
    
    The size of the shape in points.
  - getFlipOrientation
```
public int getFlipOrientation()
```
    Switches the orientation of a shape.
    The default value is FlipOrientation.NONE.
    
    Returns:
    
    The corresponding int value. The returned value is a bitwise combination of FlipOrientation constants.
  - setFlipOrientation
```
public void setFlipOrientation(int value)
```
    Switches the orientation of a shape.
    The default value is FlipOrientation.NONE.
    
    Parameters:
    
    value - The corresponding int value. The value must be a bitwise combination of FlipOrientation constants.
  - getRelativeHorizontalPosition
```
public int getRelativeHorizontalPosition()
```
    Specifies relative to what the shape is positioned horizontally.
    The default value is RelativeHorizontalPosition.COLUMN.
    
    Has effect only for top level floating shapes.
    
    Returns:
    
    The corresponding int value. The returned value is one of RelativeHorizontalPosition constants.
  - setRelativeHorizontalPosition
```
public void setRelativeHorizontalPosition(int value)
```
    Specifies relative to what the shape is positioned horizontally.
    The default value is RelativeHorizontalPosition.COLUMN.
    
    Has effect only for top level floating shapes.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of RelativeHorizontalPosition constants.
  - getRelativeVerticalPosition
```
public int getRelativeVerticalPosition()
```
    Specifies relative to what the shape is positioned vertically.
    The default value is RelativeVerticalPosition.PARAGRAPH.
    
    Has effect only for top level floating shapes.
    
    Returns:
    
    The corresponding int value. The returned value is one of RelativeVerticalPosition constants.
  - setRelativeVerticalPosition
```
public void setRelativeVerticalPosition(int value)
```
    Specifies relative to what the shape is positioned vertically.
    The default value is RelativeVerticalPosition.PARAGRAPH.
    
    Has effect only for top level floating shapes.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of RelativeVerticalPosition constants.
  - getHorizontalAlignment
```
public int getHorizontalAlignment()
```
    Specifies how the shape is positioned horizontally.
    The default value is HorizontalAlignment.NONE.
    
    Has effect only for top level floating shapes.
    
    Returns:
    
    The corresponding int value. The returned value is one of HorizontalAlignment constants.
  - setHorizontalAlignment
```
public void setHorizontalAlignment(int value)
```
    Specifies how the shape is positioned horizontally.
    The default value is HorizontalAlignment.NONE.
    
    Has effect only for top level floating shapes.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of HorizontalAlignment constants.
  - getVerticalAlignment
```
public int getVerticalAlignment()
```
    Specifies how the shape is positioned vertically.
    The default value is VerticalAlignment.NONE.
    
    Has effect only for top level floating shapes.
    
    Returns:
    
    The corresponding int value. The returned value is one of VerticalAlignment constants.
  - setVerticalAlignment
```
public void setVerticalAlignment(int value)
```
    Specifies how the shape is positioned vertically.
    The default value is VerticalAlignment.NONE.
    
    Has effect only for top level floating shapes.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of VerticalAlignment constants.
  - getWrapType
```
public int getWrapType()
```
    Defines whether the shape is inline or floating. For floating shapes defines the wrapping mode for text around the shape.
    The default value is WrapType.NONE.
    
    Has effect only for top level shapes.
    
    Returns:
    
    The corresponding int value. The returned value is one of WrapType constants.
  - setWrapType
```
public void setWrapType(int value)
```
    Defines whether the shape is inline or floating. For floating shapes defines the wrapping mode for text around the shape.
    The default value is WrapType.NONE.
    
    Has effect only for top level shapes.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of WrapType constants.
  - getWrapSide
```
public int getWrapSide()
```
    Specifies how the text is wrapped around the shape.
    The default value is WrapSide.BOTH.
    
    Has effect only for top level shapes.
    
    Returns:
    
    The corresponding int value. The returned value is one of WrapSide constants.
  - setWrapSide
```
public void setWrapSide(int value)
```
    Specifies how the text is wrapped around the shape.
    The default value is WrapSide.BOTH.
    
    Has effect only for top level shapes.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of WrapSide constants.
  - getCoordOrigin
```
public java.awt.Point getCoordOrigin()
```
    The coordinates at the top-left corner of the containing block of this shape.
    The default value is (0,0).
    
    Returns:
    
    The corresponding Point value.
  - setCoordOrigin
```
public void setCoordOrigin(java.awt.Point value)
```
    The coordinates at the top-left corner of the containing block of this shape.
    The default value is (0,0).
    
    Parameters:
    
    value - The corresponding Point value.
  - getCoordSize
```
public java.awt.Dimension getCoordSize()
```
    The width and height of the coordinate space inside the containing block of this shape.
    The default value is (1000, 1000).
    
    Returns:
    
    The corresponding Dimension value.
  - setCoordSize
```
public void setCoordSize(java.awt.Dimension value)
```
    The width and height of the coordinate space inside the containing block of this shape.
    The default value is (1000, 1000).
    
    Parameters:
    
    value - The corresponding Dimension value.
  - getFont
```
public Font getFont()
```
    Provides access to the font formatting of this object.
    
    Returns:
    
    The corresponding Font value.
  - isSignatureLine
```
public boolean isSignatureLine()
```
    Indicates that shape is a SignatureLine.
    
    Returns:
    
    The corresponding boolean value.
  - isLayoutInCell
```
public boolean isLayoutInCell()
```
    Gets a flag indicating whether the shape is displayed inside a table or outside of it.
    The default value is true.
    
    Has effect only for top level shapes, the property getWrapType() / setWrapType(int) of which is set to value other than Inline.
    
    Returns:
    
    A flag indicating whether the shape is displayed inside a table or outside of it.
  - isLayoutInCell
```
public void isLayoutInCell(boolean value)
```
    Sets a flag indicating whether the shape is displayed inside a table or outside of it.
    The default value is true.
    
    Has effect only for top level shapes, the property getWrapType() / setWrapType(int) of which is set to value other than Inline.
    
    Parameters:
    
    value - A flag indicating whether the shape is displayed inside a table or outside of it.

Class ShapeBase

Constructor Summary

Method Summary

Methods inherited from class com.aspose.words.CompositeNode

Methods inherited from class com.aspose.words.Node

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

ShapeBase

Method Detail

getShapeRenderer

getParentParagraph_IInline

getDocument_IInline

getZOrder_IShape

setZOrder_IShape

getDirectShapeAttr

fetchInheritedShapeAttr

fetchShapeAttr

setShapeAttr

removeShapeAttr

removeMoveRevisions

getDirectRunAttr

fetchInheritedRunAttr

setRunAttr

removeRunAttr

clearRunAttrs

solid

getPresetTexture

getPatternType

presetTextured

patterned

twoColorGradient

oneColorGradient

setImage

getFilledColor

setFilledColor

getOn

setOn

getOpacity

setOpacity

getFillableImageBytes

getFillableForeColor

setFillableForeColor

getFillableBackColor

setFillableBackColor

getFillableVisible

setFillableVisible

getFillableTransparency

setFillableTransparency

getRotateWithObject

setRotateWithObject

getFillType

getTextureAlignment

setTextureAlignment

getGradientAngle

setGradientAngle

getGradientVariant

getGradientStyle

getGradientStops

localToParent

getFill

getShadowFormat

getScreenTip

setScreenTip

getHRef

setHRef

getTarget

setTarget

getAlternativeText

setAlternativeText

isDecorative

isDecorative

getTitle

setTitle

getName

setName

isInsertRevision

isDeleteRevision

isMoveFromRevision

isMoveToRevision