com.mindoo.remote.api.symphony.presentation
Interface IRemoteConnectorShape

All Superinterfaces:

IRemoteShape

public interface IRemoteConnectorShape
extends IRemoteShape

This class is the subclass of Shape class, and it represents a connector shape in a page.

Creation and access

• To get a connector shape of a page, use the itemByType method in the Shapes class.
• To create a connector shape, use the addConnector method and addConnectorByPosition method in the Shapes class.

Field Summary

static java.lang.String	ARROW_STYLE_ARROW
static java.lang.String	ARROW_STYLE_ARROW_CONCAVE
static java.lang.String	ARROW_STYLE_CIRCLE
static java.lang.String	ARROW_STYLE_DIMENSION_LINES
static java.lang.String	ARROW_STYLE_DOUBLE_ARROW
static java.lang.String	ARROW_STYLE_LINE_ARROW
static java.lang.String	ARROW_STYLE_ROUNDED_LARGE_ARROW
static java.lang.String	ARROW_STYLE_ROUNDED_SHORT_ARROW
static java.lang.String	ARROW_STYLE_SMALL_ARROW
static java.lang.String	ARROW_STYLE_SQUARE
static java.lang.String	ARROW_STYLE_SQUARE_45
static java.lang.String	ARROW_STYLE_SYMMETRIC_ARROW
static int	CONNECTORTYPE_CURVE specifies that the connector is drawn as a curve.
static int	CONNECTORTYPE_LINE specifies that the connector is drawn with three lines.
static int	CONNECTORTYPE_STANDARD specifies that the connector is drawn with three lines, with the middle line perpendicular to the other two.
static int	CONNECTORTYPE_STRAIGHT specifies that the connector is drawn as a straight line.
static int	POSITION_BOTTOM specifies the middle bottom of the shape.
static int	POSITION_DEFAULT specifies the favorite position.
static int	POSITION_LEFT specifies the middle left of the shape.
static int	POSITION_RIGHT specifies middle right of the shape.
static int	POSITION_TOP specifies middle top of the shape.

Method Summary

int	getBeginPosition() This property returns or sets the anchor on the source shape of the connector shape.
IRemoteShape	getBeginShape() Gets the source shape of the connector
int	getBeginX() This property returns or sets the X coordinate of the original point of the connector in 1/100th mm.
int	getBeginY() This property returns or sets the Y coordinate of the original point of the connector in 1/100th mm.
int	getConnectorType() This property returns or sets the type of the connector.
int	getEndPosition() This property returns or sets the anchor on the target shape of the connector shape.
IRemoteShape	getEndShape() Gets the target shape of the connector
int	getEndX() This property returns or sets the X coordinate of the end point of the connector in 1/100th mm.
int	getEndY() This property returns or sets the Y coordinate of the end point of the connector in 1/100th mm.
boolean	hasBeginShape() This property returns whether the connector has a source shape.
boolean	hasEndShape() This property returns whether the connector has a target shape.
void	setBeginPosition(int position) This property returns or sets the anchor on the source shape of the connector shape.
void	setBeginShape(IRemoteShape shape) This method sets the source shape of the connector.
void	setBeginShape(IRemoteShape shape, int position) This method sets the source shape of the connector.
void	setBeginStyle(java.lang.String lineStartName) This method sets the beginning style of the connector.
void	setBeginStyle(java.lang.String lineStartName, int width) This method sets the beginning style of the connector.
void	setBeginX(int beginX) This property returns or sets the X coordinate of the original point of the connector in 1/100th mm.
void	setBeginY(int beginY) This property returns or sets the Y coordinate of the original point of the connector in 1/100th mm.
void	setConnectorType(int type) This property returns or sets the type of the connector.
void	setEndPosition(int position) This property returns or sets the anchor on the target shape of the connector shape.
void	setEndShape(IRemoteShape shape) This method sets the target shape of the connector.
void	setEndShape(IRemoteShape shape, int position) This method sets the target shape of the connector.
void	setEndStyle(java.lang.String lineEndName) This method sets the ending style of the connector.
void	setEndStyle(java.lang.String lineEndName, int width) This method sets the ending style of the connector.
void	setEndX(int endX) This property returns or sets the X coordinate of the end point of the connector in 1/100th mm.
void	setEndY(int endY) This property returns or sets the Y coordinate of the end point of the connector in 1/100th mm.

