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

All Superinterfaces:

IRemoteShape

public interface IRemoteLineShape
extends IRemoteShape

This class is a subclass of the Shape class, and it represents a line shape on a page.

Creation and access

• To get a line shape of a page, use the itemByType method in the Shapes class.
• To create a line shape, use the addLine 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

Method Summary

int	getBeginX() This property returns or sets the X coordinate of the original point of a line in 1/100th mm.
int	getBeginY() This property returns or sets the Y coordinate of the original point of a line in 1/100th mm.
int	getEndX() This property returns or sets the X coordinate of the end point of a line in 1/100th mm.
int	getEndY() This property returns or sets the Y coordinate of the end point of a line in 1/100th mm.
void	setBeginStyle(java.lang.String lineStartName) This method sets the beginning style of a line.
void	setBeginStyle(java.lang.String lineStartName, int width) This method sets the beginning style of a line.
void	setBeginX(int beginX) This property returns or sets the X coordinate of the original point of a line in 1/100th mm.
void	setBeginY(int beginY) This property returns or sets the Y coordinate of the original point of a line in 1/100th mm.
void	setEndStyle(java.lang.String lineEndName) This method sets the ending style of a line.
void	setEndStyle(java.lang.String lineEndName, int width) This method sets the ending style of a line.
void	setEndX(int endX) This property returns or sets the X coordinate of the end point of a line in 1/100th mm.
void	setEndY(int endY) This property returns or sets the Y coordinate of the end point of a line 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

Method Detail

setBeginStyle

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

This method sets the beginning style of a line.

Parameters:

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

Constant	Value	Description
LineShape.ARROW_STYLE_ARROW	"Arrow"
LineShape.ARROW_STYLE_SQUARE	"Square"
LineShape.ARROW_STYLE_SMALL_ARROW	"Small Arrow"
LineShape.ARROW_STYLE_DIMENSION_LINES	"Dimension Lines"
LineShape.ARROW_STYLE_DOUBLE_ARROW	"Double Arrow"
LineShape.ARROW_STYLE_ROUNDED_SHORT_ARROW	"Rounded short Arrow"
LineShape.ARROW_STYLE_SYMMETRIC_ARROW	"Symmetric Arrow"
LineShape.ARROW_STYLE_LINE_ARROW	"Line Arrow"
LineShape.ARROW_STYLE_ROUNDED_LARGE_ARROW	"Rounded large Arrow"
LineShape.ARROW_STYLE_CIRCLE	"Circle"
LineShape.ARROW_STYLE_SQUARE_45	"Square 45"
LineShape.ARROW_STYLE_ARROW_CONCAVE	"Arrow concave"

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

Throws:

RemoteEclipseAPIException

setEndStyle

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

This method sets the ending style of a line.

Parameters:

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

Constant	Value	Description
LineShape.ARROW_STYLE_ARROW	"Arrow"
LineShape.ARROW_STYLE_SQUARE	"Square"
LineShape.ARROW_STYLE_SMALL_ARROW	"Small Arrow"
LineShape.ARROW_STYLE_DIMENSION_LINES	"Dimension Lines"
LineShape.ARROW_STYLE_DOUBLE_ARROW	"Double Arrow"
LineShape.ARROW_STYLE_ROUNDED_SHORT_ARROW	"Rounded short Arrow"
LineShape.ARROW_STYLE_SYMMETRIC_ARROW	"Symmetric Arrow"
LineShape.ARROW_STYLE_LINE_ARROW	"Line Arrow"
LineShape.ARROW_STYLE_ROUNDED_LARGE_ARROW	"Rounded large Arrow"
LineShape.ARROW_STYLE_CIRCLE	"Circle"
LineShape.ARROW_STYLE_SQUARE_45	"Square 45"
LineShape.ARROW_STYLE_ARROW_CONCAVE	"Arrow concave"

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

Throws:

RemoteEclipseAPIException

setBeginStyle

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

This method sets the beginning style of a line.

Parameters:

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

Constant	Value	Description
LineShape.ARROW_STYLE_ARROW	"Arrow"
LineShape.ARROW_STYLE_SQUARE	"Square"
LineShape.ARROW_STYLE_SMALL_ARROW	"Small Arrow"
LineShape.ARROW_STYLE_DIMENSION_LINES	"Dimension Lines"
LineShape.ARROW_STYLE_DOUBLE_ARROW	"Double Arrow"
LineShape.ARROW_STYLE_ROUNDED_SHORT_ARROW	"Rounded short Arrow"
LineShape.ARROW_STYLE_SYMMETRIC_ARROW	"Symmetric Arrow"
LineShape.ARROW_STYLE_LINE_ARROW	"Line Arrow"
LineShape.ARROW_STYLE_ROUNDED_LARGE_ARROW	"Rounded large Arrow"
LineShape.ARROW_STYLE_CIRCLE	"Circle"
LineShape.ARROW_STYLE_SQUARE_45	"Square 45"
LineShape.ARROW_STYLE_ARROW_CONCAVE	"Arrow concave"

Throws:

RemoteEclipseAPIException

setEndStyle

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

This method sets the ending style of a line.

Parameters:

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

Constant	Value	Description
LineShape.ARROW_STYLE_ARROW	"Arrow"
LineShape.ARROW_STYLE_SQUARE	"Square"
LineShape.ARROW_STYLE_SMALL_ARROW	"Small Arrow"
LineShape.ARROW_STYLE_DIMENSION_LINES	"Dimension Lines"
LineShape.ARROW_STYLE_DOUBLE_ARROW	"Double Arrow"
LineShape.ARROW_STYLE_ROUNDED_SHORT_ARROW	"Rounded short Arrow"
LineShape.ARROW_STYLE_SYMMETRIC_ARROW	"Symmetric Arrow"
LineShape.ARROW_STYLE_LINE_ARROW	"Line Arrow"
LineShape.ARROW_STYLE_ROUNDED_LARGE_ARROW	"Rounded large Arrow"
LineShape.ARROW_STYLE_CIRCLE	"Circle"
LineShape.ARROW_STYLE_SQUARE_45	"Square 45"
LineShape.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 a line 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 a line 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 a line 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 a line 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 a line 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 a line in 1/100th mm.

Parameters:

endX -

Throws:

RemoteEclipseAPIException

getEndY

int getEndY()
            throws RemoteEclipseAPIException

This property returns or sets the Y coordinate of the end point of a line 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 a line in 1/100th mm.

Parameters:

endY - y

Throws:

RemoteEclipseAPIException