Shape

Inheritance: java.lang.Object

public class Shape

Contains elements that define a shape in a Master, Page, or group shape element.

Constructors

ConstructorDescription
Shape()Constructor.

Methods

MethodDescription
bringForward()Brings the shape forward one position in the z-order.
bringToFront()Brings the shape to the front of the z-order.
centerDrawing()Center the shape with respect to the extent of the page
connectedShapes(int flag, String categoryFilter)Returns an array that contains the identifiers (IDs) of the shapes that are connected to the shape.
convertToGroup()Converts a selection or an object from another application (a linked or embedded object) to a group.
copy(Shape source)
dependsOnShapes()Returns an array that contains the identifiers of the shapes that are depends on a shape.
equals(Object arg0)
getActiveXControl()Gets the ActiveX control.
getActs()Contains a collection of Act elements.
getAlign()Indicates the alignment of a shape with respect to the guide or guide point to which the shape is glued.
getChars()Contains a collection of Char elements.
getClass()
getClippingPath()
getConnectionABCDs()Contains a collection of ConnectionABCD elements.
getConnections()Contains a collection of Connection elements.
getConnectorRule()Returns a connectorRule that contains the shape id and connecton that are connected to the shape.
getConnectorsType()Get Connectors type
getControlData()Gets the data of control.
getControls()Contains a collection of Control elements.
getData1()Contains an arbitrary string value that is used to supply additional information about a shape.
getData2()Contains an arbitrary string value that is used to supply additional information about a shape.
getData3()Contains an arbitrary string value that is used to supply additional information about a shape.
getDel()A flag indicating whether the element is deleted locally.
getDiagram()Root element of Visio objects hierarchy.
getDisplayText()Get the text displayed on the interface
getEvent()Contains elements that specify formulas that control shape events.
getFields()Contains a collection of Field elements.
getFill()Contains the current fill formatting values for the shape and the shape’s drop shadow, including pattern, foreground color, and background color.
getFillStyle()StyleSheet from which this shape inherits fill formatting.
getForeign()Contains elements specifying the width and height of an object from another program used in a Microsoft Visio document.
getForeignData()Contains a MIME (Multipurpose Internet Mail Extensions) encoded BLOB of picture data, such as Windows metafile, bitmap, or OLE data.
getGeoms()Contains a collection of Geom elements.
getGroup()Contains elements that control how you add shapes to a group, move members of a group, and select groups.
getHelp()Contains elements specifying the Shape element’s Help file topic and copyright information.
getHyperlinks()Contains a collection of Hyperlink elements.
getID()The unique ID of the element within its parent element.
getImage()Contains the gamma, brightness, contrast, blur, sharpen, denoise, and transparency values for a bitmap.
getInheritChars()Contains the char values for the shape inherit by the master shape.
getInheritFill()Contains the fill formatting values for the shape inherit by the parent style and the master shape.
getInheritGeoms()Contains the Geoms values for the shape inherit by the master shape.
getInheritLine()Contains the line formatting values for the shape inherit by the parent style and the master shape.
getInheritParas()Contains the paras for the shape inherit by the parent style and the master shape.
getInheritProps()Contains the props for the shape inherit by the master shape.
getInheritTextBlock()Contains the textblock values for the shape inherit by the parent style and the master shape.
getInheritUsers()Contains the users for the shape inherit by the master shape.
getLayerMem()Contains the LayerMember element, which specifies each layer to which the shape is assigned.
getLayout()Contains elements that control shape placement and connector routing settings.
getLine()Contains elements that control line attributes for a shape, such as pattern, weight, and color.
getLineStyle()StyleSheet from which this shape inherits line formatting
getMaster()The Master from which the shape inherits its data.
getMasterShape()This attribute may only be present in shapes that are members of a group shape, and the group is an instance of a master.
getMisc()Contains elements specifying the Shape element’s Help file topic and copyright information.
getName()The name of the element.
getNameU()The universal name of the element.
getOneD()Determines whether the shape behaves as a one-dimensional (1-D) object.
getPage()Root element of Visio objects hierarchy.
getParas()Contains a collection of Para elements.
getParentShape()Shape’s parent.
getProps()Contains a collection of Prop elements.
getProtection()Locking helps prevent inadvertent changes to the shape but does not prevent Microsoft Visio from resetting values in other circumstances.
getPureText()Get the text string
getRootShape()Returns the top-level shape of an instance if this shape is part of a master instance.
getScratchs()Contains a collection of Scratch elements.
getShapes()Contains a collection of Shape elements.
getSmartTagDefs()Contains a collection of SmartTagDef elements.
getTabsCollection()Contains a collection of Tab elements.
getText()Contains the text of a shape.
getTextBlock()Contains elements that specify the alignment, margins, and default tab stop positions of text in a shape’s text block.
getTextStyle()StyleSheet from which this shape inherits text formatting.
getTextXForm()Contains elements that specify positioning information about a shape’s text block.
getThreeDFormat()Gets the ThreeDFormat.
getTwoD()Determines whether the shape behaves as a two-dimensional (2-D) object.
getType()The type of a shape.
getUniqueID()A GUID (globally unique identifier) assigned to the shape.
getUsers()Contains a collection of User elements.
getXForm()Contains elements specifying general positioning information about a shape.
getXForm1D()Contains x- and y-coordinates of the begin point and end point of a 1-D shape.
getZOrderIndex()Returns the index of a shape in the z-order except the guide shape.
gluedShapes(int flag, String categoryFilter, Shape otherShape)Returns an array that contains the identifiers of the shapes that are glued to a shape.
hashCode()
isConnected(Shape shape)Indicates whether this two shapes are connected.
isContain(Shape shape)Indicates whether this shape is contain another shape.
isGlued(Shape shape)Indicates whether this two shapes are glued.
isInGroup()Indicates whether this shape is in a group shape.
isIntersect(Shape shape)Indicates whether this shape is intersect another shape.
isTextEmpty()Indicate the shape has text and the text is empty or not.
move(double dX, double dY)Moves shape on the dX and dY inches from current position.
moveTo(double newPinX, double newPinY)Moves shape on new absolute position on the page.
notify()
notifyAll()
refreshData()Refreshes shape’s position including xform ,connection and geom when changing shape’s text or other’s .
replaceText(String text, String replaceText)Replace the text string of a shape .
sendBackward()Moves the shape back one position in the z-order.
sendToBack()Moves the shape to the back of the z-order.
setAngle(double angle)Sets new angle of shape.
setClippingPath(String value)For the description of this property, please see getClippingPath()
setConnectorsType(int type)Set Connectors type
setData1(String value)For the description of this property, please see getData1()
setData2(String value)For the description of this property, please see getData2()
setData3(String value)For the description of this property, please see getData3()
setDel(int value)For the description of this property, please see getDel()
setDiagram(Diagram value)For the description of this property, please see getDiagram()
setEvent(Event value)For the description of this property, please see getEvent()
setFillStyle(StyleSheet value)For the description of this property, please see getFillStyle()
setHeight(double height)Sets new height of shape.
setID(long value)For the description of this property, please see getID()
setLineStyle(StyleSheet value)For the description of this property, please see getLineStyle()
setMaster(Master value)For the description of this property, please see getMaster()
setMasterShape(Shape value)For the description of this property, please see getMasterShape()
setName(String value)For the description of this property, please see getName()
setNameU(String value)For the description of this property, please see getNameU()
setPage(Page value)For the description of this property, please see getPage()
setParentShape(Shape value)For the description of this property, please see getParentShape()
setPresetTheme(int value)Apply a preset theme to this shape
setPresetThemeQuickStyle(int value)Apply a preset theme variant quickstyle to this shape
setPresetThemeStyleMatrics(int styleIndex, int colorIndex)pply a preset theme variant quickstyle to this shape, like theme styles options in shape styles dropdown list
setPresetThemeVariant(int value)Apply a preset theme variant to this shape
setProps(PropCollection value)For the description of this property, please see getProps()
setText(Text value)For the description of this property, please see getText()
setTextStyle(StyleSheet value)For the description of this property, please see getTextStyle()
setTwoD(boolean value)For the description of this property, please see getTwoD()
setType(int value)For the description of this property, please see getType()
setUniqueID(UUID value)For the description of this property, please see getUniqueID()
setWidth(double width)Sets new width of shape.
setXForm(XForm value)For the description of this property, please see getXForm()
setXForm1D(XForm1D value)For the description of this property, please see getXForm1D()
toHTML(InputStream stream, HTMLSaveOptions options)Creates the shape html and saves it to a stream in the specified format.
toHTML(OutputStream stream, HTMLSaveOptions options)Creates the shape html and saves it to a stream in the specified format.
toHTML(String fileName, HTMLSaveOptions options)Creates the html and saves it to a file.
toImage(InputStream stream, ImageSaveOptions options)Creates the shape image and saves it to a stream in the specified format.
toImage(OutputStream stream, ImageSaveOptions options)Creates the shape image and saves it to a stream in the specified format.
toImage(String imageFile, ImageSaveOptions options)Creates the shape image and saves it to a file.
toPdf(InputStream stream)Creates the shape pdf and saves it to a stream.
toPdf(OutputStream stream)Creates the shape pdf and saves it to a stream.
toPdf(String fileName)Saves the shape to a pdf file.
toString()
toSvg(String imageFile, SVGSaveOptions options)Saves the shape to a svg file.
ungroup()Ungroup Shape
wait()
wait(long arg0)
wait(long arg0, int arg1)

