ASPOSE home

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
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.
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()
voidsetBounds(java.awt.geom.Rectangle2D.Float value)
           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.
booleancanHaveImage()
           Returns true if the shape type allows the shape to have an image. Image shapes and ole objects can have an image.
NodeCollectiongetChildNodes()→ inherited from CompositeNode
           Gets all immediate child nodes of this node.
java.awt.PointgetCoordOrigin()
voidsetCoordOrigin(java.awt.Point value)
           The coordinates at the top-left corner of the containing block of this shape.
java.awt.DimensiongetCoordSize()
voidsetCoordSize(java.awt.Dimension value)
           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.
DocumentgetDocument()→ 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.
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 deleted in Microsoft Word while change tracking was enabled.
booleanisTopLevel()
           Returns true if this is a top-level shape. A top-level shape is an immediate child of a paragraph.
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.
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 horizontally. 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.
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.
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 height 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)
           Creates a duplicate of the node.
java.lang.ObjectfetchInheritedRunAttr(int fontAttr)
          Reserved for internal use.
NodegetAncestor(java.lang.Class ancestorType)→ inherited from Node
           Gets the first ancestor of the specified 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.
NodeCollectiongetChildNodes(int nodeType, boolean isDeep, boolean isLive)→ inherited from CompositeNode
           Returns a "live" or "snapshot" collection of child node that match the specified type.
java.lang.ObjectgetDirectRunAttr(int fontAttr)
          Reserved for internal use.
DocumentgetDocument()
          Reserved for internal use.
ParagraphgetParentParagraph()
          Reserved for internal use.
Aspose.Words.RunPrgetRunPr()
          Reserved for internal use.
java.lang.StringgetText()→ inherited from CompositeNode
           Gets the text of this node and of all its children.
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.
java.awt.geom.Point2D.FloatlocalToParent(java.awt.geom.Point2D.Float value)
           Converts a value from the local coordinate space into the coordinate space of the parent shape.
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.
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.
voidsetId(int id)
          Reserved for internal use.
voidsetRunAttr(int fontAttr, java.lang.Object value)
          Reserved for internal use.
java.lang.StringtoTxt()→ inherited from Node
           Exports the content of the node into a string in TXT (plain text) format.
 

Property Getters/Setters Detail

getShapeType

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

isGroup

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

isImage

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

isHorizontalRule

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

isWordArt

public boolean isWordArt()
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. Image shapes and ole objects can have an image.

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.


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.


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.


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.


getWidth/setWidth

public double getWidth()

public void setWidth(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 100.


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


getBounds/setBounds

public java.awt.geom.Rectangle2D.Float getBounds()

public void setBounds(java.awt.geom.Rectangle2D.Float value)
Gets or sets the location and size 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.


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.

getSizeInPoints

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

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.


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 horizontally. The value of the property is RelativeVerticalPosition integer constant.

The default value is RelativeVerticalPosition.PARAGRAPH.

Has effect only for top level floating shapes.


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.


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.


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.


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.


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.


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

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.


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.


isInline

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

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.

See Also:
BehindText

getRotation/setRotation

public double getRotation()

public void setRotation(double value)
Defines the angle (in degrees) that a shape is rotated.

The default value is 0.


getCoordOrigin/setCoordOrigin

public java.awt.Point getCoordOrigin()

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


getCoordSize/setCoordSize

public java.awt.Dimension getCoordSize()

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


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.


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 file name: ..\\My Documents\\SalesReport.doc.

Bookmark within another document: http://www.aspose.com/Products/Default.aspx#Suites

Bookmark within this document: #BookmakName.


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.


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.


isTopLevel

public boolean isTopLevel()
Returns true if this is a top-level shape. A top-level shape is an immediate child of a paragraph.

getParentParagraph

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

isInsertRevision

public boolean isInsertRevision()
Returns true if this object was deleted 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.

isComposite

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

hasChildNodes

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

getChildNodes

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

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

ChildNodes is equivalent to calling GetChildNodes(NodeType.Any, false).


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.

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.

getCount

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

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.


getDocument

→ inherited from Node
public Document 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 yed added to the tree, or if it has been removed from the tree.


getPreviousSibling

→ inherited from Node
public Node getPreviousSibling()
Gets the node immediately preceding this node.

If there is no preceding node, a null is returned.

Note: Calculating the value of this property iterates from the first child node of ParenNode to this node.

getNextSibling

→ inherited from Node
public Node getNextSibling()
Gets the node immediately following this node. If there is no next 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.

Method Detail

iterator

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

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.


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.

deepClone

public Node deepClone(boolean isCloneChildren)
              throws java.lang.Exception
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.

localToParent

public java.awt.geom.Point2D.Float localToParent(java.awt.geom.Point2D.Float value)
                   throws java.lang.Exception
Converts a value from the local coordinate space into the coordinate space of the parent shape.

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.

getChildNodes

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

Snapshot collections require less resources than live collections because a snapshot collection of nodes is not updated when the document is changed.

Snapshot collections are useful for tasks, that do not require immediate update of the collection when the document is changed. For example, select all shapes and delete them is more efficient using a snapshot collection.

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.
isLive - True to return a live collection; false to return a snapshot collection.
Returns:
A collection of child nodes of the specified type.

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.

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.
Returns:
The child node that matches the criteria or null if no matching node is found.

selectNodes

→ inherited from CompositeNode
public NodeList selectNodes(java.lang.String xpath)
                    throws org.jaxen.JaxenException
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)
                     throws org.jaxen.JaxenException
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.

appendChild

→ inherited from CompositeNode
public Node appendChild(Node newChild)
                throws java.lang.Exception
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 Document.importNode(com.aspose.words.Node, boolean) 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.

prependChild

→ inherited from CompositeNode
public Node prependChild(Node newChild)
                 throws java.lang.Exception
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 Document.importNode(com.aspose.words.Node, boolean) 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.

insertAfter

→ inherited from CompositeNode
public Node insertAfter(Node newChild, Node refChild)
                throws java.lang.Exception
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 Document.importNode(com.aspose.words.Node, boolean) 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)
                 throws java.lang.Exception
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.

Note: InsertBefore could be slower than InsertAfter because it needs to iterate over all nodes from the first child to the reference 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 Document.importNode(com.aspose.words.Node, boolean) 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.

removeChild

→ inherited from CompositeNode
public Node removeChild(Node oldChild)
                throws java.lang.Exception
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.

removeAllChildren

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

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.

getAncestor

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

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

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

remove

→ inherited from Node
public void remove()
           throws java.lang.Exception
Removes itself from the parent.

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.

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.

toTxt

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

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

Returns:
The content of the node in plain text format.

getDocument

public Document getDocument()
Reserved for internal use.

getParentParagraph

public Paragraph getParentParagraph()
Reserved for internal use.

getRunPr

public Aspose.Words.RunPr getRunPr()
Reserved for internal use.

clearRunAttrs

public void clearRunAttrs()
Reserved for internal use.

setRunAttr

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

fetchInheritedRunAttr

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

getDirectRunAttr

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

setId

public void setId(int id)
Reserved for internal use.

See Also:
          Wiki - the home page for the Aspose.Words Product Documentation that includes Programmer's Guide, Knowledge Base and other articles.
          Aspose.Words Support Forum - our preferred method of support.
          Aspose.Words Team - contact Aspose.Words Team.


ASPOSE home