org.eclipse.scada.vi.model

Interface Symbol

All Known Implementing Classes:

SymbolImpl

public interface Symbol

A representation of the model object 'Symbol'.

The following features are supported:

• Root
• Properties
• On Init
• On Dispose
• On Update
• Script Modules
• Cursors
• Background Color
• Design Size
• Connections

See Also:

VisualInterfacePackage.getSymbol()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBackgroundColor() Returns the value of the 'Background Color' attribute.
	getConnections() Returns the value of the 'Connections' containment reference list.
Cursor	getCursors() Returns the value of the 'Cursors' containment reference.
Dimension	getDesignSize() Returns the value of the 'Design Size' containment reference.
java.lang.String	getOnDispose() Returns the value of the 'On Dispose' attribute.
java.lang.String	getOnInit() Returns the value of the 'On Init' attribute.
java.lang.String	getOnUpdate() Returns the value of the 'On Update' attribute.
	getProperties() Returns the value of the 'Properties' map.
Primitive	getRoot() Returns the value of the 'Root' containment reference.
	getScriptModules() Returns the value of the 'Script Modules' attribute list.
void	setBackgroundColor(java.lang.String value) Sets the value of the 'Background Color' attribute.
void	setCursors(Cursor value) Sets the value of the 'Cursors' containment reference.
void	setDesignSize(Dimension value) Sets the value of the 'Design Size' containment reference.
void	setOnDispose(java.lang.String value) Sets the value of the 'On Dispose' attribute.
void	setOnInit(java.lang.String value) Sets the value of the 'On Init' attribute.
void	setOnUpdate(java.lang.String value) Sets the value of the 'On Update' attribute.
void	setRoot(Primitive value) Sets the value of the 'Root' containment reference.

Method Detail

getRoot

Primitive getRoot()

Returns the value of the 'Root' containment reference.

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

Returns:

the value of the 'Root' containment reference.

See Also:

setRoot(Primitive), VisualInterfacePackage.getSymbol_Root()

setRoot

void setRoot(Primitive value)

Sets the value of the 'Root' containment reference.

Parameters:

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

See Also:

getRoot()

getProperties

 getProperties()

Returns the value of the 'Properties' map. The key is of type String, and the value is of type String,

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

Returns:

the value of the 'Properties' map.

See Also:

VisualInterfacePackage.getSymbol_Properties()

getOnInit

java.lang.String getOnInit()

Returns the value of the 'On Init' attribute.

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

Returns:

the value of the 'On Init' attribute.

See Also:

setOnInit(String), VisualInterfacePackage.getSymbol_OnInit()

setOnInit

void setOnInit(java.lang.String value)

Sets the value of the 'On Init' attribute.

Parameters:

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

See Also:

getOnInit()

getOnDispose

java.lang.String getOnDispose()

Returns the value of the 'On Dispose' attribute.

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

Returns:

the value of the 'On Dispose' attribute.

See Also:

setOnDispose(String), VisualInterfacePackage.getSymbol_OnDispose()

setOnDispose

void setOnDispose(java.lang.String value)

Sets the value of the 'On Dispose' attribute.

Parameters:

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

See Also:

getOnDispose()

getOnUpdate

java.lang.String getOnUpdate()

Returns the value of the 'On Update' attribute.

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

Returns:

the value of the 'On Update' attribute.

See Also:

setOnUpdate(String), VisualInterfacePackage.getSymbol_OnUpdate()

setOnUpdate

void setOnUpdate(java.lang.String value)

Sets the value of the 'On Update' attribute.

Parameters:

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

See Also:

getOnUpdate()

getScriptModules

 getScriptModules()

Returns the value of the 'Script Modules' attribute list. The list contents are of type String.

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

Returns:

the value of the 'Script Modules' attribute list.

See Also:

VisualInterfacePackage.getSymbol_ScriptModules()

getCursors

Cursor getCursors()

Returns the value of the 'Cursors' containment reference.

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

Returns:

the value of the 'Cursors' containment reference.

See Also:

setCursors(Cursor), VisualInterfacePackage.getSymbol_Cursors()

setCursors

void setCursors(Cursor value)

Sets the value of the 'Cursors' containment reference.

Parameters:

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

See Also:

getCursors()

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.getSymbol_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()

getDesignSize

Dimension getDesignSize()

Returns the value of the 'Design Size' containment reference. The size as intended by the designer. May be used for layouting as preferred size.

Returns:

the value of the 'Design Size' containment reference.

See Also:

setDesignSize(Dimension), VisualInterfacePackage.getSymbol_DesignSize()

setDesignSize

void setDesignSize(Dimension value)

Sets the value of the 'Design Size' containment reference.

Parameters:

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

See Also:

getDesignSize()

getConnections

 getConnections()

Returns the value of the 'Connections' containment reference list. The list contents are of type Connection.

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

Returns:

the value of the 'Connections' containment reference list.

See Also:

VisualInterfacePackage.getSymbol_Connections()