Shape()

public Shape()

Constructor.

bringForward()

public void bringForward()

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

bringToFront()

public void bringToFront()

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

centerDrawing()

public void centerDrawing()

Center the shape with respect to the extent of the page

connectedShapes(int flag, String categoryFilter)

public long[] connectedShapes(int flag, String categoryFilter)

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

Parameters:

ParameterTypeDescription
flagintFilters the array of returned shape IDs by the directionality of the connectors. See Remarks for possible valuesAspose.Diagram.ConnectedShapesFlags.
categoryFilterjava.lang.StringFilters the array of returned shape IDs by limiting it to the IDs of shapes that match the specified categoryString.

Returns: long[] - IDs arraylong.

convertToGroup()

public void convertToGroup()

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

copy(Shape source)

public void copy(Shape source)

Parameters:

ParameterTypeDescription
sourceShape

dependsOnShapes()

public long[] dependsOnShapes()

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

Returns: long[] - IDs arraylong.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

getActiveXControl()

public ActiveXControl getActiveXControl()

Gets the ActiveX control.

Returns: ActiveXControl

getActs()

public ActCollection getActs()

Contains a collection of Act elements.

Returns: ActCollection

getAlign()

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.

Returns: Align

getChars()

public CharCollection getChars()

Contains a collection of Char elements.