Methods inherited from interface com.mindoo.remote.api.symphony.presentation.IRemoteShape

copy, cut, exportToImage, getApplication, getAttributes, getContent, getFillFormat, getHeight, getLeft, getLineFormat, getMoveProtect, getName, getParagraphs, getRotateAngle, getShadowFormat, getShearAngle, getSizeProtect, getTop, getType, getWidth, getZOrder, isShadowEnable, remove, setHeight, setLeft, setMoveProtect, setName, setRotateAngle, setShadowEnable, setShearAngle, setSizeProtect, setTop, setWidth, setZOrder

Field Detail

ARROW_STYLE_ARROW

static final java.lang.String ARROW_STYLE_ARROW

See Also:

Constant Field Values

ARROW_STYLE_SQUARE

static final java.lang.String ARROW_STYLE_SQUARE

See Also:

Constant Field Values

ARROW_STYLE_SMALL_ARROW

static final java.lang.String ARROW_STYLE_SMALL_ARROW

See Also:

Constant Field Values

ARROW_STYLE_DIMENSION_LINES

static final java.lang.String ARROW_STYLE_DIMENSION_LINES

See Also:

Constant Field Values

ARROW_STYLE_DOUBLE_ARROW

static final java.lang.String ARROW_STYLE_DOUBLE_ARROW

See Also:

Constant Field Values

ARROW_STYLE_ROUNDED_SHORT_ARROW

static final java.lang.String ARROW_STYLE_ROUNDED_SHORT_ARROW

See Also:

Constant Field Values

ARROW_STYLE_SYMMETRIC_ARROW

static final java.lang.String ARROW_STYLE_SYMMETRIC_ARROW

See Also:

Constant Field Values

ARROW_STYLE_LINE_ARROW

static final java.lang.String ARROW_STYLE_LINE_ARROW

See Also:

Constant Field Values

ARROW_STYLE_ROUNDED_LARGE_ARROW

static final java.lang.String ARROW_STYLE_ROUNDED_LARGE_ARROW

See Also:

Constant Field Values

ARROW_STYLE_CIRCLE

static final java.lang.String ARROW_STYLE_CIRCLE

See Also:

Constant Field Values

ARROW_STYLE_SQUARE_45

static final java.lang.String ARROW_STYLE_SQUARE_45

See Also:

Constant Field Values

ARROW_STYLE_ARROW_CONCAVE

static final java.lang.String ARROW_STYLE_ARROW_CONCAVE

See Also:

Constant Field Values

CONNECTORTYPE_STANDARD

static final int CONNECTORTYPE_STANDARD

specifies that the connector is drawn with three lines, with the middle line perpendicular to the other two.

See Also:

Constant Field Values

CONNECTORTYPE_CURVE

static final int CONNECTORTYPE_CURVE

specifies that the connector is drawn as a curve.

See Also:

Constant Field Values

CONNECTORTYPE_STRAIGHT

static final int CONNECTORTYPE_STRAIGHT

specifies that the connector is drawn as a straight line.

See Also:

Constant Field Values

CONNECTORTYPE_LINE

static final int CONNECTORTYPE_LINE

specifies that the connector is drawn with three lines.

See Also:

Constant Field Values

POSITION_DEFAULT

static final int POSITION_DEFAULT

specifies the favorite position.

See Also:

Constant Field Values

POSITION_TOP

static final int POSITION_TOP

specifies middle top of the shape.

See Also:

Constant Field Values

