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

public interface IRemoteLineFormat

This class represents the line format of a shape.

Access

To get the line format of a shape, use the LineFormat property in the Shape class.

Field Summary

static java.lang.String	DASHLINE_NAME_2_DOTS_1_DASH
static java.lang.String	DASHLINE_NAME_3_DASHES_3_DOTS_VARIABLE
static java.lang.String	DASHLINE_NAME_DASHED_VARIABLE
static java.lang.String	DASHLINE_NAME_FINE_DASHED
static java.lang.String	DASHLINE_NAME_FINE_DASHED_VARIABLE
static java.lang.String	DASHLINE_NAME_FINE_DOTTED
static java.lang.String	DASHLINE_NAME_LINE_STYLE_9
static java.lang.String	DASHLINE_NAME_LINE_WITH_FINE_DOTS
static java.lang.String	DASHLINE_NAME_ULTRAFINE_2_DOTS_3_DASHES
static java.lang.String	DASHLINE_NAME_ULTRAFINE_DASHED
static java.lang.String	DASHLINE_NAME_ULTRAFINE_DOTTED_VARIABLE
static int	LINE_MODE_DASHLINE specifies dashed line mode.
static int	LINE_MODE_NONE specifies no line mode.
static int	LINE_MODE_SOLIDLINE specifies solid line mode.

Method Summary

void	drawDashLine(int dash1, int dash1Len, int dash2, int dash2Len, int distance) This method draws a dashed line.
void	drawDashLineByName(java.lang.String name) This method draws a line by dash mode name.
void	drawNone() This method draws a line using no mode.
void	drawSolidLine() This method draws a solid line.
int	getLineColor() This property returns or sets a line color.
IRemoteDash	getLineDash() This property returns the dash format of a line.
int	getLineMode() This property returns the line mode.
int	getLineWidth() This property returns or sets the line width.
short	getTransparence() This property returns or sets the transparence of the object.
void	setLineColor(int color) This property returns or sets a line color.
void	setLineWidth(int lineWidth) This property returns or sets the line width.
void	setTransparence(short lineTransparence) This property returns or sets the transparence of the object.

Field Detail

DASHLINE_NAME_ULTRAFINE_DASHED

static final java.lang.String DASHLINE_NAME_ULTRAFINE_DASHED

See Also:

Constant Field Values

DASHLINE_NAME_FINE_DASHED

static final java.lang.String DASHLINE_NAME_FINE_DASHED

See Also:

Constant Field Values

DASHLINE_NAME_ULTRAFINE_2_DOTS_3_DASHES

static final java.lang.String DASHLINE_NAME_ULTRAFINE_2_DOTS_3_DASHES

See Also:

Constant Field Values

DASHLINE_NAME_FINE_DOTTED

static final java.lang.String DASHLINE_NAME_FINE_DOTTED

See Also:

Constant Field Values

DASHLINE_NAME_LINE_WITH_FINE_DOTS

static final java.lang.String DASHLINE_NAME_LINE_WITH_FINE_DOTS

See Also:

Constant Field Values

DASHLINE_NAME_FINE_DASHED_VARIABLE

static final java.lang.String DASHLINE_NAME_FINE_DASHED_VARIABLE

See Also:

Constant Field Values

DASHLINE_NAME_3_DASHES_3_DOTS_VARIABLE

static final java.lang.String DASHLINE_NAME_3_DASHES_3_DOTS_VARIABLE

See Also:

Constant Field Values

DASHLINE_NAME_ULTRAFINE_DOTTED_VARIABLE

static final java.lang.String DASHLINE_NAME_ULTRAFINE_DOTTED_VARIABLE

See Also:

Constant Field Values

DASHLINE_NAME_LINE_STYLE_9

static final java.lang.String DASHLINE_NAME_LINE_STYLE_9

See Also:

Constant Field Values

DASHLINE_NAME_2_DOTS_1_DASH

static final java.lang.String DASHLINE_NAME_2_DOTS_1_DASH

See Also:

Constant Field Values

DASHLINE_NAME_DASHED_VARIABLE

static final java.lang.String DASHLINE_NAME_DASHED_VARIABLE

See Also:

Constant Field Values

LINE_MODE_NONE

static final int LINE_MODE_NONE

specifies no line mode.

See Also:

Constant Field Values

LINE_MODE_SOLIDLINE

static final int LINE_MODE_SOLIDLINE

specifies solid line mode.

See Also:

Constant Field Values

LINE_MODE_DASHLINE

static final int LINE_MODE_DASHLINE

specifies dashed line mode.

See Also:

Constant Field Values

Method Detail

getLineMode

int getLineMode()
                throws RemoteEclipseAPIException

This property returns the line mode.

Legal values