Returns: CharCollection

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getClippingPath()

public String getClippingPath()

Returns: java.lang.String

getConnectionABCDs()

public ConnectionABCDCollection getConnectionABCDs()

Contains a collection of ConnectionABCD elements.

Returns: ConnectionABCDCollection

getConnections()

public ConnectionCollection getConnections()

Contains a collection of Connection elements.

Returns: ConnectionCollection

getConnectorRule()

public ConnectorRule getConnectorRule()

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

Returns: ConnectorRule - ConnectorRule.

getConnectorsType()

public int getConnectorsType()

Get Connectors type

Returns: int

getControlData()

public byte[] getControlData()

Gets the data of control.

Returns: byte[]

getControls()

public ControlCollection getControls()

Contains a collection of Control elements.

Returns: ControlCollection

getData1()

public String getData1()

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

Returns: java.lang.String

getData2()

public String getData2()

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

Returns: java.lang.String

getData3()

public String getData3()

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

Returns: java.lang.String

getDel()

public int getDel()

A flag indicating whether the element is deleted locally. A value of 1 indicates that the element is deleted locally.

Returns: int

getDiagram()

public Diagram getDiagram()

Root element of Visio objects hierarchy.

Returns: Diagram

getDisplayText()

public String getDisplayText()

Get the text displayed on the interface