POSITION_RIGHT

static final int POSITION_RIGHT

specifies middle right of the shape.

See Also:

Constant Field Values

POSITION_BOTTOM

static final int POSITION_BOTTOM

specifies the middle bottom of the shape.

See Also:

Constant Field Values

POSITION_LEFT

static final int POSITION_LEFT

specifies the middle left of the shape.

See Also:

Constant Field Values

Method Detail

setBeginPosition

void setBeginPosition(int position)
                      throws RemoteEclipseAPIException

This property returns or sets the anchor on the source shape of the connector shape.

Legal values

Constant	Value	Description
ConnectorShape.POSITION_DEFAULT	-1	specifies the favorite position.
ConnectorShape.POSITION_TOP	0	specifies middle top of the shape.
ConnectorShape.POSITION_RIGHT	1	specifies middle right of the shape.
ConnectorShape.POSITION_BOTTOM	2	specifies the middle bottom of the shape.
ConnectorShape.POSITION_LEFT	3	specifies the middle left of the shape.

Parameters:

position -

Throws:

RemoteEclipseAPIException

setEndPosition

void setEndPosition(int position)
                    throws RemoteEclipseAPIException

This property returns or sets the anchor on the target shape of the connector shape.

Legal values

Constant	Value	Description
ConnectorShape.POSITION_DEFAULT	-1	specifies the favorite position.
ConnectorShape.POSITION_TOP	0	specifies middle top of the shape.
ConnectorShape.POSITION_RIGHT	1	specifies middle right of the shape.
ConnectorShape.POSITION_BOTTOM	2	specifies the middle bottom of the shape.
ConnectorShape.POSITION_LEFT	3	specifies the middle left of the shape.

Parameters:

position -

Throws:

RemoteEclipseAPIException

getEndPosition

int getEndPosition()
                   throws RemoteEclipseAPIException

This property returns or sets the anchor on the target shape of the connector shape.

Legal values

Constant	Value	Description
ConnectorShape.POSITION_DEFAULT	-1	specifies the favorite position.
ConnectorShape.POSITION_TOP	0	specifies middle top of the shape.
ConnectorShape.POSITION_RIGHT	1	specifies middle right of the shape.
ConnectorShape.POSITION_BOTTOM	2	specifies the middle bottom of the shape.
ConnectorShape.POSITION_LEFT	3	specifies the middle left of the shape.

Returns:

position

Throws:

RemoteEclipseAPIException

getBeginPosition

int getBeginPosition()
                     throws RemoteEclipseAPIException

This property returns or sets the anchor on the source shape of the connector shape.

Legal values

Constant	Value	Description
ConnectorShape.POSITION_DEFAULT	-1	specifies the favorite position.
ConnectorShape.POSITION_TOP	0	specifies middle top of the shape.
ConnectorShape.POSITION_RIGHT	1	specifies middle right of the shape.
ConnectorShape.POSITION_BOTTOM	2	specifies the middle bottom of the shape.
ConnectorShape.POSITION_LEFT	3	specifies the middle left of the shape.

Returns:

position

Throws:

RemoteEclipseAPIException

getConnectorType

int getConnectorType()
                     throws RemoteEclipseAPIException

This property returns or sets the type of the connector.

Constant	Value	Description
ConnectorShape.CONNECTORTYPE_STANDARD	0	specifies that the connector is drawn with three lines, with the middle line perpendicular to the other two.
ConnectorShape.CONNECTORTYPE_CURVE	1	specifies that the connector is drawn as a curve.
ConnectorShape.CONNECTORTYPE_STRAIGHT	2	specifies that the connector is drawn as a straight line.
ConnectorShape.CONNECTORTYPE_LINE	3	specifies that the connector is drawn with three lines.

Returns:

type

Throws:

RemoteEclipseAPIException

setConnectorType

void setConnectorType(int type)
                      throws RemoteEclipseAPIException

