com.aspose.words
Class ShapeBase

java.lang.Object
  extended by Node
      extended by CompositeNode
          extended by com.aspose.words.ShapeBase
All Implemented Interfaces:
java.lang.Iterable, java.lang.Cloneable
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 CoordSize and CoordOrigin properties of the parent group shape.

A shape can be positioned inline with text or floating. The positioning method is controlled using the WrapType 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 RelativeHorizontalPosition and RelativeVerticalPosition properties.

A floating shape be positioned explicitly using the Left and Top properties or aligned relative to some other object using the HorizontalAlignment and VerticalAlignment properties.

See Also:
Shape, GroupShape

Property Getters/Setters Summary
booleangetAllowOverlap()
voidsetAllowOverlap(boolean value)
           Gets or sets a value that specifies whether this shape can overlap other shapes.
java.lang.StringgetAlternativeText()
voidsetAlternativeText(java.lang.String value)
           Defines alternative text to be displayed instead of a graphic.
booleangetAnchorLocked()
voidsetAnchorLocked(boolean value)
           Specifies whether the shape's anchor is locked.
booleangetAspectRatioLocked()
voidsetAspectRatioLocked(boolean value)
           Specifies whether the shape's aspect ratio is locked.
booleangetBehindText()
voidsetBehindText(boolean value)
           Specifies whether the shape is below or above text.
doublegetBottom()
           Gets the position of the bottom edge of the containing block of the shape.
java.awt.geom.Rectangle2D.FloatgetBounds()
           Gets or sets the location and size of the containing block of the shape.
java.awt.geom.Rectangle2D.FloatgetBoundsInPoints()
           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.FloatgetBoundsWithEffects()
           Gets final extent that this shape object has after applying drawing effects. Value is measured in points.
booleancanHaveImage()
           Returns true if the shape type allows the shape to have an image.
NodeCollectiongetChildNodes()→ inherited from CompositeNode
           Gets all immediate child nodes of this node.
java.awt.PointgetCoordOrigin()
           The coordinates at the top-left corner of the containing block of this shape.
java.awt.DimensiongetCoordSize()
           The width and height of the coordinate space inside the containing block of this shape.
intgetCount()→ inherited from CompositeNode
           Gets the number of immediate children of this node.
doublegetDistanceBottom()
voidsetDistanceBottom(double value)
           Returns or sets the distance (in points) between the document text and the bottom edge of the shape.
doublegetDistanceLeft()
voidsetDistanceLeft(double value)
           Returns or sets the distance (in points) between the document text and the left edge of the shape.
doublegetDistanceRight()
voidsetDistanceRight(double value)
           Returns or sets the distance (in points) between the document text and the right edge of the shape.
doublegetDistanceTop()
voidsetDistanceTop(double value)
           Returns or sets the distance (in points) between the document text and the top edge of the shape.
DocumentBasegetDocument()→ inherited from Node
           Gets the document to which this node belongs.
NodegetFirstChild()→ inherited from CompositeNode
           Gets the first child of the node.
intgetFlipOrientation()
voidsetFlipOrientation(int value)
           Switches the orientation of a shape. The value of the property is FlipOrientation integer constant.
FontgetFont()
           Provides access to the font formatting of this object.
booleanhasChildNodes()→ inherited from CompositeNode
           Returns true if this node has any child nodes.
doublegetHeight()
voidsetHeight(double value)
           Gets or sets the height of the containing block of the shape.
intgetHorizontalAlignment()
voidsetHorizontalAlignment(int value)
           Specifies how the shape is positioned horizontally. The value of the property is HorizontalAlignment integer constant.
java.lang.StringgetHRef()
voidsetHRef(java.lang.String value)
           Gets or sets the full hyperlink address for a shape.
booleanisComposite()→ inherited from CompositeNode
           Returns true as this node can have child nodes.
booleanisDeleteRevision()
           Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
booleanisGroup()
           Returns true if this is a group shape.
