java.lang.ObjectNode
CompositeNode
ShapeBase
com.aspose.words.Shape
public class Shape
Using the An important property of a shape is its Shapes that can have text, can contain
Constructor Summary |
---|
Shape(DocumentBase doc, int shapeType)
Creates a new shape object. |
Property Getters/Setters Summary | ||
---|---|---|
boolean | getAllowOverlap() | → inherited from ShapeBase |
void | setAllowOverlap(boolean value) | |
Gets or sets a value that specifies whether this shape can overlap other shapes. | ||
java.lang.String | getAlternativeText() | → inherited from ShapeBase |
void | setAlternativeText(java.lang.String value) | |
Defines alternative text to be displayed instead of a graphic. | ||
boolean | getAnchorLocked() | → inherited from ShapeBase |
void | setAnchorLocked(boolean value) | |
Specifies whether the shape's anchor is locked. | ||
boolean | getAspectRatioLocked() | → inherited from ShapeBase |
void | setAspectRatioLocked(boolean value) | |
Specifies whether the shape's aspect ratio is locked. | ||
boolean | getBehindText() | → inherited from ShapeBase |
void | setBehindText(boolean value) | |
Specifies whether the shape is below or above text. | ||
double | getBottom() | → inherited from ShapeBase |
Gets the position of the bottom edge of the containing block of the shape. | ||
java.awt.geom.Rectangle2D.Float | getBounds() | → inherited from ShapeBase |
Gets or sets the location and size of the containing block of the shape. | ||
java.awt.geom.Rectangle2D.Float | getBoundsInPoints() | → inherited from ShapeBase |
Gets the location and size of the containing block of the shape in points, relative to the anchor of the topmost shape. | ||
java.awt.geom.Rectangle2D.Float | getBoundsWithEffects() | → inherited from ShapeBase |
Gets final extent that this shape object has after applying drawing effects. Value is measured in points. | ||
boolean | canHaveImage() | → inherited from ShapeBase |
Returns true if the shape type allows the shape to have an image. | ||
Aspose.Words.Drawing.Charts.Chart | getChart() | |
Provides access to the chart properties if this shape has a Chart. | ||
NodeCollection | getChildNodes() | → inherited from CompositeNode |
Gets all immediate child nodes of this node. | ||
java.awt.Point | getCoordOrigin() | → inherited from ShapeBase |
The coordinates at the top-left corner of the containing block of this shape. | ||
java.awt.Dimension | getCoordSize() | → inherited from ShapeBase |
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() | → inherited from ShapeBase |
void | setDistanceBottom(double value) | |
Returns or sets the distance (in points) between the document text and the bottom edge of the shape. | ||
double | getDistanceLeft() | → inherited from ShapeBase |
void | setDistanceLeft(double value) | |
Returns or sets the distance (in points) between the document text and the left edge of the shape. | ||
double | getDistanceRight() | → inherited from ShapeBase |
void | setDistanceRight(double value) | |
Returns or sets the distance (in points) between the document text and the right edge of the shape. | ||
double | getDistanceTop() | → inherited from ShapeBase |
void | setDistanceTop(double value) | |
Returns or sets the distance (in points) between the document text and the top edge of the shape. | ||
DocumentBase | getDocument() | → inherited from Node |
Gets the document to which this node belongs. | ||
boolean | getExtrusionEnabled() | |
Returns true if an extrusion effect is enabled. | ||
Fill | getFill() | |
Defines a fill for a shape. | ||
java.awt.Color | getFillColor() | |
Defines the brush color that fills the closed path of the shape. | ||
boolean | getFilled() | |
void | setFilled(boolean value) | |
Determines whether the closed path of the shape will be filled. | ||
Node | getFirstChild() | → inherited from CompositeNode |
Gets the first child of the node. | ||
Paragraph | getFirstParagraph() | |
Gets the first paragraph in the shape. | ||
int | getFlipOrientation() | → inherited from ShapeBase |
void | setFlipOrientation(int value) | |
Switches the orientation of a shape. The value of the property is FlipOrientation integer constant. | ||
Font | getFont() | → inherited from ShapeBase |
Provides access to the font formatting of this object. | ||
boolean | hasChart() | |
Returns true if this Shape has a |
||
boolean | hasChildNodes() | → inherited from CompositeNode |
Returns true if this node has any child nodes. | ||
boolean | hasImage() | |
Returns true if the shape has image bytes or links an image. | ||
double | getHeight() | → inherited from ShapeBase |
void | setHeight(double value) | |
Gets or sets the height of the containing block of the shape. | ||
int | getHorizontalAlignment() | → inherited from ShapeBase |
void | setHorizontalAlignment(int value) | |
Specifies how the shape is positioned horizontally. The value of the property is HorizontalAlignment integer constant. | ||
java.lang.String | getHRef() | → inherited from ShapeBase |
void | setHRef(java.lang.String value) | |
Gets or sets the full hyperlink address for a shape. | ||
ImageData | getImageData() | |
Provides access to the image of the shape. Returns null if the shape cannot have an image. | ||
boolean | isComposite() | → inherited from CompositeNode |
Returns true as this node can have child nodes. | ||
boolean | isDeleteRevision() | → inherited from ShapeBase |
Returns true if this object was deleted in Microsoft Word while change tracking was enabled. | ||
boolean | isGroup() | → inherited from ShapeBase |
Returns true if this is a group shape. | ||
boolean | isHorizontalRule() | → inherited from ShapeBase |
Returns true if this shape is a horizontal rule. | ||
boolean | isImage() | → inherited from ShapeBase |
Returns true if this shape is an image shape. | ||
boolean | isInline() | → inherited from ShapeBase |
A quick way to determine if this shape is positioned inline with text. | ||
boolean | isInsertRevision() | → inherited from ShapeBase |
Returns true if this object was inserted in Microsoft Word while change tracking was enabled. | ||
boolean | isSignatureLine() | → inherited from ShapeBase |
Indicates that shape is a SignatureLine. | ||
boolean | isTopLevel() | → inherited from ShapeBase |
Returns true if this shape is not a child of a group shape. | ||
boolean | isWordArt() | → inherited from ShapeBase |
Returns true if this shape is a WordArt object. | ||
Node | getLastChild() | → inherited from CompositeNode |
Gets the last child of the node. | ||
Paragraph | getLastParagraph() | |
Gets the last paragraph in the shape. | ||
double | getLeft() | → inherited from ShapeBase |
void | setLeft(double value) | |
Gets or sets the position of the left edge of the containing block of the shape. | ||
byte | getMarkupLanguage() | → inherited from ShapeBase |
Gets MarkupLanguage used for this graphic object. The value of the property is ShapeMarkupLanguage integer constant. | ||
java.lang.String | getName() | → inherited from ShapeBase |
void | setName(java.lang.String value) | |
Gets or sets the optional shape name. | ||
Node | getNextSibling() | → inherited from Node |
Gets the node immediately following this node. | ||
int | getNodeType() | |
Returns |
||
OleFormat | getOleFormat() | |
Provides access to the OLE data of a shape. For a shape that is not an OLE object or ActiveX control, returns null. | ||
CompositeNode | getParentNode() | → inherited from Node |
Gets the immediate parent of this node. | ||
Paragraph | getParentParagraph() | → inherited from ShapeBase |
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() | → inherited from ShapeBase |
void | setRelativeHorizontalPosition(int value) | |
Specifies relative to what the shape is positioned horizontally. The value of the property is RelativeHorizontalPosition integer constant. | ||
int | getRelativeVerticalPosition() | → inherited from ShapeBase |
void | setRelativeVerticalPosition(int value) | |
Specifies relative to what the shape is positioned vertically. The value of the property is RelativeVerticalPosition integer constant. | ||
double | getRight() | → inherited from ShapeBase |
Gets the position of the right edge of the containing block of the shape. | ||
double | getRotation() | → inherited from ShapeBase |
void | setRotation(double value) | |
Defines the angle (in degrees) that a shape is rotated. Positive value corresponds to clockwise rotation angle. | ||
java.lang.String | getScreenTip() | → inherited from ShapeBase |
void | setScreenTip(java.lang.String value) | |
Defines the text displayed when the mouse pointer moves over the shape. | ||
boolean | getShadowEnabled() | |
Returns true if a shadow effect is enabled. | ||
int | getShapeType() | → inherited from ShapeBase |
Gets the shape type. The value of the property is ShapeType integer constant. | ||
SignatureLine | getSignatureLine() | |
Gets |
||
java.awt.Dimension | getSizeInPoints() | → inherited from ShapeBase |
Gets the size of the shape in points. | ||
int | getStoryType() | |
Returns |
||
Stroke | getStroke() | |
Defines a stroke for a shape. | ||
java.awt.Color | getStrokeColor() | |
Defines the color of a stroke. | ||
boolean | getStroked() | |
void | setStroked(boolean value) | |
Defines whether the path will be stroked. | ||
double | getStrokeWeight() | |
void | setStrokeWeight(double value) | |
Defines the brush thickness that strokes the path of a shape in points. | ||
java.lang.String | getTarget() | → inherited from ShapeBase |
void | setTarget(java.lang.String value) | |
Gets or sets the target frame for the shape hyperlink. | ||
TextBox | getTextBox() | |
Defines attributes that specify how text is displayed in a shape. | ||
TextPath | getTextPath() | |
Defines the text of the text path (of a WordArt object). | ||
java.lang.String | getTitle() | → inherited from ShapeBase |
void | setTitle(java.lang.String value) | |
Gets or sets the title (caption) of the current shape object. | ||
double | getTop() | → inherited from ShapeBase |
void | setTop(double value) | |
Gets or sets the position of the top edge of the containing block of the shape. | ||
int | getVerticalAlignment() | → inherited from ShapeBase |
void | setVerticalAlignment(int value) | |
Specifies how the shape is positioned vertically. The value of the property is VerticalAlignment integer constant. | ||
double | getWidth() | → inherited from ShapeBase |
void | setWidth(double value) | |
Gets or sets the width of the containing block of the shape. | ||
int | getWrapSide() | → inherited from ShapeBase |
void | setWrapSide(int value) | |
Specifies how the text is wrapped around the shape. The value of the property is WrapSide integer constant. | ||
int | getWrapType() | → inherited from ShapeBase |
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() | → inherited from ShapeBase |
void | setZOrder(int value) | |
Determines the display order of overlapping shapes. |
Method Summary | ||
---|---|---|
boolean | accept(DocumentVisitor visitor) | |
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() | → inherited from ShapeBase |
Reserved for internal use. | ||
Node | deepClone(boolean isCloneChildren) | → inherited from Node |
Creates a duplicate of the node. | ||
java.lang.Object | fetchInheritedRunAttr(int fontAttr) | → inherited from ShapeBase |
Reserved for internal use. | ||
java.lang.Object | fetchInheritedShapeAttr(int key) | → inherited from ShapeBase |
Reserved for internal use. | ||
java.lang.Object | fetchShapeAttr(int key) | → inherited from ShapeBase |
Reserved for internal use. | ||
CompositeNode | getAncestor(int ancestorType) | → inherited from Node |
Gets the first ancestor of the specified |
||
CompositeNode | getAncestor(java.lang.Class ancestorType) | → inherited from Node |
Gets the first ancestor of the specified object 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. | ||
CompositeNode | getContainer() | → inherited from CompositeNode |
Reserved for internal use. | ||
aspose.obfuscated.type | getDeleteRevision() | → inherited from ShapeBase |
Reserved for internal use. | ||
java.lang.Object | getDirectRunAttr(int fontAttr) | → inherited from ShapeBase |
Reserved for internal use. | ||
int | getDirectRunAttrsCount() | → inherited from ShapeBase |
Reserved for internal use. | ||
java.lang.Object | getDirectShapeAttr(int key) | → inherited from ShapeBase |
Reserved for internal use. | ||
DocumentBase | getDocument_IInline() | → inherited from ShapeBase |
Reserved for internal use. | ||
aspose.obfuscated.type | getExpandedRunPr_IInline(aspose.obfuscated.type flags) | → inherited from ShapeBase |
Reserved for internal use. | ||
aspose.obfuscated.type | getInsertRevision() | → inherited from ShapeBase |
Reserved for internal use. | ||
aspose.obfuscated.type | getMoveFromRevision() | → inherited from ShapeBase |
Reserved for internal use. | ||
aspose.obfuscated.type | getMoveToRevision() | → inherited from ShapeBase |
Reserved for internal use. | ||
Node | getNextMatchingNode(aspose.obfuscated.type curNode) | → inherited from CompositeNode |
Reserved for internal use. | ||
Paragraph | getParentParagraph_IInline() | → inherited from ShapeBase |
Reserved for internal use. | ||
aspose.obfuscated.type | getRunPr_IInline() | → inherited from ShapeBase |
Reserved for internal use. | ||
Aspose.Words.Rendering.ShapeRenderer | getShapeRenderer() | → inherited from ShapeBase |
Creates and returns an object that can be used to render this shape into an image. | ||
java.awt.geom.Point2D.Float | getSizeInPoints() | → inherited from ShapeBase |
Gets the size of the shape in points. | ||
java.lang.String | getText() | → inherited from CompositeNode |
Gets the text of this node and of all its children. | ||
int | getTextboxLayoutFlow_ITextBox() | |
Reserved for internal use. | ||
int | getTextBoxWrapMode_ITextBox() | |
Reserved for internal use. | ||
int | getZOrder_IShape() | → inherited from ShapeBase |
Reserved for internal use. | ||
boolean | hasVerticalTextFlow_ITextBox() | |
Reserved for internal use. | ||
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. | ||
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. | ||
void | removeRunAttr(int key) | → inherited from ShapeBase |
Reserved for internal use. | ||
void | removeShapeAttr(int key) | → inherited from ShapeBase |
Reserved for internal use. | ||
void | removeSmartTags() | → inherited from CompositeNode |
Removes all |
||
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 | setDeleteRevision(aspose.obfuscated.type value) | → inherited from ShapeBase |
Reserved for internal use. | ||
void | setInsertRevision(aspose.obfuscated.type value) | → inherited from ShapeBase |
Reserved for internal use. | ||
void | setMoveFromRevision(aspose.obfuscated.type value) | → inherited from ShapeBase |
Reserved for internal use. | ||
void | setMoveToRevision(aspose.obfuscated.type value) | → inherited from ShapeBase |
Reserved for internal use. | ||
void | setRunAttr(int fontAttr, java.lang.Object value) | → inherited from ShapeBase |
Reserved for internal use. | ||
void | setRunPr_IInline(aspose.obfuscated.type value) | → inherited from ShapeBase |
Reserved for internal use. | ||
void | setShapeAttr(int key, java.lang.Object value) | → inherited from ShapeBase |
Reserved for internal use. | ||
void | setZOrder_IShape(int value) | → inherited from ShapeBase |
Reserved for internal use. | ||
java.lang.String | toString(int saveFormat) | → inherited from Node |
Exports the content of the node into a string in the specified format. | ||
java.lang.String | toTxt() | → inherited from Node |
Exports the content of the node into a string in plain text format. |
Constructor Detail |
---|
public Shape(DocumentBase doc, int shapeType)
You should specify desired shape properties after you created a shape.
doc
- The owner document.shapeType
- A Property Getters/Setters Detail |
---|
getAllowOverlap/setAllowOverlap | → inherited from ShapeBase |
public boolean getAllowOverlap() / public void setAllowOverlap(boolean value) |
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 | → inherited from ShapeBase |
public java.lang.String getAlternativeText() / public void setAlternativeText(java.lang.String value) |
The default value is an empty string.
getAnchorLocked/setAnchorLocked | → inherited from ShapeBase |
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.
getAspectRatioLocked/setAspectRatioLocked | → inherited from ShapeBase |
public boolean getAspectRatioLocked() / public void setAspectRatioLocked(boolean value) |
The default value depends on the
Has effect for top level shapes only.
getBehindText/setBehindText | → inherited from ShapeBase |
public boolean getBehindText() / public void setBehindText(boolean value) |
Has effect only for top level shapes.
The default value is false.
getBottom | → inherited from ShapeBase |
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.
getBounds | → inherited from ShapeBase |
public java.awt.geom.Rectangle2D.Float getBounds() |
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 | → inherited from ShapeBase |
public java.awt.geom.Rectangle2D.Float getBoundsInPoints() |
getBoundsWithEffects | → inherited from ShapeBase |
public java.awt.geom.Rectangle2D.Float getBoundsWithEffects() |
canHaveImage | → inherited from ShapeBase |
public boolean canHaveImage() |
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
getChart | |
public Aspose.Words.Drawing.Charts.Chart getChart() |
getChildNodes | → inherited from CompositeNode |
public NodeCollection getChildNodes() |
Note, 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 | → inherited from ShapeBase |
public java.awt.Point getCoordOrigin() |
The default value is (0,0).
getCoordSize | → inherited from ShapeBase |
public java.awt.Dimension getCoordSize() |
The default value is (1000, 1000).
getCount | → inherited from CompositeNode |
public int getCount() |
getDistanceBottom/setDistanceBottom | → inherited from ShapeBase |
public double getDistanceBottom() / public void setDistanceBottom(double value) |
The default value is 0.
Has effect only for top level shapes.
getDistanceLeft/setDistanceLeft | → inherited from ShapeBase |
public double getDistanceLeft() / public void setDistanceLeft(double value) |
The default value is 1/8 inch.
Has effect only for top level shapes.
getDistanceRight/setDistanceRight | → inherited from ShapeBase |
public double getDistanceRight() / public void setDistanceRight(double value) |
The default value is 1/8 inch.
Has effect only for top level shapes.
getDistanceTop/setDistanceTop | → inherited from ShapeBase |
public double getDistanceTop() / public void setDistanceTop(double value) |
The default value is 0.
Has effect only for top level shapes.
getDocument | → inherited from Node |
public DocumentBase getDocument() |
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.
getExtrusionEnabled | |
public boolean getExtrusionEnabled() |
getFill | |
public Fill getFill() |
getFillColor | |
public java.awt.Color getFillColor() |
This is a shortcut to the
The default value is
getFilled/setFilled | |
public boolean getFilled() / public void setFilled(boolean value) |
This is a shortcut to the
The default value is true.
getFirstChild | → inherited from CompositeNode |
public Node getFirstChild() |
getFirstParagraph | |
public Paragraph getFirstParagraph() |
getFlipOrientation/setFlipOrientation | → inherited from ShapeBase |
public int getFlipOrientation() / public void setFlipOrientation(int value) |
The default value is
getFont | → inherited from ShapeBase |
public Font getFont() |
hasChart | |
public boolean hasChart() |
hasChildNodes | → inherited from CompositeNode |
public boolean hasChildNodes() |
hasImage | |
public boolean hasImage() |
getHeight/setHeight | → inherited from ShapeBase |
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 0.
getHorizontalAlignment/setHorizontalAlignment | → inherited from ShapeBase |
public int getHorizontalAlignment() / public void setHorizontalAlignment(int value) |
The default value is
Has effect only for top level floating shapes.
getHRef/setHRef | → inherited from ShapeBase |
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 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
.
getImageData | |
public ImageData getImageData() |
isComposite | → inherited from CompositeNode |
public boolean isComposite() |
isDeleteRevision | → inherited from ShapeBase |
public boolean isDeleteRevision() |
isGroup | → inherited from ShapeBase |
public boolean isGroup() |
isHorizontalRule | → inherited from ShapeBase |
public boolean isHorizontalRule() |
isImage | → inherited from ShapeBase |
public boolean isImage() |
isInline | → inherited from ShapeBase |
public boolean isInline() |
Has effect only for top level shapes.
isInsertRevision | → inherited from ShapeBase |
public boolean isInsertRevision() |
isSignatureLine | → inherited from ShapeBase |
public boolean isSignatureLine() |
isTopLevel | → inherited from ShapeBase |
public boolean isTopLevel() |
isWordArt | → inherited from ShapeBase |
public boolean isWordArt() |
getLastChild | → inherited from CompositeNode |
public Node getLastChild() |
getLastParagraph | |
public Paragraph getLastParagraph() |
getLeft/setLeft | → inherited from ShapeBase |
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.
getMarkupLanguage | → inherited from ShapeBase |
public byte getMarkupLanguage() |
getName/setName | → inherited from ShapeBase |
public java.lang.String getName() / public void setName(java.lang.String value) |
Default is empty string.
Cannot be null, but can be an empty string.
getNextSibling | → inherited from Node |
public Node getNextSibling() |
getNodeType | |
public int getNodeType() |
getOleFormat | |
public OleFormat getOleFormat() |
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.
getParentParagraph | → inherited from ShapeBase |
public Paragraph getParentParagraph() |
getPreviousSibling | → inherited from Node |
public Node getPreviousSibling() |
getRange | → inherited from Node |
public Range getRange() |
getRelativeHorizontalPosition/setRelativeHorizontalPosition | → inherited from ShapeBase |
public int getRelativeHorizontalPosition() / public void setRelativeHorizontalPosition(int value) |
The default value is
Has effect only for top level floating shapes.
getRelativeVerticalPosition/setRelativeVerticalPosition | → inherited from ShapeBase |
public int getRelativeVerticalPosition() / public void setRelativeVerticalPosition(int value) |
The default value is
Has effect only for top level floating shapes.
getRight | → inherited from ShapeBase |
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.
getRotation/setRotation | → inherited from ShapeBase |
public double getRotation() / public void setRotation(double value) |
The default value is 0.
getScreenTip/setScreenTip | → inherited from ShapeBase |
public java.lang.String getScreenTip() / public void setScreenTip(java.lang.String value) |
The default value is an empty string.
getShadowEnabled | |
public boolean getShadowEnabled() |
getShapeType | → inherited from ShapeBase |
public int getShapeType() |
getSignatureLine | |
public SignatureLine getSignatureLine() |
getSizeInPoints | → inherited from ShapeBase |
public java.awt.Dimension getSizeInPoints() |
getStoryType | |
public int getStoryType() |
getStroke | |
public Stroke getStroke() |
getStrokeColor | |
public java.awt.Color getStrokeColor() |
This is a shortcut to the
The default value is
getStroked/setStroked | |
public boolean getStroked() / public void setStroked(boolean value) |
This is a shortcut to the
The default value is true.
getStrokeWeight/setStrokeWeight | |
public double getStrokeWeight() / public void setStrokeWeight(double value) |
This is a shortcut to the
The default value is 0.75.
getTarget/setTarget | → inherited from ShapeBase |
public java.lang.String getTarget() / public void setTarget(java.lang.String value) |
The default value is an empty string.
getTextBox | |
public TextBox getTextBox() |
getTextPath | |
public TextPath getTextPath() |
getTitle/setTitle | → inherited from ShapeBase |
public java.lang.String getTitle() / public void setTitle(java.lang.String value) |
Default is empty string.
Cannot be null, but can be an empty string.
getTop/setTop | → inherited from ShapeBase |
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.
getVerticalAlignment/setVerticalAlignment | → inherited from ShapeBase |
public int getVerticalAlignment() / public void setVerticalAlignment(int value) |
The default value is
Has effect only for top level floating shapes.
getWidth/setWidth | → inherited from ShapeBase |
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 0.
getWrapSide/setWrapSide | → inherited from ShapeBase |
public int getWrapSide() / public void setWrapSide(int value) |
The default value is
Has effect only for top level shapes.
getWrapType/setWrapType | → inherited from ShapeBase |
public int getWrapType() / public void setWrapType(int value) |
The default value is
Has effect only for top level shapes.
getZOrder/setZOrder | → inherited from ShapeBase |
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.
The display order of child shapes in a group shape is determined by their order inside the group shape.
Method Detail |
---|
accept | |
public 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.appendChild | → inherited from CompositeNode |
public Node appendChild(Node newChild) |
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.clearRunAttrs | → inherited from ShapeBase |
public void clearRunAttrs() |
deepClone | → inherited from Node |
public Node deepClone(boolean isCloneChildren) |
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.fetchInheritedRunAttr | → inherited from ShapeBase |
public java.lang.Object fetchInheritedRunAttr(int fontAttr) |
fetchInheritedShapeAttr | → inherited from ShapeBase |
public java.lang.Object fetchInheritedShapeAttr(int key) |
fetchShapeAttr | → inherited from ShapeBase |
public java.lang.Object fetchShapeAttr(int key) |
getAncestor | → inherited from Node |
public CompositeNode getAncestor(int ancestorType) |
ancestorType
- A getAncestor | → inherited from Node |
public CompositeNode getAncestor(java.lang.Class ancestorType) |
The ancestor type matches if it is equal to ancestorType or derived from ancestorType.
ancestorType
- The object type of the ancestor to retrieve.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. See remarks for more info.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. getContainer | → inherited from CompositeNode |
public CompositeNode getContainer() |
getDeleteRevision | → inherited from ShapeBase |
public aspose.obfuscated.type getDeleteRevision() |
getDirectRunAttr | → inherited from ShapeBase |
public java.lang.Object getDirectRunAttr(int fontAttr) |
getDirectRunAttrsCount | → inherited from ShapeBase |
public int getDirectRunAttrsCount() |
getDirectShapeAttr | → inherited from ShapeBase |
public java.lang.Object getDirectShapeAttr(int key) |
getDocument_IInline | → inherited from ShapeBase |
public DocumentBase getDocument_IInline() |
getExpandedRunPr_IInline | → inherited from ShapeBase |
public aspose.obfuscated.type getExpandedRunPr_IInline(aspose.obfuscated.type flags) |
getInsertRevision | → inherited from ShapeBase |
public aspose.obfuscated.type getInsertRevision() |
getMoveFromRevision | → inherited from ShapeBase |
public aspose.obfuscated.type getMoveFromRevision() |
getMoveToRevision | → inherited from ShapeBase |
public aspose.obfuscated.type getMoveToRevision() |
getNextMatchingNode | → inherited from CompositeNode |
public Node getNextMatchingNode(aspose.obfuscated.type curNode) |
getParentParagraph_IInline | → inherited from ShapeBase |
public Paragraph getParentParagraph_IInline() |
getRunPr_IInline | → inherited from ShapeBase |
public aspose.obfuscated.type getRunPr_IInline() |
getShapeRenderer | → inherited from ShapeBase |
public Aspose.Words.Rendering.ShapeRenderer getShapeRenderer() throws java.lang.Exception |
This method just invokes the
getSizeInPoints | → inherited from ShapeBase |
public java.awt.geom.Point2D.Float getSizeInPoints() |
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() |
The returned string includes all control and special characters as described in
getTextboxLayoutFlow_ITextBox | |
public int getTextboxLayoutFlow_ITextBox() |
getTextBoxWrapMode_ITextBox | |
public int getTextBoxWrapMode_ITextBox() |
getZOrder_IShape | → inherited from ShapeBase |
public int getZOrder_IShape() |
hasVerticalTextFlow_ITextBox | |
public boolean hasVerticalTextFlow_ITextBox() |
indexOf | → inherited from CompositeNode |
public int indexOf(Node child) |
insertAfter | → inherited from CompositeNode |
public Node insertAfter(Node newChild, Node refChild) |
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) |
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
newChild
- The Node to insert.refChild
- The Node that is the reference node. The newChild is placed before this node.iterator | → inherited from CompositeNode |
public java.util.Iterator iterator() |
nextPreOrder | → inherited from Node |
public Node nextPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.prependChild | → inherited from CompositeNode |
public Node prependChild(Node newChild) |
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.previousPreOrder | → inherited from Node |
public Node previousPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.remove | → inherited from Node |
public void remove() |
removeAllChildren | → inherited from CompositeNode |
public void removeAllChildren() |
removeChild | → inherited from CompositeNode |
public Node removeChild(Node oldChild) |
The parent of oldChild is set to null after the node is removed.
oldChild
- The node to remove.removeRunAttr | → inherited from ShapeBase |
public void removeRunAttr(int key) |
removeShapeAttr | → inherited from ShapeBase |
public void removeShapeAttr(int key) |
removeSmartTags | → inherited from CompositeNode |
public void removeSmartTags() |
selectNodes | → inherited from CompositeNode |
public NodeList selectNodes(java.lang.String xpath) |
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) |
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.setDeleteRevision | → inherited from ShapeBase |
public void setDeleteRevision(aspose.obfuscated.type value) |
setInsertRevision | → inherited from ShapeBase |
public void setInsertRevision(aspose.obfuscated.type value) |
setMoveFromRevision | → inherited from ShapeBase |
public void setMoveFromRevision(aspose.obfuscated.type value) |
setMoveToRevision | → inherited from ShapeBase |
public void setMoveToRevision(aspose.obfuscated.type value) |
setRunAttr | → inherited from ShapeBase |
public void setRunAttr(int fontAttr, java.lang.Object value) |
setRunPr_IInline | → inherited from ShapeBase |
public void setRunPr_IInline(aspose.obfuscated.type value) |
setShapeAttr | → inherited from ShapeBase |
public void setShapeAttr(int key, java.lang.Object value) |
setZOrder_IShape | → inherited from ShapeBase |
public void setZOrder_IShape(int value) |
toString | → inherited from Node |
public java.lang.String toString(int saveFormat) throws java.lang.Exception |
saveFormat
- A SaveFormat value.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
(or any other) combination of characters to mark ends of paragraphs in the resulting string.
It produces a different result from