This property returns or sets the type of the connector.

Constant	Value	Description
ConnectorShape.CONNECTORTYPE_STANDARD	0	specifies that the connector is drawn with three lines, with the middle line perpendicular to the other two.
ConnectorShape.CONNECTORTYPE_CURVE	1	specifies that the connector is drawn as a curve.
ConnectorShape.CONNECTORTYPE_STRAIGHT	2	specifies that the connector is drawn as a straight line.
ConnectorShape.CONNECTORTYPE_LINE	3	specifies that the connector is drawn with three lines.

Parameters:

type -

Throws:

RemoteEclipseAPIException

hasBeginShape

boolean hasBeginShape()
                      throws RemoteEclipseAPIException

This property returns whether the connector has a source shape.

Returns:

true, when the connector has a source shape.

Throws:

RemoteEclipseAPIException

setBeginShape

void setBeginShape(IRemoteShape shape,
                   int position)
                   throws RemoteEclipseAPIException

This method sets the source shape of the connector. After this method is called, the Left and Top properties of the connector change to read-only.

Legal values

Parameters:

shape - Specifies the source shape.

position - Specifies the anchor on the source shape. The anchor is a constant and can be one of these values:

Constant	Value	Description
ConnectorShape.POSITION_DEFAULT	-1	specifies the favorite position.
ConnectorShape.POSITION_TOP	0	specifies middle top of the shape.
ConnectorShape.POSITION_RIGHT	1	specifies middle right of the shape.
ConnectorShape.POSITION_BOTTOM	2	specifies the middle bottom of the shape.
ConnectorShape.POSITION_LEFT	3	specifies the middle left of the shape.

Throws:

RemoteEclipseAPIException

setBeginShape

void setBeginShape(IRemoteShape shape)
                   throws RemoteEclipseAPIException

This method sets the source shape of the connector. After this method is called, the Left and Top properties of the connector change to read-only.

Legal values

Parameters:

shape - Specifies the source shape.

Throws:

RemoteEclipseAPIException

hasEndShape

boolean hasEndShape()
                    throws RemoteEclipseAPIException

This property returns whether the connector has a target shape.

Returns:

true, when the connector has a target shape.

Throws:

RemoteEclipseAPIException

getBeginShape

IRemoteShape getBeginShape()
                           throws RemoteEclipseAPIException

Gets the source shape of the connector

Returns:

shape

Throws:

RemoteEclipseAPIException

getEndShape

IRemoteShape getEndShape()
                         throws RemoteEclipseAPIException

Gets the target shape of the connector

Returns:

shape

Throws:

RemoteEclipseAPIException

setEndShape

void setEndShape(IRemoteShape shape,
                 int position)
                 throws RemoteEclipseAPIException

This method sets the target shape of the connector. After this method is called, the Height and Width properties of the connector change to read-only.

Parameters:

shape - Specifies the source shape.

position - Specifies the anchor on the source shape. The anchor is a constant and can be one of these values:

Constant	Value	Description
ConnectorShape.POSITION_DEFAULT	-1	specifies the favorite position.
ConnectorShape.POSITION_TOP	0	specifies middle top of the shape.
ConnectorShape.POSITION_RIGHT	1	specifies middle right of the shape.
ConnectorShape.POSITION_BOTTOM	2	specifies the middle bottom of the shape.
ConnectorShape.POSITION_LEFT	3	specifies the middle left of the shape.

Throws:

RemoteEclipseAPIException

setEndShape

void setEndShape(IRemoteShape shape)
                 throws RemoteEclipseAPIException

This method sets the target shape of the connector. After this method is called, the Height and Width properties of the connector change to read-only.

Parameters:

shape - Specifies the source shape.

Throws:

RemoteEclipseAPIException

setBeginStyle

void setBeginStyle(java.lang.String lineStartName,
                   int width)
                   throws RemoteEclipseAPIException

This method sets the beginning style of the connector.