booleanisHorizontalRule()
           Returns true if this shape is a horizontal rule.
booleanisImage()
           Returns true if this shape is an image shape.
booleanisInline()
           A quick way to determine if this shape is positioned inline with text.
booleanisInsertRevision()
           Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
booleanisSignatureLine()
           Indicates that shape is a SignatureLine.
booleanisTopLevel()
           Returns true if this shape is not a child of a group shape.
booleanisWordArt()
           Returns true if this shape is a WordArt object.
NodegetLastChild()→ inherited from CompositeNode
           Gets the last child of the node.
doublegetLeft()
voidsetLeft(double value)
           Gets or sets the position of the left edge of the containing block of the shape.
bytegetMarkupLanguage()
           Gets MarkupLanguage used for this graphic object. The value of the property is ShapeMarkupLanguage integer constant.
java.lang.StringgetName()
voidsetName(java.lang.String value)
           Gets or sets the optional shape name.
NodegetNextSibling()→ inherited from Node
           Gets the node immediately following this node.
abstract intgetNodeType()→ inherited from Node
           Gets the type of this node. The value of the property is NodeType integer constant.
CompositeNodegetParentNode()→ inherited from Node
           Gets the immediate parent of this node.
ParagraphgetParentParagraph()
           Returns the immediate parent paragraph.
NodegetPreviousSibling()→ inherited from Node
           Gets the node immediately preceding this node.
RangegetRange()→ inherited from Node
           Returns a Range object that represents the portion of a document that is contained in this node.
intgetRelativeHorizontalPosition()
voidsetRelativeHorizontalPosition(int value)
           Specifies relative to what the shape is positioned horizontally. The value of the property is RelativeHorizontalPosition integer constant.
intgetRelativeVerticalPosition()
voidsetRelativeVerticalPosition(int value)
           Specifies relative to what the shape is positioned vertically. The value of the property is RelativeVerticalPosition integer constant.
doublegetRight()
           Gets the position of the right edge of the containing block of the shape.
doublegetRotation()
voidsetRotation(double value)
           Defines the angle (in degrees) that a shape is rotated. Positive value corresponds to clockwise rotation angle.
java.lang.StringgetScreenTip()
voidsetScreenTip(java.lang.String value)
           Defines the text displayed when the mouse pointer moves over the shape.
intgetShapeType()
           Gets the shape type. The value of the property is ShapeType integer constant.
java.awt.DimensiongetSizeInPoints()
           Gets the size of the shape in points.
java.lang.StringgetTarget()
voidsetTarget(java.lang.String value)
           Gets or sets the target frame for the shape hyperlink.
java.lang.StringgetTitle()
voidsetTitle(java.lang.String value)
           Gets or sets the title (caption) of the current shape object.
doublegetTop()
voidsetTop(double value)
           Gets or sets the position of the top edge of the containing block of the shape.
intgetVerticalAlignment()
voidsetVerticalAlignment(int value)
           Specifies how the shape is positioned vertically. The value of the property is VerticalAlignment integer constant.
doublegetWidth()
voidsetWidth(double value)
           Gets or sets the width of the containing block of the shape.
intgetWrapSide()
voidsetWrapSide(int value)
           Specifies how the text is wrapped around the shape. The value of the property is WrapSide integer constant.
intgetWrapType()
voidsetWrapType(int value)
           Defines whether the shape is inline or floating. For floating shapes defines the wrapping mode for text around the shape. The value of the property is WrapType integer constant.
intgetZOrder()
voidsetZOrder(int value)
           Determines the display order of overlapping shapes.
 
Method Summary
abstract booleanaccept(DocumentVisitor visitor)→ inherited from Node
           Accepts a visitor.
NodeappendChild(Node newChild)→ inherited from CompositeNode
           Adds the specified node to the end of the list of child nodes for this node.
voidclearRunAttrs()
          Reserved for internal use.