Returns: java.lang.String

getEvent()

public Event getEvent()

Contains elements that specify formulas that control shape events.

Returns: Event

getFields()

public FieldCollection getFields()

Contains a collection of Field elements.

Returns: FieldCollection

getFill()

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.

Returns: Fill

getFillStyle()

public StyleSheet getFillStyle()

StyleSheet from which this shape inherits fill formatting.

Returns: StyleSheet

getForeign()

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.

Returns: Foreign

getForeignData()

public ForeignData getForeignData()

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

Returns: ForeignData

getGeoms()

public GeomCollection getGeoms()

Contains a collection of Geom elements.

Returns: GeomCollection

getGroup()

public Group getGroup()

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

Returns: Group

getHelp()

public Help getHelp()

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

Returns: Help

public HyperlinkCollection getHyperlinks()

Contains a collection of Hyperlink elements.

Returns: HyperlinkCollection

getID()

public long getID()

The unique ID of the element within its parent element.

Returns: long

getImage()

public Image getImage()

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

Returns: Image

getInheritChars()

public CharCollection getInheritChars()

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

Returns: CharCollection

getInheritFill()

public Fill getInheritFill()

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

Returns: Fill

getInheritGeoms()

public GeomCollection getInheritGeoms()

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

Returns: GeomCollection

getInheritLine()

public Line getInheritLine()

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

Returns: Line

getInheritParas()

public ParaCollection getInheritParas()

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

Returns: ParaCollection

getInheritProps()

public PropCollection getInheritProps()

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

Returns: PropCollection

getInheritTextBlock()

public TextBlock getInheritTextBlock()

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

Returns: TextBlock

getInheritUsers()

public UserCollection getInheritUsers()

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

Returns: UserCollection

getLayerMem()

public LayerMem getLayerMem()

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

Returns: LayerMem

getLayout()

public Layout getLayout()

Contains elements that control shape placement and connector routing settings.

Returns: Layout

getLine()

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

Returns: Line

getLineStyle()

public StyleSheet getLineStyle()

StyleSheet from which this shape inherits line formatting

Returns: StyleSheet

getMaster()

public Master getMaster()

The Master from which the shape inherits its data.

Returns: Master

getMasterShape()

public Shape getMasterShape()

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.

Returns: Shape

getMisc()

public Misc getMisc()

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

Returns: Misc

getName()

public String getName()

The name of the element.

Returns: java.lang.String

getNameU()

public String getNameU()

The universal name of the element.

Returns: java.lang.String

getOneD()

public boolean getOneD()

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

Returns: boolean

getPage()

public Page getPage()

Root element of Visio objects hierarchy.

Returns: Page

getParas()

public ParaCollection getParas()

Contains a collection of Para elements.

Returns: ParaCollection

getParentShape()

public Shape getParentShape()

Shape’s parent.

Returns: Shape

getProps()

public PropCollection getProps()

Contains a collection of Prop elements.

Returns: PropCollection

getProtection()

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.

Returns: Protection

getPureText()

public String getPureText()

Get the text string

Returns: java.lang.String

getRootShape()

public Shape getRootShape()

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

Returns: Shape

getScratchs()

public ScratchCollection getScratchs()

Contains a collection of Scratch elements.

Returns: ScratchCollection

getShapes()

public ShapeCollection getShapes()

Contains a collection of Shape elements.

Returns: ShapeCollection

getSmartTagDefs()

public SmartTagDefCollection getSmartTagDefs()