If the style name is undefined or the width is negative, this method throws an exception.

Parameters:

lineStartName - Specifies the style name. The style is a constant and can be one of these values:

Constant	Value	Description
ConnectorShape.ARROW_STYLE_ARROW	"Arrow"
ConnectorShape.ARROW_STYLE_SQUARE	"Square"
ConnectorShape.ARROW_STYLE_SMALL_ARROW	"Small Arrow"
ConnectorShape.ARROW_STYLE_DIMENSION_LINES	"Dimension Lines"
ConnectorShape.ARROW_STYLE_DOUBLE_ARROW	"Double Arrow"
ConnectorShape.ARROW_STYLE_ROUNDED_SHORT_ARROW	"Round Short Arrow"
ConnectorShape.ARROW_STYLE_SYMMETRIC_ARROW	"Symmetric Arrow"
ConnectorShape.ARROW_STYLE_LINE_ARROW	"Line Arrow"
ConnectorShape.ARROW_STYLE_ROUNDED_LARGE_ARROW	"Round Large Arrow"
ConnectorShape.ARROW_STYLE_CIRCLE	"Circle"
ConnectorShape.ARROW_STYLE_SQUARE_45	"Square 45"
ConnectorShape.ARROW_STYLE_ARROW_CONCAVE	"Arrow Concave"

width - Specifies the width of the end style in 1/100 mm. *

Throws:

RemoteEclipseAPIException

setEndStyle

void setEndStyle(java.lang.String lineEndName,
                 int width)
                 throws RemoteEclipseAPIException

This method sets the ending style of the connector.

If the style name is undefined or the width is negative, this method throws an exception.

Parameters:

lineEndName - Specifies the style name. The style is a constant and can be one of these values:

Constant	Value	Description
ConnectorShape.ARROW_STYLE_ARROW	"Arrow"
ConnectorShape.ARROW_STYLE_SQUARE	"Square"
ConnectorShape.ARROW_STYLE_SMALL_ARROW	"Small Arrow"
ConnectorShape.ARROW_STYLE_DIMENSION_LINES	"Dimension Lines"
ConnectorShape.ARROW_STYLE_DOUBLE_ARROW	"Double Arrow"
ConnectorShape.ARROW_STYLE_ROUNDED_SHORT_ARROW	"Round Short Arrow"
ConnectorShape.ARROW_STYLE_SYMMETRIC_ARROW	"Symmetric Arrow"
ConnectorShape.ARROW_STYLE_LINE_ARROW	"Line Arrow"
ConnectorShape.ARROW_STYLE_ROUNDED_LARGE_ARROW	"Round Large Arrow"
ConnectorShape.ARROW_STYLE_CIRCLE	"Circle"
ConnectorShape.ARROW_STYLE_SQUARE_45	"Square 45"
ConnectorShape.ARROW_STYLE_ARROW_CONCAVE	"Arrow Concave"

width - Specifies the width of the end style in 1/100 mm.

Throws:

RemoteEclipseAPIException

setBeginStyle

void setBeginStyle(java.lang.String lineStartName)
                   throws RemoteEclipseAPIException

This method sets the beginning style of the connector.

If the style name is undefined or the width is negative, this method throws an exception.

Parameters:

lineStartName - Specifies the style name. The style is a constant and can be one of these values:

Constant	Value	Description
ConnectorShape.ARROW_STYLE_ARROW	"Arrow"
ConnectorShape.ARROW_STYLE_SQUARE	"Square"
ConnectorShape.ARROW_STYLE_SMALL_ARROW	"Small Arrow"
ConnectorShape.ARROW_STYLE_DIMENSION_LINES	"Dimension Lines"
ConnectorShape.ARROW_STYLE_DOUBLE_ARROW	"Double Arrow"
ConnectorShape.ARROW_STYLE_ROUNDED_SHORT_ARROW	"Round Short Arrow"
ConnectorShape.ARROW_STYLE_SYMMETRIC_ARROW	"Symmetric Arrow"
ConnectorShape.ARROW_STYLE_LINE_ARROW	"Line Arrow"
ConnectorShape.ARROW_STYLE_ROUNDED_LARGE_ARROW	"Round Large Arrow"
ConnectorShape.ARROW_STYLE_CIRCLE	"Circle"
ConnectorShape.ARROW_STYLE_SQUARE_45	"Square 45"
ConnectorShape.ARROW_STYLE_ARROW_CONCAVE	"Arrow Concave"