NodedeepClone(boolean isCloneChildren)→ inherited from Node
           Creates a duplicate of the node.
java.lang.ObjectfetchInheritedRunAttr(int fontAttr)
          Reserved for internal use.
java.lang.ObjectfetchInheritedShapeAttr(int key)
          Reserved for internal use.
java.lang.ObjectfetchShapeAttr(int key)
          Reserved for internal use.
CompositeNodegetAncestor(int ancestorType)→ inherited from Node
           Gets the first ancestor of the specified NodeType.
CompositeNodegetAncestor(java.lang.Class ancestorType)→ inherited from Node
           Gets the first ancestor of the specified object type.
NodegetChild(int nodeType, int index, boolean isDeep)→ inherited from CompositeNode
           Returns an Nth child node that matches the specified type.
NodeCollectiongetChildNodes(int nodeType, boolean isDeep)→ inherited from CompositeNode
           Returns a live collection of child nodes that match the specified type.
CompositeNodegetContainer()→ inherited from CompositeNode
          Reserved for internal use.
aspose.obfuscated.typegetDeleteRevision()
          Reserved for internal use.
java.lang.ObjectgetDirectRunAttr(int fontAttr)
          Reserved for internal use.
intgetDirectRunAttrsCount()
          Reserved for internal use.
java.lang.ObjectgetDirectShapeAttr(int key)
          Reserved for internal use.
DocumentBasegetDocument_IInline()
          Reserved for internal use.
aspose.obfuscated.typegetExpandedRunPr_IInline(aspose.obfuscated.type flags)
          Reserved for internal use.
aspose.obfuscated.typegetInsertRevision()
          Reserved for internal use.
aspose.obfuscated.typegetMoveFromRevision()
          Reserved for internal use.
aspose.obfuscated.typegetMoveToRevision()
          Reserved for internal use.
NodegetNextMatchingNode(aspose.obfuscated.type curNode)→ inherited from CompositeNode
          Reserved for internal use.
ParagraphgetParentParagraph_IInline()
          Reserved for internal use.
aspose.obfuscated.typegetRunPr_IInline()
          Reserved for internal use.
Aspose.Words.Rendering.ShapeRenderergetShapeRenderer()
           Creates and returns an object that can be used to render this shape into an image.
java.awt.geom.Point2D.FloatgetSizeInPoints()
           Gets the size of the shape in points.
java.lang.StringgetText()→ inherited from CompositeNode
           Gets the text of this node and of all its children.
intgetZOrder_IShape()
          Reserved for internal use.
intindexOf(Node child)→ inherited from CompositeNode
           Returns the index of the specified child node in the child node array.
NodeinsertAfter(Node newChild, Node refChild)→ inherited from CompositeNode
           Inserts the specified node immediately after the specified reference node.
NodeinsertBefore(Node newChild, Node refChild)→ inherited from CompositeNode
           Inserts the specified node immediately before the specified reference node.
java.util.Iteratoriterator()→ inherited from CompositeNode
           Provides support for the for each style iteration over the child nodes of this node.
NodenextPreOrder(Node rootNode)→ inherited from Node
           Gets next node according to the pre-order tree traversal algorithm.
NodeprependChild(Node newChild)→ inherited from CompositeNode
           Adds the specified node to the beginning of the list of child nodes for this node.
NodepreviousPreOrder(Node rootNode)→ inherited from Node
           Gets the previous node according to the pre-order tree traversal algorithm.
voidremove()→ inherited from Node
           Removes itself from the parent.
voidremoveAllChildren()→ inherited from CompositeNode
           Removes all the child nodes of the current node.
NoderemoveChild(Node oldChild)→ inherited from CompositeNode
           Removes the specified child node.
voidremoveRunAttr(int key)
          Reserved for internal use.
voidremoveShapeAttr(int key)
          Reserved for internal use.
voidremoveSmartTags()→ inherited from CompositeNode
           Removes all Aspose.Words.Markup.SmartTag descendant nodes of the current node.
