Shape (Aspose.Words for Java API Reference)

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

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable
```
public final class Shape
extends ShapeBase
```
Represents an object in the drawing layer, such as an AutoShape, textbox, freeform, OLE object, ActiveX control, or picture.
Using the Shape class you can create or modify shapes in a Microsoft Word document.

An important property of a shape is its ShapeBase.getShapeType(). Shapes of different types can have different capabilities in a Word document. For example, only image and OLE shapes can have images inside them. Most of the shapes can have text, but not all.

Shapes that can have text, can contain Paragraph and Table nodes as children.

See Also:

ShapeBase, GroupShape

Constructor Summary

Constructors
Constructor and Description

Shape(DocumentBase doc, int shapeType)
Initializes a new instance of this class.

Constructors
Constructor and Description
`Shape(DocumentBase doc, int shapeType)` Initializes a new instance of this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accept(DocumentVisitor visitor)` Accepts a visitor.
`Chart`	`getChart()` Provides access to the chart properties if this shape has a Chart.
`int`	`getDashStyle()`
`int`	`getEndArrowLength()`
`int`	`getEndArrowType()`
`int`	`getEndArrowWidth()`
`int`	`getEndCap()`
`boolean`	`getExtrusionEnabled()` Returns true if an extrusion effect is enabled.
`java.awt.Color`	`getFillColor()` Defines the brush color that fills the closed path of the shape.
`boolean`	`getFilled()` Determines whether the closed path of the shape will be filled.
`Paragraph`	`getFirstParagraph()` Gets the first paragraph in the shape.
`float`	`getHorizontalMargins_ITextBox()`
`HorizontalRuleFormat`	`getHorizontalRuleFormat()` Provides access to the properties of the horizontal rule shape.
`ImageData`	`getImageData()` Provides access to the image of the shape.
`int`	`getJoinStyle()`
`Paragraph`	`getLastParagraph()` Gets the last paragraph in the shape.
`int`	`getLineFillType()`
`int`	`getLineStyle()`
`byte`	`getMarkupLanguage_ITextBox()`
`int`	`getNodeType()` Returns `NodeType.SHAPE`.
`OleFormat`	`getOleFormat()` Provides access to the OLE data of a shape.
`boolean`	`getShadowEnabled()` Returns true if a shadow effect is enabled.
`SignatureLine`	`getSignatureLine()` Gets `getSignatureLine()` object if the shape is a signature line.
`int`	`getStartArrowLength()`
`int`	`getStartArrowType()`
`int`	`getStartArrowWidth()`
`int`	`getStoryType()` Returns `StoryType.TEXTBOX`.
`Stroke`	`getStroke()` Defines a stroke for a shape.
`java.awt.Color`	`getStrokeColor()` Defines the color of a stroke.
`boolean`	`getStroked()` Defines whether the path will be stroked.
`byte[]`	`getStrokeImageBytes()`
`double`	`getStrokeTransparency()`
`boolean`	`getStrokeVisible()`
`double`	`getStrokeWeight()` Defines the brush thickness that strokes the path of a shape in points.
`TextBox`	`getTextBox()` Defines attributes that specify how text is displayed in a shape.
`int`	`getTextboxLayoutFlow_ITextBox()`
`int`	`getTextBoxWrapMode_ITextBox()`
`TextPath`	`getTextPath()` Defines the text of the text path (of a WordArt object).
`double`	`getWeight()`
`boolean`	`hasChart()` Returns true if this Shape has a `getChart()`.
`boolean`	`hasImage()` Returns true if the shape has image bytes or links an image.
`boolean`	`hasSmartArt()` Returns true if this Shape has a SmartArt object.
`boolean`	`hasVerticalTextFlow_ITextBox()`
`void`	`setDashStyle(int value)`
`void`	`setEndArrowLength(int value)`
`void`	`setEndArrowType(int value)`
`void`	`setEndArrowWidth(int value)`
`void`	`setEndCap(int value)`
`void`	`setFillColor(java.awt.Color value)` Defines the brush color that fills the closed path of the shape.
`void`	`setFilled(boolean value)` Determines whether the closed path of the shape will be filled.
`void`	`setJoinStyle(int value)`
`void`	`setLineFillType(int value)`
`void`	`setLineStyle(int value)`
`void`	`setStartArrowLength(int value)`
`void`	`setStartArrowType(int value)`
`void`	`setStartArrowWidth(int value)`
`void`	`setStrokeColor(java.awt.Color value)` Defines the color of a stroke.
`void`	`setStroked(boolean value)` Defines whether the path will be stroked.
`void`	`setStrokeTransparency(double value)`
`void`	`setStrokeVisible(boolean value)`
`void`	`setStrokeWeight(double value)` Defines the brush thickness that strokes the path of a shape in points.
`void`	`setWeight(double value)`
`void`	`updateSmartArtDrawing()` Updates SmartArt pre-rendered drawing by using Aspose.Words's SmartArt cold rendering engine.

Methods inherited from class com.aspose.words.ShapeBase
adjustWithEffects, canHaveImage, clearRunAttrs, fetchInheritedRunAttr, fetchInheritedShapeAttr, fetchShapeAttr, getAllowOverlap, getAlternativeText, getAnchorLocked, getAspectRatioLocked, getBehindText, getBottom, getBounds, getBoundsInPoints, getBoundsWithEffects, getCoordOrigin, getCoordSize, getDirectRunAttr, getDirectShapeAttr, getDistanceBottom, getDistanceLeft, getDistanceRight, getDistanceTop, getDocument_IInline, getFill, getFillableBackColor, getFillableForeColor, getFillableImageBytes, getFillableTransparency, getFillableVisible, getFilledColor, getFillType, getFlipOrientation, getFont, getGradientAngle, getGradientStops, getGradientStyle, getGradientVariant, getHeight, getHorizontalAlignment, getHRef, getLeft, getMarkupLanguage, getName, getOn, getOpacity, getParentParagraph_IInline, getParentParagraph, getPatternType, getPresetTexture, getRelativeHorizontalPosition, getRelativeVerticalPosition, getRight, getRotateWithObject, getRotation, getScreenTip, getShadowFormat, getShapeRenderer, getShapeType, getSizeInPoints, getTarget, getTextureAlignment, getTitle, getTop, getVerticalAlignment, getWidth, getWrapSide, getWrapType, getZOrder_IShape, getZOrder, isDecorative, isDecorative, isDeleteRevision, isGroup, isHorizontalRule, isImage, isInline, isInsertRevision, isLayoutInCell, isLayoutInCell, isMoveFromRevision, isMoveToRevision, isSignatureLine, isTopLevel, isWordArt, localToParent, oneColorGradient, patterned, presetTextured, removeMoveRevisions, removeRunAttr, removeShapeAttr, setAllowOverlap, setAlternativeText, setAnchorLocked, setAspectRatioLocked, setBehindText, setBounds, setCoordOrigin, setCoordSize, setDistanceBottom, setDistanceLeft, setDistanceRight, setDistanceTop, setFillableBackColor, setFillableForeColor, setFillableTransparency, setFillableVisible, setFilledColor, setFlipOrientation, setGradientAngle, setHeight, setHorizontalAlignment, setHRef, setImage, setLeft, setName, setOn, setOpacity, setRelativeHorizontalPosition, setRelativeVerticalPosition, setRotateWithObject, setRotation, setRunAttr, setScreenTip, setShapeAttr, setTarget, setTextureAlignment, setTitle, setTop, setVerticalAlignment, setWidth, setWrapSide, setWrapType, setZOrder_IShape, setZOrder, solid, twoColorGradient

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
dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getDocument, getNextSibling, 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
  - Shape
```
public Shape(DocumentBase doc,
             int shapeType)