Constant	Value	Description
LineFormat.LINE_MODE_NONE	0	specifies no line mode.
LineFormat.LINE_MODE_SOLIDLINE	1	specifies solid line mode.
LineFormat.LINE_MODE_DASHLINE	2	specifies dashed line mode.

Returns:

mode

Throws:

RemoteEclipseAPIException

getLineDash

IRemoteDash getLineDash()
                        throws RemoteEclipseAPIException

This property returns the dash format of a line.

Returns:

dash

Throws:

RemoteEclipseAPIException

setLineColor

void setLineColor(int color)
                  throws RemoteEclipseAPIException

This property returns or sets a line color. The value of this property is the decimal value of a color.

Parameters:

color - color

Throws:

RemoteEclipseAPIException

getLineColor

int getLineColor()
                 throws RemoteEclipseAPIException

This property returns or sets a line color. The value of this property is the decimal value of a color.

Returns:

color

Throws:

RemoteEclipseAPIException

getTransparence

short getTransparence()
                      throws RemoteEclipseAPIException

This property returns or sets the transparence of the object. The value of this property is from 0 which is fully opaque to 100 which is fully transparent. If the value is out of bounds, this property throws an exception.

Returns:

transparence

Throws:

RemoteEclipseAPIException

setTransparence

void setTransparence(short lineTransparence)
                     throws RemoteEclipseAPIException

This property returns or sets the transparence of the object. The value of this property is from 0 which is fully opaque to 100 which is fully transparent. If the value is out of bounds, this property throws an exception.

Parameters:

lineTransparence -

Throws:

RemoteEclipseAPIException

setLineWidth

void setLineWidth(int lineWidth)
                  throws RemoteEclipseAPIException

This property returns or sets the line width. If the value is negative, this property throws an exception.

Parameters:

lineWidth -

Throws:

RemoteEclipseAPIException

getLineWidth

int getLineWidth()
                 throws RemoteEclipseAPIException

This property returns or sets the line width. If the value is negative, this property throws an exception.

Returns:

width

Throws:

RemoteEclipseAPIException

drawNone

void drawNone()
              throws RemoteEclipseAPIException

This method draws a line using no mode.

Throws:

RemoteEclipseAPIException

drawSolidLine

void drawSolidLine()
                   throws RemoteEclipseAPIException

This method draws a solid line.

Throws:

RemoteEclipseAPIException

drawDashLine

void drawDashLine(int dash1,
                  int dash1Len,
                  int dash2,
                  int dash2Len,
                  int distance)
                  throws RemoteEclipseAPIException

This method draws a dashed line.

Parameters:

dash1 - Specifies the number of dashes in dash 1. If the value of this parameter is negative, this method throws an exception.

dash1Len - Specifies the length of each dash in dash 1 in 1/100th mm. If the value of this parameter is negative, this method throws an exception.

dash2 - Specifies the number of dashes in dash 2. If the value of this parameter is negative, this method throws an exception.

dash2Len - Specifies the length of each dash in dash 2 in 1/100th mm. If the value of this parameter is negative, this method throws an exception.

distance - Specifies the distance between dashes in 1/100th mm. If the value of this parameter is negative, this method throws an exception.

Throws:

RemoteEclipseAPIException

drawDashLineByName

void drawDashLineByName(java.lang.String name)
                        throws RemoteEclipseAPIException

This method draws a line by dash mode name.

Parameters:

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

Constant	Value	Description
LineFormat.DASHLINE_NAME_ULTRAFINE_DASHED	"Ultrafine Dashed"
LineFormat.DASHLINE_NAME_FINE_DASHED	"Fine Dashed"
LineFormat.DASHLINE_NAME_ULTRAFINE_2_DOTS_3_DASHES	"Ultrafine 2 Dots 3 Dashes"
LineFormat.DASHLINE_NAME_FINE_DOTTED	"Fine Dotted"
LineFormat.DASHLINE_NAME_LINE_WITH_FINE_DOTS	"Line with Fine Dots"
LineFormat.DASHLINE_NAME_FINE_DASHED_VARIABLE	"Fine Dashed (var)"
LineFormat.DASHLINE_NAME_3_DASHES_3_DOTS_VARIABLE	"3 Dashes 3 Dots (var)"
LineFormat.DASHLINE_NAME_ULTRAFINE_DOTTED_VARIABLE	"Ultrafine Dotted (var)"
LineFormat.DASHLINE_NAME_LINE_STYLE_9	"Line Style 9"
LineFormat.DASHLINE_NAME_2_DOTS_1_DASH	"2 Dots 1 Dash"
LineFormat.DASHLINE_NAME_DASHED_VARIABLE	"Dashed (var)"

Throws:

RemoteEclipseAPIException