NodeListselectNodes(java.lang.String xpath)→ inherited from CompositeNode
           Selects a list of nodes matching the XPath expression.
NodeselectSingleNode(java.lang.String xpath)→ inherited from CompositeNode
           Selects the first Node that matches the XPath expression.
voidsetDeleteRevision(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetInsertRevision(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetMoveFromRevision(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetMoveToRevision(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetRunAttr(int fontAttr, java.lang.Object value)
          Reserved for internal use.
voidsetRunPr_IInline(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetShapeAttr(int key, java.lang.Object value)
          Reserved for internal use.
voidsetZOrder_IShape(int value)
          Reserved for internal use.
java.lang.StringtoString(int saveFormat)→ inherited from Node
           Exports the content of the node into a string in the specified format.
java.lang.StringtoTxt()→ inherited from Node
           Exports the content of the node into a string in plain text format.
 

Property Getters/Setters Detail

getAllowOverlap/setAllowOverlap

public boolean getAllowOverlap() / public void setAllowOverlap(boolean value)
Gets or 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.


getAlternativeText/setAlternativeText

public java.lang.String getAlternativeText() / public void setAlternativeText(java.lang.String value)
Defines alternative text to be displayed instead of a graphic.

The default value is an empty string.


getAnchorLocked/setAnchorLocked

public boolean getAnchorLocked() / 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.


getAspectRatioLocked/setAspectRatioLocked

public boolean getAspectRatioLocked() / public void setAspectRatioLocked(boolean value)
Specifies whether the shape's aspect ratio is locked.

The default value depends on the ShapeType, for the ShapeType.Image it is true but for the other shape types it is false.

Has effect for top level shapes only.


getBehindText/setBehindText

public boolean getBehindText() / 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.

See Also:
ZOrder

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.


getBounds

public java.awt.geom.Rectangle2D.Float getBounds()
Gets or 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.


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.

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.

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.


getChildNodes

→ inherited from CompositeNode
public NodeCollection getChildNodes()
Gets all immediate child nodes of this node.

Note, ChildNodes is equivalent to calling GetChildNodes(NodeType.Any, false) and creates and returns a new collection every time it is accessed.

If there are no child nodes, this property returns an empty collection.


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).


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).


getCount

→ inherited from CompositeNode
public int getCount()
Gets the number of immediate children of this node.

getDistanceBottom/setDistanceBottom

public double getDistanceBottom() / public void setDistanceBottom(double value)
Returns or 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.


getDistanceLeft/setDistanceLeft

public double getDistanceLeft() / public void setDistanceLeft(double value)
Returns or 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.


getDistanceRight/setDistanceRight

public double getDistanceRight() / public void setDistanceRight(double value)
Returns or 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.


getDistanceTop/setDistanceTop

public double getDistanceTop() / public void setDistanceTop(double value)
Returns or 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.


getDocument

→ inherited from Node
public DocumentBase getDocument()
Gets the document to which this node belongs.

The node always belongs to a document even if it has just been created and not yet added to the tree, or if it has been removed from the tree.


getFirstChild

→ inherited from CompositeNode
public Node getFirstChild()
Gets the first child of the node. If there is no first child node, a null is returned.

getFlipOrientation/setFlipOrientation

public int getFlipOrientation() / public void setFlipOrientation(int value)
Switches the orientation of a shape. The value of the property is FlipOrientation integer constant.

The default value is FlipOrientation.NONE.


getFont

public Font getFont()
Provides access to the font formatting of this object.

hasChildNodes

→ inherited from CompositeNode
public boolean hasChildNodes()
Returns true if this node has any child nodes.

getHeight/setHeight

public double getHeight() / public void setHeight(double value)
Gets or 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.


getHorizontalAlignment/setHorizontalAlignment

public int getHorizontalAlignment() / public void setHorizontalAlignment(int value)
Specifies how the shape is positioned horizontally. The value of the property is HorizontalAlignment integer constant.

The default value is HorizontalAlignment.NONE.

Has effect only for top level floating shapes.


getHRef/setHRef

public java.lang.String getHRef() / public void setHRef(java.lang.String value)
Gets or 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: http://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: http://www.aspose.com/Products/Default.aspx#Suites

Bookmark within this document: #BookmakName.


isComposite

→ inherited from CompositeNode
public boolean isComposite()
Returns true as this node can have child nodes.

isDeleteRevision

public boolean isDeleteRevision()
Returns true if this object was deleted in Microsoft Word while change tracking was enabled.

isGroup

public boolean isGroup()
Returns true if this is a group shape.

isHorizontalRule

public boolean isHorizontalRule()
Returns true if this shape is a horizontal rule.

isImage

public boolean isImage()
Returns true if this shape is an image shape.

isInline

public boolean isInline()
A quick way to determine if this shape is positioned inline with text.

Has effect only for top level shapes.


isInsertRevision

public boolean isInsertRevision()
Returns true if this object was inserted in Microsoft Word while change tracking was enabled.

isSignatureLine

public boolean isSignatureLine()
Indicates that shape is a SignatureLine.

isTopLevel

public boolean isTopLevel()
Returns true if this shape is not a child of a group shape.

isWordArt

public boolean isWordArt()
Returns true if this shape is a WordArt object.

getLastChild

→ inherited from CompositeNode
public Node getLastChild()
Gets the last child of the node. If there is no last child node, a null is returned.

getLeft/setLeft

public double getLeft() / public void setLeft(double value)
Gets or 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.


getMarkupLanguage

public byte getMarkupLanguage()
Gets MarkupLanguage used for this graphic object. The value of the property is ShapeMarkupLanguage integer constant.

getName/setName

public java.lang.String getName() / public void setName(java.lang.String value)
Gets or sets the optional shape name.

Default is empty string.

Cannot be null, but can be an empty string.


getNextSibling

→ inherited from Node
public Node getNextSibling()
Gets the node immediately following this node. If there is no next node, a null is returned.

getNodeType

→ inherited from Node
public abstract int getNodeType()
Gets the type of this node. The value of the property is NodeType integer constant.

getParentNode

→ inherited from Node
public CompositeNode getParentNode()
Gets the immediate parent of this node.

If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is null.


getParentParagraph

public Paragraph getParentParagraph()
Returns the immediate parent paragraph. For child shapes of a group shape always returns null.

getPreviousSibling

→ inherited from Node
public Node getPreviousSibling()
Gets the node immediately preceding this node. If there is no preceding node, a null is returned.

getRange

→ inherited from Node
public Range getRange()
Returns a Range object that represents the portion of a document that is contained in this node.

getRelativeHorizontalPosition/setRelativeHorizontalPosition

public int getRelativeHorizontalPosition() / public void setRelativeHorizontalPosition(int value)
Specifies relative to what the shape is positioned horizontally. The value of the property is RelativeHorizontalPosition integer constant.

The default value is RelativeHorizontalPosition.COLUMN.

Has effect only for top level floating shapes.


getRelativeVerticalPosition/setRelativeVerticalPosition

public int getRelativeVerticalPosition() / public void setRelativeVerticalPosition(int value)
Specifies relative to what the shape is positioned vertically. The value of the property is RelativeVerticalPosition integer constant.

The default value is RelativeVerticalPosition.PARAGRAPH.

Has effect only for top level floating shapes.


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.


getRotation/setRotation

public double getRotation() / 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.


getScreenTip/setScreenTip

public java.lang.String getScreenTip() / 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.


getShapeType

public int getShapeType()
Gets the shape type. The value of the property is ShapeType integer constant.

getSizeInPoints

public java.awt.Dimension getSizeInPoints()
Gets the size of the shape in points.

getTarget/setTarget

public java.lang.String getTarget() / public void setTarget(java.lang.String value)
Gets or sets the target frame for the shape hyperlink.

The default value is an empty string.


getTitle/setTitle

public java.lang.String getTitle() / public void setTitle(java.lang.String value)
Gets or sets the title (caption) of the current shape object.

Default is empty string.

Cannot be null, but can be an empty string.


getTop/setTop

public double getTop() / public void setTop(double value)
Gets or 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.


getVerticalAlignment/setVerticalAlignment

public int getVerticalAlignment() / public void setVerticalAlignment(int value)
Specifies how the shape is positioned vertically. The value of the property is VerticalAlignment integer constant.

The default value is VerticalAlignment.NONE.

Has effect only for top level floating shapes.


getWidth/setWidth

public double getWidth() / public void setWidth(double value)
Gets or 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.


getWrapSide/setWrapSide

public int getWrapSide() / public void setWrapSide(int value)
Specifies how the text is wrapped around the shape. The value of the property is WrapSide integer constant.

The default value is WrapSide.BOTH.

Has effect only for top level shapes.


getWrapType/setWrapType

public int getWrapType() / 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 value of the property is WrapType integer constant.

The default value is WrapType.NONE.

Has effect only for top level shapes.


getZOrder/setZOrder

public int getZOrder() / 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.

See Also:
BehindText

Method Detail

accept

→ inherited from Node
public abstract 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.

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.

appendChild

→ inherited from CompositeNode
public Node appendChild(Node newChild)
Adds the specified node to the end of the list of child nodes for this node.

If the newChild is already in the tree, it is first removed.

If the node being inserted was created from another document, you should use DocumentBase.importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:
newChild - The node to add.
Returns:
The node added.

clearRunAttrs

public void clearRunAttrs()
Reserved for internal use.

deepClone

→ inherited from Node
public Node deepClone(boolean isCloneChildren)
Creates a duplicate of the node.

This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.

This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.

Parameters:
isCloneChildren - True to recursively clone the subtree under the specified node; false to clone only the node itself.
Returns:
The cloned node.

fetchInheritedRunAttr

public java.lang.Object fetchInheritedRunAttr(int fontAttr)
Reserved for internal use.

fetchInheritedShapeAttr

public java.lang.Object fetchInheritedShapeAttr(int key)
Reserved for internal use.

fetchShapeAttr

public java.lang.Object fetchShapeAttr(int key)
Reserved for internal use.

getAncestor

→ inherited from Node
public CompositeNode getAncestor(int ancestorType)
Gets the first ancestor of the specified NodeType.
Parameters:
ancestorType - A NodeType value. The node type of the ancestor to retrieve.
Returns:
The ancestor of the specified type or null if no ancestor of this type was found.

getAncestor

→ inherited from Node
public CompositeNode getAncestor(java.lang.Class ancestorType)
Gets the first ancestor of the specified object type.

The ancestor type matches if it is equal to ancestorType or derived from ancestorType.

Parameters:
ancestorType - The object type of the ancestor to retrieve.
Returns:
The ancestor of the specified type or null if no ancestor of this type was found.

getChild

→ inherited from CompositeNode
public Node getChild(int nodeType, int index, boolean isDeep)
Returns an Nth child node that matches the specified type.

If index is out of range, a null is returned.

Note that markup nodes (NodeType.STRUCTURED_DOCUMENT_TAG and NodeType.SMART_TAG) are traversed even when isDeep = false and GetChild is invoked for non-markup node type. For example if the first run in a para is wrapped in a StructuredDocumentTag, it will still be returned by GetChild(NodeType.Run, 0, false).
Parameters:
nodeType - A NodeType value. Specifies the type of the child node.
index - Zero based index of the child node to select. Negative indexes are also allowed and indicate access from the end, that is -1 means the last node.
isDeep - True to select from all child nodes recursively. False to select only among immediate children. See remarks for more info.
Returns:
The child node that matches the criteria or null if no matching node is found.

getChildNodes

→ inherited from CompositeNode
public NodeCollection getChildNodes(int nodeType, boolean isDeep)
Returns a live collection of child nodes that match the specified type.

The collection of nodes returned by this method is always live.

A live collection is always in sync with the document. For example, if you selected all sections in a document and enumerate through the collection deleting the sections, the section is removed from the collection immediately when it is removed from the document.

Parameters:
nodeType - A NodeType value. Specifies the type of nodes to select.
isDeep - True to select from all child nodes recursively. False to select only among immediate children.
Returns:
A live collection of child nodes of the specified type.

getContainer

→ inherited from CompositeNode
public CompositeNode getContainer()
Reserved for internal use.

getDeleteRevision

public aspose.obfuscated.type getDeleteRevision()
Reserved for internal use.

getDirectRunAttr

public java.lang.Object getDirectRunAttr(int fontAttr)
Reserved for internal use.

getDirectRunAttrsCount

public int getDirectRunAttrsCount()
Reserved for internal use.

getDirectShapeAttr

public java.lang.Object getDirectShapeAttr(int key)
Reserved for internal use.

getDocument_IInline

public DocumentBase getDocument_IInline()
Reserved for internal use.

getExpandedRunPr_IInline

public aspose.obfuscated.type getExpandedRunPr_IInline(aspose.obfuscated.type flags)
Reserved for internal use.

getInsertRevision

public aspose.obfuscated.type getInsertRevision()
Reserved for internal use.

getMoveFromRevision

public aspose.obfuscated.type getMoveFromRevision()
Reserved for internal use.

getMoveToRevision

public aspose.obfuscated.type getMoveToRevision()
Reserved for internal use.

getNextMatchingNode

→ inherited from CompositeNode
public Node getNextMatchingNode(aspose.obfuscated.type curNode)
Reserved for internal use.

getParentParagraph_IInline

public Paragraph getParentParagraph_IInline()
Reserved for internal use.

getRunPr_IInline

public aspose.obfuscated.type getRunPr_IInline()
Reserved for internal use.

getShapeRenderer

public Aspose.Words.Rendering.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 Aspose.Words.Rendering.ShapeRenderer constructor and passes this object as a parameter.

Returns:
The renderer object for this shape.

getSizeInPoints

public java.awt.geom.Point2D.Float getSizeInPoints()
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.


getText

→ inherited from CompositeNode
public java.lang.String getText()
Gets the text of this node and of all its children.

The returned string includes all control and special characters as described in ControlChar.


getZOrder_IShape

public int getZOrder_IShape()
Reserved for internal use.

indexOf

→ inherited from CompositeNode
public int indexOf(Node child)
Returns the index of the specified child node in the child node array. Returns -1 if the node is not found in the child nodes.

insertAfter

→ inherited from CompositeNode
public Node insertAfter(Node newChild, Node refChild)
Inserts the specified node immediately after the specified reference node.

If refChild is null, inserts newChild at the beginning of the list of child nodes.

If the newChild is already in the tree, it is first removed.

If the node being inserted was created from another document, you should use DocumentBase.importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:
newChild - The Node to insert.
refChild - The Node that is the reference node. The newNode is placed after the refNode.
Returns:
The inserted node.

insertBefore

→ inherited from CompositeNode
public Node insertBefore(Node newChild, Node refChild)
Inserts the specified node immediately before the specified reference node.

If refChild is null, inserts newChild at the end of the list of child nodes.

If the newChild is already in the tree, it is first removed.

If the node being inserted was created from another document, you should use DocumentBase.importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:
newChild - The Node to insert.
refChild - The Node that is the reference node. The newChild is placed before this node.
Returns:
The inserted node.

iterator

→ inherited from CompositeNode
public java.util.Iterator iterator()
Provides support for the for each style iteration over the child nodes of this node.

nextPreOrder

→ inherited from Node
public Node nextPreOrder(Node rootNode)
Gets next node according to the pre-order tree traversal algorithm.
Parameters:
rootNode - The top node (limit) of traversal.
Returns:
Next node in pre-order order. Null if reached the rootNode.

prependChild

→ inherited from CompositeNode
public Node prependChild(Node newChild)
Adds the specified node to the beginning of the list of child nodes for this node.

If the newChild is already in the tree, it is first removed.

If the node being inserted was created from another document, you should use DocumentBase.importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:
newChild - The node to add.
Returns:
The node added.

previousPreOrder

→ inherited from Node
public Node previousPreOrder(Node rootNode)
Gets the previous node according to the pre-order tree traversal algorithm.
Parameters:
rootNode - The top node (limit) of traversal.
Returns:
Previous node in pre-order order. Null if reached the rootNode.

remove

→ inherited from Node
public void remove()
Removes itself from the parent.

removeAllChildren

→ inherited from CompositeNode
public void removeAllChildren()
Removes all the child nodes of the current node.

removeChild

→ inherited from CompositeNode
public Node removeChild(Node oldChild)
Removes the specified child node.

The parent of oldChild is set to null after the node is removed.

Parameters:
oldChild - The node to remove.
Returns:
The removed node.

removeRunAttr

public void removeRunAttr(int key)
Reserved for internal use.

removeShapeAttr

public void removeShapeAttr(int key)
Reserved for internal use.

removeSmartTags

→ inherited from CompositeNode
public void removeSmartTags()
Removes all Aspose.Words.Markup.SmartTag descendant nodes of the current node. This method does not remove the content of the smart tags.

selectNodes

→ inherited from CompositeNode
public NodeList selectNodes(java.lang.String xpath)
Selects a list of nodes matching the XPath expression.

Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.

Parameters:
xpath - The XPath expression.
Returns:
A list of nodes matching the XPath query.

selectSingleNode

→ inherited from CompositeNode
public Node selectSingleNode(java.lang.String xpath)
Selects the first Node that matches the XPath expression.

Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.

Parameters:
xpath - The XPath expression.
Returns:
The first Node that matches the XPath query or null if no matching node is found.

setDeleteRevision

public void setDeleteRevision(aspose.obfuscated.type value)
Reserved for internal use.

setInsertRevision

public void setInsertRevision(aspose.obfuscated.type value)
Reserved for internal use.

setMoveFromRevision

public void setMoveFromRevision(aspose.obfuscated.type value)
Reserved for internal use.

setMoveToRevision

public void setMoveToRevision(aspose.obfuscated.type value)
Reserved for internal use.

setRunAttr

public void setRunAttr(int fontAttr, java.lang.Object value)
Reserved for internal use.

setRunPr_IInline

public void setRunPr_IInline(aspose.obfuscated.type value)
Reserved for internal use.

setShapeAttr

public void setShapeAttr(int key, java.lang.Object value)
Reserved for internal use.

setZOrder_IShape

public void setZOrder_IShape(int value)
Reserved for internal use.

toString

→ inherited from Node
public java.lang.String toString(int saveFormat)
               throws java.lang.Exception
Exports the content of the node into a string in the specified format.
Returns:
The content of the node in the specified format.
Parameters:
saveFormat - A SaveFormat value.

toTxt

→ inherited from Node
public java.lang.String toTxt()
            throws java.lang.Exception
Exports the content of the node into a string in plain text format.

This method removes field codes and Microsoft Word control characters, uses CrLf (or any other) combination of characters to mark ends of paragraphs in the resulting string. It produces a different result from getText() which just gets the text from the node without removing field codes or special characters.

Returns:
The content of the node in plain text format.
See Also:
#Error Cref: P:Aspose.Words.Saving.TxtSaveOptions.ParagraphBreak, #Error Cref: P:Aspose.Words.Saving.TxtSaveOptions.ExportHeadersFooters

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.