Contains a collection of SmartTagDef elements.

Returns: SmartTagDefCollection

getTabsCollection()

public TabsCollection getTabsCollection()

Contains a collection of Tab elements.

Returns: TabsCollection

getText()

public Text getText()

Contains the text of a shape.

Returns: Text

getTextBlock()

public TextBlock getTextBlock()

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

Returns: TextBlock

getTextStyle()

public StyleSheet getTextStyle()

StyleSheet from which this shape inherits text formatting.

Returns: StyleSheet

getTextXForm()

public TextXForm getTextXForm()

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

Returns: TextXForm

getThreeDFormat()

public ThreeDFormat getThreeDFormat()

Gets the ThreeDFormat.

Returns: ThreeDFormat

getTwoD()

public boolean getTwoD()

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

Returns: boolean

getType()

public int getType()

The type of a shape. It may be one of the following values: Group, Shape, Guide, or Foreign.

Returns: int

getUniqueID()

public UUID getUniqueID()

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

Returns: java.util.UUID

getUsers()

public UserCollection getUsers()

Contains a collection of User elements.

Returns: UserCollection

getXForm()

public XForm getXForm()

Contains elements specifying general positioning information about a shape.

Returns: XForm

getXForm1D()

public XForm1D getXForm1D()

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.

Returns: XForm1D

getZOrderIndex()

public int getZOrderIndex()

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

Returns: int

gluedShapes(int flag, String categoryFilter, Shape otherShape)

public long[] gluedShapes(int flag, String categoryFilter, Shape otherShape)

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

Parameters:

ParameterTypeDescription
flagintThe dimensionality and directionality of the connection points of the shapes to return.See Remarks for possible valuesAspose.Diagram.GluedShapesFlags.
categoryFilterjava.lang.StringFilters the array of returned shape IDs by limiting it to the IDs of shapes that match the specified categoryString.
otherShapeShapeOptional: additional shape to which returned shapes must also be glued, can be Shape or null.

Returns: long[] - IDs arraylong.

hashCode()

public native int hashCode()

Returns: int

isConnected(Shape shape)

public boolean isConnected(Shape shape)

Indicates whether this two shapes are connected.

Parameters:

ParameterTypeDescription
shapeShapeshape

Returns: boolean

isContain(Shape shape)

public boolean isContain(Shape shape)

Indicates whether this shape is contain another shape.

Parameters:

ParameterTypeDescription
shapeShape

Returns: boolean

isGlued(Shape shape)

public boolean isGlued(Shape shape)

Indicates whether this two shapes are glued.

Parameters:

ParameterTypeDescription
shapeShapeshape

Returns: boolean

isInGroup()

public boolean isInGroup()

Indicates whether this shape is in a group shape.

Returns: boolean

isIntersect(Shape shape)

public boolean isIntersect(Shape shape)

Indicates whether this shape is intersect another shape.

Parameters:

ParameterTypeDescription
shapeShape

Returns: boolean

isTextEmpty()

public boolean isTextEmpty()

Indicate the shape has text and the text is empty or not.

Returns: boolean

move(double dX, double dY)

public void move(double dX, double dY)

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

Parameters:

ParameterTypeDescription
dXdoubleX offsetdouble.
dYdoubleY offsetdouble.

moveTo(double newPinX, double newPinY)

public void moveTo(double newPinX, double newPinY)

Moves shape on new absolute position on the page.

Parameters:

ParameterTypeDescription
newPinXdoubleNew x-coordinate of the shape’s pin (center of rotation) in relation to the origin of its parent.double.
newPinYdoubleNew y-coordinate of the shape’s pin (center of rotation) in relation to the origin of its parent.double.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

refreshData()

public void refreshData()

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 .

replaceText(String text, String replaceText)

public void replaceText(String text, String replaceText)

Replace the text string of a shape .

Parameters:

ParameterTypeDescription
textjava.lang.String
replaceTextjava.lang.String

sendBackward()

