com.aspose.diagram
Class Shape

java.lang.Object
    com.aspose.diagram.Shape

public class Shape 
extends java.lang.Object

Shape

public Shape()

Constructor.

public long getID() / public void setID(long value)

The unique ID of the element within its parent element.

public int getDel() / public void setDel(int value)

A flag indicating whether the element is deleted locally. A value of 1 indicates that the element is deleted locally. The value of the property is BOOL integer constant.

public java.util.UUID getUniqueID()

A GUID (globally unique identifier) assigned to the shape.

public java.lang.String getName() / public void setName(java.lang.String value)

The name of the element.

public java.lang.String getNameU() / public void setNameU(java.lang.String value)

The universal name of the element.

public int getType() / public void setType(int value)

The type of a shape. It may be one of the following values: Group, Shape, Guide, or Foreign. The value of the property is TypeValue integer constant.

public StyleSheet getLineStyle() / public void setLineStyle(StyleSheet value)

StyleSheet from which this shape inherits line formatting

public StyleSheet getFillStyle() / public void setFillStyle(StyleSheet value)

StyleSheet from which this shape inherits fill formatting.

public StyleSheet getTextStyle() / public void setTextStyle(StyleSheet value)

StyleSheet from which this shape inherits text formatting.

public ShapeCollection getShapes()

Contains a collection of Shape elements.

public Text getText() / public void setText(Text value)

Contains the text of a shape.

public XForm getXForm() / public void setXForm(XForm value)

Contains elements specifying general positioning information about a shape.

public Line getLine()

Contains elements that control line attributes for a shape, such as pattern, weight, and color. These elements determine whether the line ends are formatted (for example, with an arrowhead), the size of line end formats, radius of the rounding circle applied to the line, and line cap style (round or square).

public Fill getFill()

Contains the current fill formatting values for the shape and the shape's drop shadow, including pattern, foreground color, and background color.

public boolean hasThemeColor()

Gets whether the shape has theme color.

public CharCollection getInheritChars()

Contains the char values for the shape inherit by the master shape.

public PropCollection getInheritProps()

Contains the props for the shape inherit by the master shape.

public ActCollection getInheritActs()

Contains the actions for the shape inherit by the master shape.

public Group getInheritGroup()

public UserCollection getInheritUsers()

Contains the users for the shape inherit by the master shape.

public GeomCollection getInheritGeoms()

Contains the Geoms values for the shape inherit by the master shape.

public ParaCollection getInheritParas()

Contains the paras for the shape inherit by the parent style and the master shape.

public TextBlock getInheritTextBlock()

Contains the textblock values for the shape inherit by the parent style and the master shape.

public Line getInheritLine()

Contains the line formatting values for the shape inherit by the parent style and the master shape.

public Fill getInheritFill()

Contains the fill formatting values for the shape inherit by the parent style and the master shape.

public XForm1D getXForm1D() / public void setXForm1D(XForm1D value)

Contains x- and y-coordinates of the begin point and end point of a 1-D shape. This element appears for 1-D shapes only.

public Event getEvent() / public void setEvent(Event value)

Contains elements that specify formulas that control shape events.

public LayerMem getLayerMem()

Contains the LayerMember element, which specifies each layer to which the shape is assigned.

public Foreign getForeign()

Contains elements specifying the width and height of an object from another program used in a Microsoft Visio document. Also includes elements specifying the distance the object's image is offset within its borders.

public TextBlock getTextBlock()

Contains elements that specify the alignment, margins, and default tab stop positions of text in a shape's text block.

public TextXForm getTextXForm()

Contains elements that specify positioning information about a shape's text block.

public Align getAlign()

Indicates the alignment of a shape with respect to the guide or guide point to which the shape is glued. The Align element appears only for shapes that are glued to guides or guide points.

public Protection getProtection()

Locking helps prevent inadvertent changes to the shape but does not prevent Microsoft Visio from resetting values in other circumstances. It also does not protect against changes made in the ShapeSheet window.

public Help getHelp()

Contains elements specifying the Shape element's Help file topic and copyright information.

public Misc getMisc()

Contains elements specifying the Shape element's Help file topic and copyright information.

public Image getImage()

Contains the gamma, brightness, contrast, blur, sharpen, denoise, and transparency values for a bitmap.

public Group getGroup()

Contains elements that control how you add shapes to a group, move members of a group, and select groups.

public Layout getLayout()

Contains elements that control shape placement and connector routing settings.

public CharCollection getChars()

Contains a collection of Char elements.

public ParaCollection getParas()

Contains a collection of Para elements.

public ScratchCollection getScratchs()

Contains a collection of Scratch elements.

public ConnectionCollection getConnections()

Contains a collection of Connection elements.

public ConnectionABCDCollection getConnectionABCDs()

Contains a collection of ConnectionABCD elements.

public FieldCollection getFields()

Contains a collection of Field elements.