Throws:

RemoteEclipseAPIException

setEndStyle

void setEndStyle(java.lang.String lineEndName)
                 throws RemoteEclipseAPIException

This method sets the ending style of the connector.

If the style name is undefined or the width is negative, this method throws an exception.

Parameters:

lineEndName - Specifies the style name. The style is a constant and can be one of these values:

Constant	Value	Description
ConnectorShape.ARROW_STYLE_ARROW	"Arrow"
ConnectorShape.ARROW_STYLE_SQUARE	"Square"
ConnectorShape.ARROW_STYLE_SMALL_ARROW	"Small Arrow"
ConnectorShape.ARROW_STYLE_DIMENSION_LINES	"Dimension Lines"
ConnectorShape.ARROW_STYLE_DOUBLE_ARROW	"Double Arrow"
ConnectorShape.ARROW_STYLE_ROUNDED_SHORT_ARROW	"Round Short Arrow"
ConnectorShape.ARROW_STYLE_SYMMETRIC_ARROW	"Symmetric Arrow"
ConnectorShape.ARROW_STYLE_LINE_ARROW	"Line Arrow"
ConnectorShape.ARROW_STYLE_ROUNDED_LARGE_ARROW	"Round Large Arrow"
ConnectorShape.ARROW_STYLE_CIRCLE	"Circle"
ConnectorShape.ARROW_STYLE_SQUARE_45	"Square 45"
ConnectorShape.ARROW_STYLE_ARROW_CONCAVE	"Arrow Concave"

Throws:

RemoteEclipseAPIException

getBeginX

int getBeginX()
              throws RemoteEclipseAPIException

This property returns or sets the X coordinate of the original point of the connector in 1/100th mm.

Returns:

x

Throws:

RemoteEclipseAPIException

setBeginX

void setBeginX(int beginX)
               throws RemoteEclipseAPIException

This property returns or sets the X coordinate of the original point of the connector in 1/100th mm.

Parameters:

beginX - x

Throws:

RemoteEclipseAPIException

getBeginY

int getBeginY()
              throws RemoteEclipseAPIException

This property returns or sets the Y coordinate of the original point of the connector in 1/100th mm.

Returns:

y

Throws:

RemoteEclipseAPIException

setBeginY

void setBeginY(int beginY)
               throws RemoteEclipseAPIException

This property returns or sets the Y coordinate of the original point of the connector in 1/100th mm.

Parameters:

beginY - y

Throws:

RemoteEclipseAPIException

getEndX

int getEndX()
            throws RemoteEclipseAPIException

This property returns or sets the X coordinate of the end point of the connector in 1/100th mm.

Returns:

x

Throws:

RemoteEclipseAPIException

setEndX

void setEndX(int endX)
             throws RemoteEclipseAPIException

This property returns or sets the X coordinate of the end point of the connector in 1/100th mm.

Parameters:

endX - x

Throws:

RemoteEclipseAPIException

getEndY

int getEndY()
            throws RemoteEclipseAPIException

This property returns or sets the Y coordinate of the end point of the connector in 1/100th mm.

Returns:

y

Throws:

RemoteEclipseAPIException

setEndY

void setEndY(int endY)
             throws RemoteEclipseAPIException

This property returns or sets the Y coordinate of the end point of the connector in 1/100th mm.

Parameters:

endY - y

Throws:

RemoteEclipseAPIException