org.eclipse.scada.vi.model

Interface Figure

All Superinterfaces:

Primitive

All Known Subinterfaces:

Arc, ChartView, Ellipse, FigureContainer, Image, Line, Rectangle, Shape, Text

All Known Implementing Classes:

ArcImpl, ChartViewImpl, EllipseImpl, FigureContainerImpl, FigureImpl, ImageImpl, LineImpl, RectangleImpl, ShapeImpl, TextImpl

public interface Figure
extends Primitive

A representation of the model object 'Figure'.

The following features are supported:

• Foreground Color
• Background Color
• Size
• On Click
• On Double Click
• Cursor
• Visible
• Border
• Opaque
• Tool Tip

See Also:

VisualInterfacePackage.getFigure()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBackgroundColor() Returns the value of the 'Background Color' attribute.
java.lang.String	getBorder() Returns the value of the 'Border' attribute.
Cursor	getCursor() Returns the value of the 'Cursor' reference.
java.lang.String	getForegroundColor() Returns the value of the 'Foreground Color' attribute.
java.lang.String	getOnClick() Returns the value of the 'On Click' attribute.
java.lang.String	getOnDoubleClick() Returns the value of the 'On Double Click' attribute.
java.lang.Boolean	getOpaque() Returns the value of the 'Opaque' attribute.
Dimension	getSize() Returns the value of the 'Size' containment reference.
java.lang.String	getToolTip() Returns the value of the 'Tool Tip' attribute.
boolean	isVisible() Returns the value of the 'Visible' attribute.
void	setBackgroundColor(java.lang.String value) Sets the value of the 'Background Color' attribute.
void	setBorder(java.lang.String value) Sets the value of the 'Border' attribute.
void	setCursor(Cursor value) Sets the value of the 'Cursor' reference.
void	setForegroundColor(java.lang.String value) Sets the value of the 'Foreground Color' attribute.
void	setOnClick(java.lang.String value) Sets the value of the 'On Click' attribute.
void	setOnDoubleClick(java.lang.String value) Sets the value of the 'On Double Click' attribute.
void	setOpaque(java.lang.Boolean value) Sets the value of the 'Opaque' attribute.
void	setSize(Dimension value) Sets the value of the 'Size' containment reference.
void	setToolTip(java.lang.String value) Sets the value of the 'Tool Tip' attribute.
void	setVisible(boolean value) Sets the value of the 'Visible' attribute.

Methods inherited from interface org.eclipse.scada.vi.model.Primitive

getName, setName

Method Detail

getForegroundColor

java.lang.String getForegroundColor()

Returns the value of the 'Foreground Color' attribute.

If the meaning of the 'Foreground Color' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Foreground Color' attribute.

See Also:

setForegroundColor(String), VisualInterfacePackage.getFigure_ForegroundColor()

setForegroundColor

void setForegroundColor(java.lang.String value)

Sets the value of the 'Foreground Color' attribute.

Parameters:

value - the new value of the 'Foreground Color' attribute.

See Also:

getForegroundColor()

getBackgroundColor

java.lang.String getBackgroundColor()

Returns the value of the 'Background Color' attribute.

If the meaning of the 'Background Color' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Background Color' attribute.

See Also:

setBackgroundColor(String), VisualInterfacePackage.getFigure_BackgroundColor()

setBackgroundColor

void setBackgroundColor(java.lang.String value)

Sets the value of the 'Background Color' attribute.

Parameters:

value - the new value of the 'Background Color' attribute.

See Also:

getBackgroundColor()

getSize

Dimension getSize()

Returns the value of the 'Size' containment reference.

If the meaning of the 'Size' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Size' containment reference.

See Also:

setSize(Dimension), VisualInterfacePackage.getFigure_Size()

setSize

void setSize(Dimension value)

Sets the value of the 'Size' containment reference.

Parameters:

value - the new value of the 'Size' containment reference.

See Also:

getSize()

getOnClick

java.lang.String getOnClick()

Returns the value of the 'On Click' attribute.

If the meaning of the 'On Click' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'On Click' attribute.

See Also:

setOnClick(String), VisualInterfacePackage.getFigure_OnClick()

setOnClick

void setOnClick(java.lang.String value)

Sets the value of the 'On Click' attribute.

Parameters:

value - the new value of the 'On Click' attribute.

See Also:

getOnClick()

getOnDoubleClick

java.lang.String getOnDoubleClick()

Returns the value of the 'On Double Click' attribute.

If the meaning of the 'On Double Click' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'On Double Click' attribute.

See Also:

setOnDoubleClick(String), VisualInterfacePackage.getFigure_OnDoubleClick()

setOnDoubleClick

void setOnDoubleClick(java.lang.String value)

Sets the value of the 'On Double Click' attribute.

Parameters:

value - the new value of the 'On Double Click' attribute.

See Also:

getOnDoubleClick()

getCursor

Cursor getCursor()

Returns the value of the 'Cursor' reference.

If the meaning of the 'Cursor' reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Cursor' reference.

See Also:

setCursor(Cursor), VisualInterfacePackage.getFigure_Cursor()

setCursor

void setCursor(Cursor value)

Sets the value of the 'Cursor' reference.

Parameters:

value - the new value of the 'Cursor' reference.

See Also:

getCursor()

isVisible

boolean isVisible()

Returns the value of the 'Visible' attribute. The default value is "true".

If the meaning of the 'Visible' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Visible' attribute.

See Also:

setVisible(boolean), VisualInterfacePackage.getFigure_Visible()

setVisible

void setVisible(boolean value)

Sets the value of the 'Visible' attribute.

Parameters:

value - the new value of the 'Visible' attribute.

See Also:

isVisible()

getBorder

java.lang.String getBorder()

Returns the value of the 'Border' attribute.

If the meaning of the 'Border' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Border' attribute.

See Also:

setBorder(String), VisualInterfacePackage.getFigure_Border()

setBorder

void setBorder(java.lang.String value)

Sets the value of the 'Border' attribute.

Parameters:

value - the new value of the 'Border' attribute.

See Also:

getBorder()

getOpaque

java.lang.Boolean getOpaque()

Returns the value of the 'Opaque' attribute.

If the meaning of the 'Opaque' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Opaque' attribute.

See Also:

setOpaque(Boolean), VisualInterfacePackage.getFigure_Opaque()

setOpaque

void setOpaque(java.lang.Boolean value)

Sets the value of the 'Opaque' attribute.

Parameters:

value - the new value of the 'Opaque' attribute.

See Also:

getOpaque()

getToolTip

java.lang.String getToolTip()

Returns the value of the 'Tool Tip' attribute.

If the meaning of the 'Tool Tip' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Tool Tip' attribute.

See Also:

setToolTip(String), VisualInterfacePackage.getFigure_ToolTip()

setToolTip

void setToolTip(java.lang.String value)

Sets the value of the 'Tool Tip' attribute.

Parameters:

value - the new value of the 'Tool Tip' attribute.

See Also:

getToolTip()