```
    Initializes a new instance of this class.
- Method Detail
  - accept
```
public final boolean accept(DocumentVisitor visitor)
                     throws java.lang.Exception
```
    Accepts a visitor.
    Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.
    
    For more info see the Visitor design pattern.
    
    Specified by:
    
    accept in class Node
    
    Parameters:
    
    visitor - The visitor that will visit the nodes.
    
    Returns:
    
    True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.
    
    Throws:
    
    java.lang.Exception
  - getHorizontalMargins_ITextBox
```
public final float getHorizontalMargins_ITextBox()
```
  - getStrokeVisible
```
public final boolean getStrokeVisible()
```
  - setStrokeVisible
```
public final void setStrokeVisible(boolean value)
```
  - getStrokeTransparency
```
public final double getStrokeTransparency()
```
  - setStrokeTransparency
```
public final void setStrokeTransparency(double value)
```
  - getWeight
```
public final double getWeight()
```
  - setWeight
```
public final void setWeight(double value)
```
  - getDashStyle
```
public final int getDashStyle()
```
  - setDashStyle
```
public final void setDashStyle(int value)
```
  - getJoinStyle
```
public final int getJoinStyle()
```
  - setJoinStyle
```
public final void setJoinStyle(int value)
```
  - getEndCap
```
public final int getEndCap()
```
  - setEndCap
```
public final void setEndCap(int value)
```
  - getLineStyle
```
public final int getLineStyle()
```
  - setLineStyle
```
public final void setLineStyle(int value)
```
  - getStartArrowType
```
public final int getStartArrowType()
```
  - setStartArrowType
```
public final void setStartArrowType(int value)
```
  - getEndArrowType
```
public final int getEndArrowType()
```
  - setEndArrowType
```
public final void setEndArrowType(int value)
```
  - getStartArrowWidth
```
public final int getStartArrowWidth()
```
  - setStartArrowWidth
```
public final void setStartArrowWidth(int value)
```
  - getStartArrowLength
```
public final int getStartArrowLength()
```
  - setStartArrowLength
```
public final void setStartArrowLength(int value)
```
  - getEndArrowWidth
```
public final int getEndArrowWidth()
```
  - setEndArrowWidth
```
public final void setEndArrowWidth(int value)
```
  - getEndArrowLength
```
public final int getEndArrowLength()
```
  - setEndArrowLength
```
public final void setEndArrowLength(int value)
```
  - getLineFillType
```
public final int getLineFillType()
```
  - setLineFillType
```
public final void setLineFillType(int value)
```
  - getStrokeImageBytes
```
public final byte[] getStrokeImageBytes()
                                 throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getNodeType