public void sendBackward()

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

sendToBack()

public void sendToBack()

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

setAngle(double angle)

public void setAngle(double angle)

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

Parameters:

ParameterTypeDescription
angledoubleNew angle which unit is radian not degreedouble.

setClippingPath(String value)

public void setClippingPath(String value)

For the description of this property, please see getClippingPath()

Parameters:

ParameterTypeDescription
valuejava.lang.String

setConnectorsType(int type)

public void setConnectorsType(int type)

Set Connectors type

Parameters:

ParameterTypeDescription
typeint

setData1(String value)

public void setData1(String value)

For the description of this property, please see getData1()

Parameters:

ParameterTypeDescription
valuejava.lang.String

setData2(String value)

public void setData2(String value)

For the description of this property, please see getData2()

Parameters:

ParameterTypeDescription
valuejava.lang.String

setData3(String value)

public void setData3(String value)

For the description of this property, please see getData3()

Parameters:

ParameterTypeDescription
valuejava.lang.String

setDel(int value)

public void setDel(int value)

For the description of this property, please see getDel()

Parameters:

ParameterTypeDescription
valueint

setDiagram(Diagram value)

public void setDiagram(Diagram value)

For the description of this property, please see getDiagram()

Parameters:

ParameterTypeDescription
valueDiagram

setEvent(Event value)

public void setEvent(Event value)

For the description of this property, please see getEvent()

Parameters:

ParameterTypeDescription
valueEvent

setFillStyle(StyleSheet value)

public void setFillStyle(StyleSheet value)

For the description of this property, please see getFillStyle()

Parameters:

ParameterTypeDescription
valueStyleSheet

setHeight(double height)

public void setHeight(double height)

Sets new height of shape.

Parameters:

ParameterTypeDescription
heightdoubleNew heightdouble.

setID(long value)

public void setID(long value)

For the description of this property, please see getID()

Parameters:

ParameterTypeDescription
valuelong

setLineStyle(StyleSheet value)

public void setLineStyle(StyleSheet value)

For the description of this property, please see getLineStyle()

Parameters:

ParameterTypeDescription
valueStyleSheet

setMaster(Master value)

public void setMaster(Master value)

For the description of this property, please see getMaster()

Parameters:

ParameterTypeDescription
valueMaster

setMasterShape(Shape value)

public void setMasterShape(Shape value)

For the description of this property, please see getMasterShape()

Parameters:

ParameterTypeDescription
valueShape

setName(String value)

public void setName(String value)

For the description of this property, please see getName()

Parameters:

ParameterTypeDescription
valuejava.lang.String

setNameU(String value)

public void setNameU(String value)

For the description of this property, please see getNameU()

Parameters:

ParameterTypeDescription
valuejava.lang.String

setPage(Page value)

public void setPage(Page value)

For the description of this property, please see getPage()

Parameters:

ParameterTypeDescription
valuePage

setParentShape(Shape value)

public void setParentShape(Shape value)

For the description of this property, please see getParentShape()

Parameters:

ParameterTypeDescription
valueShape

setPresetTheme(int value)

public void setPresetTheme(int value)

Apply a preset theme to this shape

Parameters:

ParameterTypeDescription
valueint

setPresetThemeQuickStyle(int value)

public void setPresetThemeQuickStyle(int value)

Apply a preset theme variant quickstyle to this shape

Parameters:

ParameterTypeDescription
valueint

setPresetThemeStyleMatrics(int styleIndex, int colorIndex)

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:

ParameterTypeDescription
styleIndexintthe row of style matrics
colorIndexintthe column of style matrics

setPresetThemeVariant(int value)

public void setPresetThemeVariant(int value)

Apply a preset theme variant to this shape

Parameters:

ParameterTypeDescription
valueint

setProps(PropCollection value)

public void setProps(PropCollection value)

For the description of this property, please see getProps()

Parameters:

ParameterTypeDescription
valuePropCollection

setText(Text value)

