org.eclipse.scada.vi.model

Interface Figure

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier, Primitive

All Known Subinterfaces:

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

All Known Implementing Classes:

ArcImpl, ChartViewImpl, EllipseImpl, FigureContainerImpl, FigureImpl, ImageImpl, LineImpl, PolygonImpl, RectangleImpl, RoundedRectangleImpl, 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
• On Mouse In
• On Mouse Out
• On Mouse Move
• On Mouse Hover
• On Mouse Drag

See Also:

VisualInterfacePackage.getFigure()

Method Summary

Modifier and Type	Method and Description
String	getBackgroundColor() Returns the value of the 'Background Color' attribute.
String	getBorder() Returns the value of the 'Border' attribute.
Cursor	getCursor() Returns the value of the 'Cursor' reference.
String	getForegroundColor() Returns the value of the 'Foreground Color' attribute.
String	getOnClick() Returns the value of the 'On Click' attribute.
String	getOnDoubleClick() Returns the value of the 'On Double Click' attribute.
String	getOnMouseDrag() Returns the value of the 'On Mouse Drag' attribute.
String	getOnMouseHover() Returns the value of the 'On Mouse Hover' attribute.
String	getOnMouseIn() Returns the value of the 'On Mouse In' attribute.
String	getOnMouseMove() Returns the value of the 'On Mouse Move' attribute.
String	getOnMouseOut() Returns the value of the 'On Mouse Out' attribute.
Boolean	getOpaque() Returns the value of the 'Opaque' attribute.
Dimension	getSize() Returns the value of the 'Size' containment reference.
String	getToolTip() Returns the value of the 'Tool Tip' attribute.
boolean	isVisible() Returns the value of the 'Visible' attribute.
void	setBackgroundColor(String value) Sets the value of the 'Background Color' attribute.
void	setBorder(String value) Sets the value of the 'Border' attribute.
void	setCursor(Cursor value) Sets the value of the 'Cursor' reference.
void	setForegroundColor(String value) Sets the value of the 'Foreground Color' attribute.
void	setOnClick(String value) Sets the value of the 'On Click' attribute.
void	setOnDoubleClick(String value) Sets the value of the 'On Double Click' attribute.
void	setOnMouseDrag(String value) Sets the value of the 'On Mouse Drag' attribute.
void	setOnMouseHover(String value) Sets the value of the 'On Mouse Hover' attribute.
void	setOnMouseIn(String value) Sets the value of the 'On Mouse In' attribute.
void	setOnMouseMove(String value) Sets the value of the 'On Mouse Move' attribute.
void	setOnMouseOut(String value) Sets the value of the 'On Mouse Out' attribute.
void	setOpaque(Boolean value) Sets the value of the 'Opaque' attribute.
void	setSize(Dimension value) Sets the value of the 'Size' containment reference.
void	setToolTip(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

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getForegroundColor

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(String value)

Sets the value of the 'Foreground Color' attribute.

Parameters:

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

See Also:

getForegroundColor()

getBackgroundColor

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(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

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(String value)

Sets the value of the 'On Click' attribute.

Parameters:

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

See Also:

getOnClick()

getOnDoubleClick

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(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

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(String value)

Sets the value of the 'Border' attribute.

Parameters:

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

See Also:

getBorder()

getOpaque

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(Boolean value)

Sets the value of the 'Opaque' attribute.

Parameters:

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

See Also:

getOpaque()

getToolTip

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(String value)

Sets the value of the 'Tool Tip' attribute.

Parameters:

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

See Also:

getToolTip()

getOnMouseIn

String getOnMouseIn()

Returns the value of the 'On Mouse In' attribute.

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

Returns:

the value of the 'On Mouse In' attribute.

See Also:

setOnMouseIn(String), VisualInterfacePackage.getFigure_OnMouseIn()

setOnMouseIn

void setOnMouseIn(String value)

Sets the value of the 'On Mouse In' attribute.

Parameters:

value - the new value of the 'On Mouse In' attribute.

See Also:

getOnMouseIn()

getOnMouseOut

String getOnMouseOut()

Returns the value of the 'On Mouse Out' attribute.

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

Returns:

the value of the 'On Mouse Out' attribute.

See Also:

setOnMouseOut(String), VisualInterfacePackage.getFigure_OnMouseOut()

setOnMouseOut

void setOnMouseOut(String value)

Sets the value of the 'On Mouse Out' attribute.

Parameters:

value - the new value of the 'On Mouse Out' attribute.

See Also:

getOnMouseOut()

getOnMouseMove

String getOnMouseMove()

Returns the value of the 'On Mouse Move' attribute.

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

Returns:

the value of the 'On Mouse Move' attribute.

See Also:

setOnMouseMove(String), VisualInterfacePackage.getFigure_OnMouseMove()

setOnMouseMove

void setOnMouseMove(String value)

Sets the value of the 'On Mouse Move' attribute.

Parameters:

value - the new value of the 'On Mouse Move' attribute.

See Also:

getOnMouseMove()

getOnMouseHover

String getOnMouseHover()

Returns the value of the 'On Mouse Hover' attribute.

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

Returns:

the value of the 'On Mouse Hover' attribute.

See Also:

setOnMouseHover(String), VisualInterfacePackage.getFigure_OnMouseHover()

setOnMouseHover

void setOnMouseHover(String value)

Sets the value of the 'On Mouse Hover' attribute.

Parameters:

value - the new value of the 'On Mouse Hover' attribute.

See Also:

getOnMouseHover()

getOnMouseDrag

String getOnMouseDrag()

Returns the value of the 'On Mouse Drag' attribute.

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

Returns:

the value of the 'On Mouse Drag' attribute.

See Also:

setOnMouseDrag(String), VisualInterfacePackage.getFigure_OnMouseDrag()

setOnMouseDrag

void setOnMouseDrag(String value)

Sets the value of the 'On Mouse Drag' attribute.

Parameters:

value - the new value of the 'On Mouse Drag' attribute.

See Also:

getOnMouseDrag()