```
public final int getNodeType()
```
    Returns NodeType.SHAPE.
    
    Specified by:
    
    getNodeType in class Node
    
    Returns:
    
    NodeType.SHAPE. The returned value is one of NodeType constants.
  - getStoryType
```
public final int getStoryType()
```
    Returns StoryType.TEXTBOX.
    
    Returns:
    
    StoryType.TEXTBOX. The returned value is one of StoryType constants.
  - getExtrusionEnabled
```
public final boolean getExtrusionEnabled()
```
    Returns true if an extrusion effect is enabled.
    
    Returns:
    
    True if an extrusion effect is enabled.
  - getShadowEnabled
```
public final boolean getShadowEnabled()
```
    Returns true if a shadow effect is enabled.
    
    Returns:
    
    True if a shadow effect is enabled.
  - getStroke
```
public final Stroke getStroke()
```
    Defines a stroke for a shape.
    
    Returns:
    
    The corresponding Stroke value.
  - getStroked
```
public final boolean getStroked()
```
    Defines whether the path will be stroked.
    This is a shortcut to the Stroke.getOn() / Stroke.setOn(boolean) property.
    
    The default value is true.
    
    Returns:
    
    The corresponding boolean value.
  - setStroked
```
public final void setStroked(boolean value)
```
    Defines whether the path will be stroked.
    This is a shortcut to the Stroke.getOn() / Stroke.setOn(boolean) property.
    
    The default value is true.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getStrokeWeight
