ConnectorShape Class

A connector shape.

Declaration

public class ConnectorShape extends SimpleShape

Inherited Members

notifyChange(Object sender, String propertyName)

setAlternativeText(String value)

setDecorative(boolean value)

setHeight(float value)

setName(String value)

setWidth(float value)

setEffects(ShapeEffectProperties value)

setFlipType(FlipType value)

setRotationAngle(float value)

setStyle(ShapeStyle value)

com.devexpress.system.JavaObject.clone()

com.devexpress.system.JavaObject.equals(java.lang.Object)

com.devexpress.system.JavaObject.hashCode()

com.devexpress.system.JavaObject.memberwiseClone()

com.devexpress.system.JavaObject.toString()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

JavaObject

ConnectorShape

Constructors

ConnectorShape() Constructor

A connector shape.

Declaration

public ConnectorShape()

ConnectorShape(FilledShape startShape, FilledShape endShape, ConnectorShapeType type) Constructor

Initializes a new instance of the ConnectorShape class with specified settings.

Declaration

public ConnectorShape(FilledShape startShape, FilledShape endShape, ConnectorShapeType type)

Parameters

Name	Type	Description
startShape	FilledShape	The shape to which the connector start point is attached.
endShape	FilledShape	The shape to which the connector end point is attached.
type	ConnectorShapeType	The connector shape type.

ConnectorShape(FilledShape startShape, FilledShape endShape) Constructor

Initializes a new instance of the ConnectorShape class with specified settings.

Declaration

public ConnectorShape(FilledShape startShape, FilledShape endShape)

Parameters

Name	Type	Description
startShape	FilledShape	The shape to which the connector start point is attached.
endShape	FilledShape	The shape to which the connector end point is attached.

Methods

deepClone() Method

Clones the current ConnectorShape instance.

Declaration

public ConnectorShape deepClone()

Returns

Type	Description
`ConnectorShape`	The cloned `ConnectorShape` instance.

getEndShape() Method

Returns the end shape to which the connector is attached.

Declaration

public FilledShape getEndShape()

Returns

Type	Description
FilledShape	The end shape to which the connector is attached.

Remarks

Call the getStartShape() method to access the start shape to which the connector is attached.

getEndShapeSiteIndex() Method

Returns the index of the connection point on the end shape to which the connector is attached.

Declaration

public int getEndShapeSiteIndex()

Returns

Type	Description
int	A zero-based index that increases counterclockwise.

getLockSettings() Method

Returns shape lock settings. Lock settings restrict user operations or hide certain visual elements.

Declaration

public ConnectorLockSettings getLockSettings()

Returns

Type	Description
ConnectorLockSettings	Contains lock settings.

getOutline() Method

Returns settings that are used to draw the connector.

Declaration

public LineStyle getOutline()

Returns

Type	Description
LineStyle	Line style settings.

getStartShape() Method

Returns the start shape to which the connector is attached.

Declaration

public FilledShape getStartShape()

Returns

Type	Description
FilledShape	The start shape to which the connector is attached.

Remarks

Call the getEndShape() method to access the end shape to which the connector is attached.

getStartShapeSiteIndex() Method

Returns the index of the connection point on the start shape to which the connector is attached.

Declaration

public int getStartShapeSiteIndex()

Returns

Type	Description
int	A zero-based index.

Remarks

The index starts with the top side (0) and increases counterclockwise. Use the ShapeGeometry.getConnectionSites() method to get the number of connection sites for the current shape.

getType() Method

Returns the connector shape type.

Declaration

public ConnectorShapeType getType()

Returns

Type	Description
ConnectorShapeType	The connector shape type.

Remarks

When changing connector settings, the connector type may be automatically simplified (the number of handles may be reduced) depending on the positions of the start and end shapes and their connection sites. For example, a curved connector with three handles might be converted to one with a single handle.

setEndShape(FilledShape value) Method

Sets the end shape to which the connector is attached.

Declaration

public void setEndShape(FilledShape value)

Parameters

Name	Type	Description
value	FilledShape	The end shape to which the connector is attached.

setEndShapeSiteIndex(int value) Method

Sets the index of the connection point on the end shape to which the connector is attached.

Declaration

public void setEndShapeSiteIndex(int value)

Parameters

Name	Type	Description
value	int	A zero-based index.

Remarks

The index starts with the top side (0) and increases counterclockwise. Call the ShapeGeometry.getConnectionSites() method to get the number of connection sites for the current shape.

setOutline(LineStyle value) Method

Sets the settings that are used to draw the connector.

Declaration

public void setOutline(LineStyle value)

Parameters

Name	Type	Description
value	LineStyle	Line style settings.

setStartShape(FilledShape value) Method

Sets the start shape to which the connector is attached.

Declaration

public void setStartShape(FilledShape value)

Parameters

Name	Type	Description
value	FilledShape	The start shape to which the connector is attached.

setStartShapeSiteIndex(int value) Method

Sets the index of the connection point on the start shape to which the connector is attached.

Declaration

public void setStartShapeSiteIndex(int value)

Parameters

Name	Type	Description
value	int	A zero-based index.

Remarks

The index starts with the top side (0) and increases counterclockwise. Call the ShapeGeometry.getConnectionSites() method to get the number of connection sites for the current shape.

setType(ConnectorShapeType value) Method

Sets the connector shape type.

Declaration

public void setType(ConnectorShapeType value)

Parameters

Name	Type	Description
value	ConnectorShapeType	The connector shape type.