public void setText(Text value)

For the description of this property, please see getText()

Parameters:

ParameterTypeDescription
valueText

setTextStyle(StyleSheet value)

public void setTextStyle(StyleSheet value)

For the description of this property, please see getTextStyle()

Parameters:

ParameterTypeDescription
valueStyleSheet

setTwoD(boolean value)

public void setTwoD(boolean value)

For the description of this property, please see getTwoD()

Parameters:

ParameterTypeDescription
valueboolean

setType(int value)

public void setType(int value)

For the description of this property, please see getType()

Parameters:

ParameterTypeDescription
valueint

setUniqueID(UUID value)

public void setUniqueID(UUID value)

For the description of this property, please see getUniqueID()

Parameters:

ParameterTypeDescription
valuejava.util.UUID

setWidth(double width)

public void setWidth(double width)

Sets new width of shape.

Parameters:

ParameterTypeDescription
widthdoubleNew widthdouble.

setXForm(XForm value)

public void setXForm(XForm value)

For the description of this property, please see getXForm()

Parameters:

ParameterTypeDescription
valueXForm

setXForm1D(XForm1D value)

public void setXForm1D(XForm1D value)

For the description of this property, please see getXForm1D()

Parameters:

ParameterTypeDescription
valueXForm1D

toHTML(InputStream stream, HTMLSaveOptions options)

public void toHTML(InputStream stream, HTMLSaveOptions options)

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

Parameters:

ParameterTypeDescription
streamjava.io.InputStreamThe output stream.
optionsHTMLSaveOptionsAddtional html creation options

toHTML(OutputStream stream, HTMLSaveOptions options)

public void toHTML(OutputStream stream, HTMLSaveOptions options)

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

Parameters:

ParameterTypeDescription
streamjava.io.OutputStreamThe output stream.
optionsHTMLSaveOptionsAddtional html creation options

toHTML(String fileName, HTMLSaveOptions options)

public void toHTML(String fileName, HTMLSaveOptions options)

Creates the html and saves it to a file.

Parameters:

ParameterTypeDescription
fileNamejava.lang.String
optionsHTMLSaveOptionshtml save options

toImage(InputStream stream, ImageSaveOptions options)

public void toImage(InputStream stream, ImageSaveOptions options)

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

Parameters:

ParameterTypeDescription
streamjava.io.InputStreamThe output stream.
optionsImageSaveOptionsAdditional image creation options

toImage(OutputStream stream, ImageSaveOptions options)

public void toImage(OutputStream stream, ImageSaveOptions options)

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

Parameters:

ParameterTypeDescription
streamjava.io.OutputStreamThe output stream.
optionsImageSaveOptionsAdditional image creation options

toImage(String imageFile, ImageSaveOptions options)

public void toImage(String imageFile, ImageSaveOptions options)

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:

ParameterTypeDescription
imageFilejava.lang.StringThe image file name with full path.
optionsImageSaveOptionsAdditional image creation options

toPdf(InputStream stream)

public void toPdf(InputStream stream)

Creates the shape pdf and saves it to a stream.

Parameters:

ParameterTypeDescription
streamjava.io.InputStreamThe output stream.

toPdf(OutputStream stream)

public void toPdf(OutputStream stream)

Creates the shape pdf and saves it to a stream.

Parameters:

ParameterTypeDescription
streamjava.io.OutputStreamThe output stream.

toPdf(String fileName)

public void toPdf(String fileName)

Saves the shape to a pdf file.

Parameters:

ParameterTypeDescription
fileNamejava.lang.Stringthe pdf file name with full path

toString()

public String toString()

Returns: java.lang.String

toSvg(String imageFile, SVGSaveOptions options)

public void toSvg(String imageFile, SVGSaveOptions options)

Saves the shape to a svg file.

Parameters:

ParameterTypeDescription
imageFilejava.lang.String
optionsSVGSaveOptions

ungroup()

public void ungroup()

Ungroup Shape

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int