```
public final double getStrokeWeight()
```
    Defines the brush thickness that strokes the path of a shape in points.
    This is a shortcut to the Stroke.getWeight() / Stroke.setWeight(double) property.
    
    The default value is 0.75.
    
    Returns:
    
    The corresponding double value.
  - setStrokeWeight
```
public final void setStrokeWeight(double value)
```
    Defines the brush thickness that strokes the path of a shape in points.
    This is a shortcut to the Stroke.getWeight() / Stroke.setWeight(double) property.
    
    The default value is 0.75.
    
    Parameters:
    
    value - The corresponding double value.
  - getStrokeColor
```
public final java.awt.Color getStrokeColor()
```
    Defines the color of a stroke.
    This is a shortcut to the Stroke.getColor() / Stroke.setColor(java.awt.Color) property.
    
    The default value is .
    
    Returns:
    
    The corresponding Color value.
  - setStrokeColor
```
public final void setStrokeColor(java.awt.Color value)
```
    Defines the color of a stroke.
    This is a shortcut to the Stroke.getColor() / Stroke.setColor(java.awt.Color) property.
    
    The default value is .
    
    Parameters:
    
    value - The corresponding Color value.
  - getFilled
```
public final boolean getFilled()
```
    Determines whether the closed path of the shape will be filled.
    This is a shortcut to the Fill.getOn() / Fill.setOn(boolean) property.
    
    The default value is true.
    
    Returns:
    
    The corresponding boolean value.
  - setFilled
```
public final void setFilled(boolean value)
```
    Determines whether the closed path of the shape will be filled.
    This is a shortcut to the Fill.getOn() / Fill.setOn(boolean) property.
    
    The default value is true.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getFillColor
```
public final java.awt.Color getFillColor()
```
    Defines the brush color that fills the closed path of the shape.
    This is a shortcut to the Fill.getColor() / Fill.setColor(java.awt.Color) property.
    
    The default value is .
    
    Returns:
    
    The corresponding Color value.
  - setFillColor
```
public final void setFillColor(java.awt.Color value)
```
    Defines the brush color that fills the closed path of the shape.
    This is a shortcut to the Fill.getColor() / Fill.setColor(java.awt.Color) property.
    
    The default value is .
    
    Parameters:
    
    value - The corresponding Color value.
  - hasImage
```
public final boolean hasImage()
                       throws java.lang.Exception
```
    Returns true if the shape has image bytes or links an image.
    
    Returns:
    
    True if the shape has image bytes or links an image.
    
    Throws:
    
    java.lang.Exception
  - getImageData
```
public final ImageData getImageData()
```
    Provides access to the image of the shape. Returns null if the shape cannot have an image.
    
    Returns:
    
    The corresponding ImageData value.
  - getOleFormat
```
public final OleFormat getOleFormat()
```
    Provides access to the OLE data of a shape. For a shape that is not an OLE object or ActiveX control, returns null.
    
    Returns:
    
    The corresponding OleFormat value.
  - getTextBox
```
public final TextBox getTextBox()
```
    Defines attributes that specify how text is displayed in a shape.
    
    Returns:
    
    The corresponding TextBox value.
  - getTextPath
```
public final TextPath getTextPath()
```
    Defines the text of the text path (of a WordArt object).
    
    Returns:
    
    The corresponding TextPath value.
  - getFirstParagraph
```
public final Paragraph getFirstParagraph()
```
    Gets the first paragraph in the shape.
    
    Returns:
    
    The first paragraph in the shape.
  - getLastParagraph
```
public final Paragraph getLastParagraph()
```
    Gets the last paragraph in the shape.
    
    Returns:
    
    The last paragraph in the shape.
  - getHorizontalRuleFormat
```
public final HorizontalRuleFormat getHorizontalRuleFormat()
```
    Provides access to the properties of the horizontal rule shape. For a shape that is not a horizontal rule, returns null.
    
    Returns:
    
    The corresponding HorizontalRuleFormat value.
  - getSignatureLine
