|
ASPOSE home |
java.lang.ObjectNode
CompositeNode
com.aspose.words.ShapeBase
public abstract class ShapeBase
This is an abstract class. The two derived classes that you can instantiate
are A shape is a node in the document tree. If the shape is a child of a A shape can also occur as a child of a A shape can be positioned inline with text or floating. The positioning method is controlled
using the 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
A floating shape be positioned explicitly using the
Property Getters/Setters Summary | ||
---|---|---|
java.lang.String | getAlternativeText() | |
void | setAlternativeText(java.lang.String value) | |
Defines alternative text to be displayed instead of a graphic. | ||
boolean | getAnchorLocked() | |
void | setAnchorLocked(boolean value) | |
Specifies whether the shape's anchor is locked. | ||
boolean | getBehindText() | |
void | setBehindText(boolean value) | |
Specifies whether the shape is below or above text. | ||
double | getBottom() | |
Gets the position of the bottom edge of the containing block of the shape. | ||
java.awt.geom.Rectangle2D.Float | getBounds() | |
void | setBounds(java.awt.geom.Rectangle2D.Float value) | |
Gets or sets the location and size of the containing block of the shape. | ||
java.awt.geom.Rectangle2D.Float | getBoundsInPoints() | |
Gets the location and size of the containing block of the shape in points, relative to the anchor of the topmost shape. | ||
boolean | canHaveImage() | |
Returns true if the shape type allows the shape to have an image. Image shapes and ole objects can have an image. | ||
NodeCollection | getChildNodes() | → inherited from CompositeNode |
Gets all immediate child nodes of this node. | ||
java.awt.Point | getCoordOrigin() | |
void | setCoordOrigin(java.awt.Point value) | |
The coordinates at the top-left corner of the containing block of this shape. | ||
java.awt.Dimension | getCoordSize() | |
void | setCoordSize(java.awt.Dimension value) | |
The width and height of the coordinate space inside the containing block of this shape. | ||
int | getCount() | → inherited from CompositeNode |
Gets the number of immediate children of this node. | ||
double | getDistanceBottom() | |
void | setDistanceBottom(double value) | |
Returns or sets the distance (in points) between the document text and the bottom edge of the shape. | ||
double | getDistanceLeft() | |
void | setDistanceLeft(double value) | |
Returns or sets the distance (in points) between the document text and the left edge of the shape. | ||
double | getDistanceRight() | |
void | setDistanceRight(double value) | |
Returns or sets the distance (in points) between the document text and the right edge of the shape. | ||
double | getDistanceTop() | |
void | setDistanceTop(double value) | |
Returns or sets the distance (in points) between the document text and the top edge of the shape. | ||
Document | getDocument() | → inherited from Node |
Gets the document to which this node belongs. | ||
Node | getFirstChild() | → inherited from CompositeNode |
Gets the first child of the node. | ||
int | getFlipOrientation() | |
void | setFlipOrientation(int value) | |
Switches the orientation of a shape. The value of the property is FlipOrientation integer constant. | ||
boolean | hasChildNodes() | → inherited from CompositeNode |
Returns true if this node has any child nodes. | ||
double | getHeight() | |
void | setHeight(double value) | |
Gets or sets the height of the containing block of the shape. | ||
int | getHorizontalAlignment() | |
void | setHorizontalAlignment(int value) | |
Specifies how the shape is positioned horizontally. The value of the property is HorizontalAlignment integer constant. | ||
java.lang.String | getHRef() | |
void | setHRef(java.lang.String value) | |
Gets or sets the full hyperlink address for a shape. | ||
boolean | isComposite() | → inherited from CompositeNode |
Returns true as this node can have child nodes. | ||
boolean | isDeleteRevision() | |
Returns true if this object was deleted in Microsoft Word while change tracking was enabled. | ||
boolean | isGroup() | |
Returns true if this is a group shape. | ||
boolean | isHorizontalRule() | |
Returns true if this shape is a horizontal rule. | ||
boolean | isImage() | |
Returns true if this shape is an image shape. | ||
boolean | isInline() | |
A quick way to determine if this shape is positioned inline with text. | ||
boolean | isInsertRevision() | |
Returns true if this object was deleted in Microsoft Word while change tracking was enabled. | ||
boolean | isTopLevel() | |
Returns true if this is a top-level shape. A top-level shape is an immediate child of a paragraph. | ||
boolean | isWordArt() | |
Returns true if this shape is a WordArt object. | ||
Node | getLastChild() | → inherited from CompositeNode |
Gets the last child of the node. | ||
double | getLeft() | |
void | setLeft(double value) | |
Gets or sets the position of the left edge of the containing block of the shape. | ||
Node | getNextSibling() | → inherited from Node |
Gets the node immediately following this node. | ||
abstract int | getNodeType() | → inherited from Node |
Gets the type of this node. The value of the property is NodeType integer constant. | ||
CompositeNode | getParentNode() | → inherited from Node |
Gets the immediate parent of this node. | ||
Paragraph | getParentParagraph() | |
Returns the immediate parent paragraph. | ||
Node | getPreviousSibling() | → inherited from Node |
Gets the node immediately preceding this node. | ||
Range | getRange() | → inherited from Node |
Returns a Range object that represents the portion of a document that is contained in this node. | ||
int | getRelativeHorizontalPosition() | |
void | setRelativeHorizontalPosition(int value) | |
Specifies relative to what the shape is positioned horizontally. The value of the property is RelativeHorizontalPosition integer constant. | ||
int | getRelativeVerticalPosition() | |
void | setRelativeVerticalPosition(int value) | |
Specifies relative to what the shape is positioned horizontally. The value of the property is RelativeVerticalPosition integer constant. | ||
double | getRight() | |
Gets the position of the right edge of the containing block of the shape. | ||
double | getRotation() | |
void | setRotation(double value) | |
Defines the angle (in degrees) that a shape is rotated. | ||
java.lang.String | getScreenTip() | |
void | setScreenTip(java.lang.String value) | |
Defines the text displayed when the mouse pointer moves over the shape. | ||
int | getShapeType() | |
Gets the shape type. The value of the property is ShapeType integer constant. | ||
java.awt.Dimension | getSizeInPoints() | |
Gets the size of the shape in points. | ||
java.lang.String | getTarget() | |
void | setTarget(java.lang.String value) | |
Gets or sets the target frame for the shape hyperlink. | ||
double | getTop() | |
void | setTop(double value) | |
Gets or sets the position of the top edge of the containing block of the shape. | ||
int | getVerticalAlignment() | |
void | setVerticalAlignment(int value) | |
Specifies how the shape is positioned vertically. The value of the property is VerticalAlignment integer constant. | ||
double | getWidth() | |
void | setWidth(double value) | |
Gets or sets the height of the containing block of the shape. | ||
int | getWrapSide() | |
void | setWrapSide(int value) | |
Specifies how the text is wrapped around the shape. The value of the property is WrapSide integer constant. | ||
int | getWrapType() | |
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. | ||
int | getZOrder() | |
void | setZOrder(int value) | |
Determines the display order of overlapping shapes. |
Method Summary | ||
---|---|---|
abstract boolean | accept(DocumentVisitor visitor) | → inherited from Node |
Accepts a visitor. | ||
Node | appendChild(Node newChild) | → inherited from CompositeNode |
Adds the specified node to the end of the list of child nodes for this node. | ||
void | clearRunAttrs() | |
Reserved for internal use. | ||
Node | deepClone(boolean isCloneChildren) | |
Creates a duplicate of the node. | ||
java.lang.Object | fetchInheritedRunAttr(int fontAttr) | |
Reserved for internal use. | ||
Node | getAncestor(java.lang.Class ancestorType) | → inherited from Node |
Gets the first ancestor of the specified type. | ||
Node | getChild(int nodeType, int index, boolean isDeep) | → inherited from CompositeNode |
Returns an Nth child node that matches the specified type. | ||
NodeCollection | getChildNodes(int nodeType, boolean isDeep) | → inherited from CompositeNode |
Returns a live collection of child nodes that match the specified type. | ||
NodeCollection | getChildNodes(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.Object | getDirectRunAttr(int fontAttr) | |
Reserved for internal use. | ||
Document | getDocument() | |
Reserved for internal use. | ||
Paragraph | getParentParagraph() | |
Reserved for internal use. | ||
Aspose.Words.RunPr | getRunPr() | |
Reserved for internal use. | ||
java.lang.String | getText() | → inherited from CompositeNode |
Gets the text of this node and of all its children. | ||
int | indexOf(Node child) | → inherited from CompositeNode |
Returns the index of the specified child node in the child node array. | ||
Node | insertAfter(Node newChild, Node refChild) | → inherited from CompositeNode |
Inserts the specified node immediately after the specified reference node. | ||
Node | insertBefore(Node newChild, Node refChild) | → inherited from CompositeNode |
Inserts the specified node immediately before the specified reference node. | ||
java.util.Iterator | iterator() | → inherited from CompositeNode |
Provides support for the for each style iteration over the child nodes of this node. | ||
java.awt.geom.Point2D.Float | localToParent(java.awt.geom.Point2D.Float value) | |
Converts a value from the local coordinate space into the coordinate space of the parent shape. | ||
Node | nextPreOrder(Node rootNode) | → inherited from Node |
Gets next node according to the pre-order tree traversal algorithm. | ||
Node | prependChild(Node newChild) | → inherited from CompositeNode |
Adds the specified node to the beginning of the list of child nodes for this node. | ||
Node | previousPreOrder(Node rootNode) | → inherited from Node |
Gets the previous node according to the pre-order tree traversal algorithm. | ||
void | remove() | → inherited from Node |
Removes itself from the parent. | ||
void | removeAllChildren() | → inherited from CompositeNode |
Removes all the child nodes of the current node. | ||
Node | removeChild(Node oldChild) | → inherited from CompositeNode |
Removes the specified child node. | ||
NodeList | selectNodes(java.lang.String xpath) | → inherited from CompositeNode |
Selects a list of nodes matching the XPath expression. | ||
Node | selectSingleNode(java.lang.String xpath) | → inherited from CompositeNode |
Selects the first Node that matches the XPath expression. | ||
void | setId(int id) | |
Reserved for internal use. | ||
void | setRunAttr(int fontAttr, java.lang.Object value) | |
Reserved for internal use. | ||
java.lang.String | toTxt() | → 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() |
isGroup | |
public boolean isGroup() |
isImage | |
public boolean isImage() |
isHorizontalRule | |
public boolean isHorizontalRule() |
isWordArt | |
public boolean isWordArt() |
canHaveImage | |
public boolean canHaveImage() |
getLeft/setLeft | |
public double getLeft() public void setLeft(double value) |
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) |
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() |
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() |
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) |
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) |
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) |
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() |
getSizeInPoints | |
public java.awt.Dimension getSizeInPoints() |
getFlipOrientation/setFlipOrientation | |
public int getFlipOrientation() public void setFlipOrientation(int value) |
The default value is
getRelativeHorizontalPosition/setRelativeHorizontalPosition | |
public int getRelativeHorizontalPosition() public void setRelativeHorizontalPosition(int value) |
The default value is
Has effect only for top level floating shapes.
getRelativeVerticalPosition/setRelativeVerticalPosition | |
public int getRelativeVerticalPosition() public void setRelativeVerticalPosition(int value) |
The default value is
Has effect only for top level floating shapes.
getHorizontalAlignment/setHorizontalAlignment | |
public int getHorizontalAlignment() public void setHorizontalAlignment(int value) |
The default value is
Has effect only for top level floating shapes.
getVerticalAlignment/setVerticalAlignment | |
public int getVerticalAlignment() public void setVerticalAlignment(int value) |
The default value is
Has effect only for top level floating shapes.
getWrapType/setWrapType | |
public int getWrapType() public void setWrapType(int value) |
The default value is
Has effect only for top level shapes.
getWrapSide/setWrapSide | |
public int getWrapSide() public void setWrapSide(int value) |
The default value is
Has effect only for top level shapes.
getAnchorLocked/setAnchorLocked | |
public boolean getAnchorLocked() public void setAnchorLocked(boolean value) |
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) |
Has effect only for top level shapes.
The default value is false.
getDistanceTop/setDistanceTop | |
public double getDistanceTop() public void setDistanceTop(double value) |
The default value is 0.
Has effect only for top level shapes.
getDistanceBottom/setDistanceBottom | |
public double getDistanceBottom() public void setDistanceBottom(double value) |
The default value is 0.
Has effect only for top level shapes.
getDistanceLeft/setDistanceLeft | |
public double getDistanceLeft() public void setDistanceLeft(double value) |
The default value is 1/8 inch.
Has effect only for top level shapes.
getDistanceRight/setDistanceRight | |
public double getDistanceRight() public void setDistanceRight(double value) |
The default value is 1/8 inch.
Has effect only for top level shapes.
isInline | |
public boolean isInline() |
Has effect only for top level shapes.
getZOrder/setZOrder | |
public int getZOrder() public void setZOrder(int value) |
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.
getRotation/setRotation | |
public double getRotation() public void setRotation(double value) |
The default value is 0.
getCoordOrigin/setCoordOrigin | |
public java.awt.Point getCoordOrigin() public void setCoordOrigin(java.awt.Point value) |
The default value is (0,0).
getCoordSize/setCoordSize | |
public java.awt.Dimension getCoordSize() public void setCoordSize(java.awt.Dimension value) |
The default value is (1000, 1000).
getScreenTip/setScreenTip | |
public java.lang.String getScreenTip() public void setScreenTip(java.lang.String value) |
The default value is an empty string.
getHRef/setHRef | |
public java.lang.String getHRef() public void setHRef(java.lang.String value) |
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) |
The default value is an empty string.
getAlternativeText/setAlternativeText | |
public java.lang.String getAlternativeText() public void setAlternativeText(java.lang.String value) |
The default value is an empty string.
isTopLevel | |
public boolean isTopLevel() |
getParentParagraph | |
public Paragraph getParentParagraph() |
isInsertRevision | |
public boolean isInsertRevision() |
isDeleteRevision | |
public boolean isDeleteRevision() |
isComposite | → inherited from CompositeNode |
public boolean isComposite() |
hasChildNodes | → inherited from CompositeNode |
public boolean hasChildNodes() |
getChildNodes | → inherited from CompositeNode |
public NodeCollection getChildNodes() |
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() |
getLastChild | → inherited from CompositeNode |
public Node getLastChild() |
getCount | → inherited from CompositeNode |
public int getCount() |
getNodeType | → inherited from Node |
public abstract int getNodeType() |
getParentNode | → inherited from Node |
public CompositeNode getParentNode() |
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() |
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() |
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() |
getRange | → inherited from Node |
public Range getRange() |
Method Detail |
---|
iterator | → inherited from CompositeNode |
public java.util.Iterator iterator() |
getText | → inherited from CompositeNode |
public java.lang.String getText() |
The returned string includes all control and special characters as described in
accept | → inherited from Node |
public abstract boolean accept(DocumentVisitor visitor) throws java.lang.Exception |
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.
visitor
- The visitor that will visit the nodes.deepClone | |
public Node deepClone(boolean isCloneChildren) throws java.lang.Exception |
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.
isCloneChildren
- True to recursively clone the subtree under the specified node;
false to clone only the node itself.localToParent | |
public java.awt.geom.Point2D.Float localToParent(java.awt.geom.Point2D.Float value) throws java.lang.Exception |
getChildNodes | → inherited from CompositeNode |
public NodeCollection getChildNodes(int nodeType, boolean isDeep) |
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.
nodeType
- A isDeep
- True to select from all child nodes recursively.
False to select only among immediate children. getChildNodes | → inherited from CompositeNode |
public NodeCollection getChildNodes(int nodeType, boolean isDeep, boolean isLive) |
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.
nodeType
- A 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.getChild | → inherited from CompositeNode |
public Node getChild(int nodeType, int index, boolean isDeep) |
If index is out of range, a null is returned.
nodeType
- A 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. selectNodes | → inherited from CompositeNode |
public NodeList selectNodes(java.lang.String xpath) throws org.jaxen.JaxenException |
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.selectSingleNode | → inherited from CompositeNode |
public Node selectSingleNode(java.lang.String xpath) throws org.jaxen.JaxenException |
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.appendChild | → inherited from CompositeNode |
public Node appendChild(Node newChild) throws java.lang.Exception |
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
newChild
- The node to add.prependChild | → inherited from CompositeNode |
public Node prependChild(Node newChild) throws java.lang.Exception |
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
newChild
- The node to add.insertAfter | → inherited from CompositeNode |
public Node insertAfter(Node newChild, Node refChild) throws java.lang.Exception |
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
newChild
- The Node to insert.refChild
- The Node that is the reference node. The newNode is placed after the refNode. insertBefore | → inherited from CompositeNode |
public Node insertBefore(Node newChild, Node refChild) throws java.lang.Exception |
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
newChild
- The Node to insert.refChild
- The Node that is the reference node. The newChild is placed before this node.removeChild | → inherited from CompositeNode |
public Node removeChild(Node oldChild) throws java.lang.Exception |
The parent of oldChild is set to null after the node is removed.
oldChild
- The node to remove.removeAllChildren | → inherited from CompositeNode |
public void removeAllChildren() throws java.lang.Exception |
indexOf | → inherited from CompositeNode |
public int indexOf(Node child) |
getAncestor | → inherited from Node |
public Node getAncestor(java.lang.Class ancestorType) |
The ancestor type matches if it is equal to ancestorType or derived from ancestorType.
ancestorType
- The type of the ancestor to retrieve.remove | → inherited from Node |
public void remove() throws java.lang.Exception |
nextPreOrder | → inherited from Node |
public Node nextPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.previousPreOrder | → inherited from Node |
public Node previousPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.toTxt | → inherited from Node |
public java.lang.String toTxt() throws java.lang.Exception |
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
getDocument | |
public Document getDocument() |
getParentParagraph | |
public Paragraph getParentParagraph() |
getRunPr | |
public Aspose.Words.RunPr getRunPr() |
clearRunAttrs | |
public void clearRunAttrs() |
setRunAttr | |
public void setRunAttr(int fontAttr, java.lang.Object value) |
fetchInheritedRunAttr | |
public java.lang.Object fetchInheritedRunAttr(int fontAttr) throws java.lang.Exception |
getDirectRunAttr | |
public java.lang.Object getDirectRunAttr(int fontAttr) |
setId | |
public void setId(int id) |
|
ASPOSE home |