public ControlCollection getControls()

Contains a collection of Control elements.

public GeomCollection getGeoms()

Contains a collection of Geom elements.

public ActCollection getActs()

Contains a collection of Act elements.

public UserCollection getUsers()

Contains a collection of User elements.

public PropCollection getProps() / public void setProps(PropCollection value)

Contains a collection of Prop elements.

public HyperlinkCollection getHyperlinks()

Contains a collection of Hyperlink elements.

public SmartTagDefCollection getSmartTagDefs()

Contains a collection of SmartTagDef elements.

public TabsCollection getTabsCollection()

Contains a collection of Tab elements.

public java.lang.String getData1() / public void setData1(java.lang.String value)

Contains an arbitrary string value that is used to supply additional information about a shape.

public java.lang.String getData2() / public void setData2(java.lang.String value)

Contains an arbitrary string value that is used to supply additional information about a shape.

public java.lang.String getData3() / public void setData3(java.lang.String value)

Contains an arbitrary string value that is used to supply additional information about a shape.

public java.lang.String getClippingPath() / public void setClippingPath(java.lang.String value)

public ForeignData getForeignData()

Contains a MIME (Multipurpose Internet Mail Extensions) encoded BLOB of picture data, such as Windows metafile, bitmap, or OLE data.

public Shape getMasterShape() / public void setMasterShape(Shape value)

This attribute may only be present in shapes that are members of a group shape, and the group is an instance of a master. The attribute contains an ID that references the corresponding sub-shape in the master.

public Master getMaster() / public void setMaster(Master value)

The Master from which the shape inherits its data.

public Shape getParentShape() / public void setParentShape(Shape value)

Shape's parent.

public Shape getRootShape()

Returns the top-level shape of an instance if this shape is part of a master instance. Read-only.

public Diagram getDiagram() / public void setDiagram(Diagram value)

Root element of Visio objects hierarchy.

public Page getPage() / public void setPage(Page value)

Root element of Visio objects hierarchy.

public boolean getOneD()

Determines whether the shape behaves as a one-dimensional (1-D) object. Read-only.

public boolean getTwoD() / public void setTwoD(boolean value)

Determines whether the shape behaves as a two-dimensional (2-D) object.

public byte[] getControlData()

Gets the data of control.

public ActiveXControl getActiveXControl()

Gets the ActiveX control.

public int getZOrderIndex()

Returns the index of a shape in the z-order except the guide shape.

public void setPresetTheme(int value)

Apply a preset theme to this shape The value of the property is PresetThemeValue integer constant.

public void setPresetThemeVariant(int value)

Apply a preset theme variant to this shape The value of the property is PresetThemeVariantValue integer constant.

public void setPresetThemeQuickStyle(int value)

Apply a preset theme variant quickstyle to this shape The value of the property is PresetQuickStyleValue integer constant.

public ThreeDFormat getThreeDFormat()

Gets the ThreeDFormat.

public void convertToGroup()

Converts a selection or an object from another application (a linked or embedded object) to a group.

public int getConnectorsType()

Get Connectors type

public void setConnectorJumpValue(int code, int style)
                          throws java.lang.Exception

Set Jump code value and Jump style value for Connector

Parameters:

code - A ConLineJumpCodeValue value. Jump Code Value

style - A ConLineJumpStyleValue value. Jump Code Style

public void setConnectorsType(int type)
                      throws java.lang.Exception

Set Connectors type

Parameters:

type - A ConnectorsTypeValue value. Connectors type value

public int getRelationFlag(Shape shape)

Returns RelationFlag that represents the relationship of one shape to another shape.

Parameters:

shape - Shape

public RelationShapeCollection getRelationShapeCollection()

Returns RelationShapeCollection that represents the relationshapes of one shape.

public void setPresetThemeStyleMatrics(int styleIndex, int colorIndex)

pply a preset theme variant quickstyle to this shape, like theme styles options in shape styles dropdown list

Parameters:

styleIndex - A PresetStyleMatricsValue value. the row of style matrics

colorIndex - A PresetColorMatricsValue value. the column of style matrics

public void copy(Shape source)
         throws java.lang.Exception

public void bringForward()
                 throws java.lang.Exception

Brings the shape forward one position in the z-order.

public void sendBackward()
                 throws java.lang.Exception

Moves the shape back one position in the z-order.

public void bringToFront()

Brings the shape to the front of the z-order.

public void sendToBack()

Moves the shape to the back of the z-order.

public ConnectorRule getConnectorRule()
                              throws java.lang.Exception

Returns a connectorRule that contains the shape id and connecton that are connected to the shape.

Returns:

ConnectorRule.

public long[] connectedShapes(int flag, java.lang.String categoryFilter)
                      throws java.lang.Exception

Returns an array that contains the identifiers (IDs) of the shapes that are connected to the shape.

Parameters:

flag - A ConnectedShapesFlags value. Filters the array of returned shape IDs by the directionality of the connectors. See Remarks for possible valuesConnectedShapesFlags.

categoryFilter - Filters the array of returned shape IDs by limiting it to the IDs of shapes that match the specified categoryjava.lang.String.

Returns:

IDs arraylong.

public boolean isInGroup()

Indicates whether this shape is in a group shape.

public boolean isContain(Shape shape)
                 throws java.lang.Exception

Indicates whether this shape is contain another shape.

public boolean isIntersect(Shape shape)
                   throws java.lang.Exception

Indicates whether this shape is intersect another shape.

public boolean isConnected(Shape shape)
                   throws java.lang.Exception

Indicates whether this two shapes are connected.

Parameters:

shape - shape

public void centerDrawing()

Center the shape with respect to the extent of the page

public boolean isGlued(Shape shape)
               throws java.lang.Exception

Indicates whether this two shapes are glued.

Parameters:

shape - shape

public void refreshData()
                throws java.lang.Exception

Refreshes shape's position including xform ,connection and geom when changing shape's text or other's .

We will gather shape's data such as shape's text then calculate shape's position. This method is only used to refresh shape's data .

public long[] gluedShapes(int flag, java.lang.String categoryFilter, Shape otherShape)
                  throws java.lang.Exception

Returns an array that contains the identifiers of the shapes that are glued to a shape.

Parameters:

flag - A GluedShapesFlags value. The dimensionality and directionality of the connection points of the shapes to return.See Remarks for possible valuesGluedShapesFlags.

categoryFilter - Filters the array of returned shape IDs by limiting it to the IDs of shapes that match the specified categoryjava.lang.String.

otherShape - Optional: additional shape to which returned shapes must also be glued, can be Shape or null.

Returns:

IDs arraylong.

public long[] dependsOnShapes()
                      throws java.lang.Exception

Returns an array that contains the identifiers of the shapes that are depends on a shape.

Returns:

IDs arraylong.

public void setWidth(double width)
             throws java.lang.Exception

Sets new width of shape.

Parameters:

width - New widthdouble.

public void setHeight(double height)
              throws java.lang.Exception

Sets new height of shape.

Parameters:

height - New heightdouble.

public void setAngle(double angle)
             throws java.lang.Exception

Sets new angle of shape. The angle's unit is radian.

Parameters:

angle - New angle which unit is radian not degreedouble.

public void moveTo(double newPinX, double newPinY)
           throws java.lang.Exception

Moves shape on new absolute position on the page.

Parameters:

newPinX - New x-coordinate of the shape's pin (center of rotation) in relation to the origin of its parent.double.

newPinY - New y-coordinate of the shape's pin (center of rotation) in relation to the origin of its parent.double.

public void move(double dX, double dY)
         throws java.lang.Exception

Moves shape on the dX and dY inches from current position.

Parameters:

dX - X offsetdouble.

dY - Y offsetdouble.

public java.lang.String getDisplayText()

Get the text displayed on the interface

public java.lang.String getPureText()

Get the text string

public void ungroup()
            throws java.lang.Exception

Ungroup Shape

public void replaceText(java.lang.String text, java.lang.String replaceText)

Replace the text string of a shape .

public void toPdf(java.io.OutputStream stream)
          throws java.lang.Exception

Creates the shape pdf and saves it to a stream.

Parameters:

stream - The output stream.

public void toPdf(java.lang.String fileName)
          throws java.lang.Exception

Saves the shape to a pdf file.

Parameters:

fileName - the pdf file name with full path

public void toImage(java.lang.String imageFile, ImageSaveOptions options)
            throws java.lang.Exception

Creates the shape image and saves it to a file. The extension of the file name determines the format of the image.

The format of the image is specified by using the extension of the file name. For example, if you specify "myfile.png", then the image will be saved in the PNG format. The following file extensions are recognized: .bmp, .gif, .png, .jpg, .jpeg, .tiff, .tif, .emf.

Parameters:

imageFile - The image file name with full path.

options - Additional image creation options

public void toImage(java.io.OutputStream stream, ImageSaveOptions options)
            throws java.lang.Exception

Creates the shape image and saves it to a stream in the specified format.

Parameters:

stream - The output stream.

options - Additional image creation options

public void toSvg(java.lang.String fileName, SVGSaveOptions options)
          throws java.lang.Exception

Saves the shape to a svg file.

Parameters:

fileName - the svg file name with full path

options - Svg save options

public void toHTML(java.lang.String fileName, HTMLSaveOptions options)
           throws java.lang.Exception

Creates the html and saves it to a file.

Parameters:

fileName - The file name with full path.

options - html save options

public void toHTML(java.io.OutputStream stream, HTMLSaveOptions options)
           throws java.lang.Exception

Creates the shape html and saves it to a stream in the specified format.

Parameters:

stream - The output stream.

options - Addtional html creation options