```
public final SignatureLine getSignatureLine()
```
    Gets getSignatureLine() object if the shape is a signature line. Returns null otherwise. You can insert new SignatureLines into the document using DocumentBuilder.insertSignatureLine(com.aspose.words.SignatureLineOptions) and M:Aspose.Words.DocumentBuilder.InsertSignatureLine(Aspose.Words.SignatureLineOptions,Aspose.Words.Drawing.RelativeHorizontalPosition,System.Double,Aspose.Words.Drawing.RelativeVerticalPosition,System.Double,Aspose.Words.Drawing.WrapType)
    
    Returns:
    
    getSignatureLine() object if the shape is a signature line.
  - getTextBoxWrapMode_ITextBox
```
public final int getTextBoxWrapMode_ITextBox()
```
  - getTextboxLayoutFlow_ITextBox
```
public final int getTextboxLayoutFlow_ITextBox()
```
  - hasVerticalTextFlow_ITextBox
```
public final boolean hasVerticalTextFlow_ITextBox()
```
  - getMarkupLanguage_ITextBox
```
public final byte getMarkupLanguage_ITextBox()
```
  - hasChart
```
public final boolean hasChart()
```
    Returns true if this Shape has a getChart().
    
    Returns:
    
    True if this Shape has a getChart().
  - hasSmartArt
```
public final boolean hasSmartArt()
```
    Returns true if this Shape has a SmartArt object.
    
    Returns:
    
    True if this Shape has a SmartArt object.
  - updateSmartArtDrawing
```
public final void updateSmartArtDrawing()
                                 throws java.lang.Exception
```
    Updates SmartArt pre-rendered drawing by using Aspose.Words's SmartArt cold rendering engine. Microsoft Word generates and saves the pre-rendered drawing along with SmartArt object. However, if the document is saved by other applications, the pre-rendered SmartArt drawing may be missing or incorrect. If pre-rendered drawing is available then Aspose.Words uses it to render the SmartArt object. If pre-rendered drawing is missing then Aspose.Words uses its own SmartArt cold rendering engine to render the SmartArt object. If pre-rendered drawing is incorrect then it is required to call this method to invoke the SmartArt cold rendering engine.
    
    Throws:
    
    java.lang.Exception
  - getChart
```
public final Chart getChart()
```
    Provides access to the chart properties if this shape has a Chart. This property will return the getChart() object only if hasChart() property is true for this Shape, and will throw an exception otherwise.
    
    Returns:
    
    The corresponding Chart value.

Class Shape

Constructor Summary

Method Summary

Methods inherited from class com.aspose.words.ShapeBase

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

Shape

Method Detail

accept

getHorizontalMargins_ITextBox

getStrokeVisible

setStrokeVisible

getStrokeTransparency

setStrokeTransparency

getWeight

setWeight

getDashStyle

setDashStyle

getJoinStyle

setJoinStyle

getEndCap

setEndCap

getLineStyle

setLineStyle

getStartArrowType

setStartArrowType

getEndArrowType

setEndArrowType

getStartArrowWidth

setStartArrowWidth

getStartArrowLength

setStartArrowLength

getEndArrowWidth

setEndArrowWidth

getEndArrowLength

setEndArrowLength

getLineFillType

setLineFillType

getStrokeImageBytes

getNodeType

getStoryType

getExtrusionEnabled

getShadowEnabled

getStroke

getStroked

setStroked

getStrokeWeight

setStrokeWeight

getStrokeColor

setStrokeColor

getFilled

setFilled

getFillColor

setFillColor

hasImage

getImageData

getOleFormat

getTextBox

getTextPath

getFirstParagraph

getLastParagraph

getHorizontalRuleFormat

getSignatureLine

getTextBoxWrapMode_ITextBox

getTextboxLayoutFlow_ITextBox

hasVerticalTextFlow_ITextBox

getMarkupLanguage_ITextBox

hasChart

hasSmartArt

updateSmartArtDrawing

getChart