org.eclipse.scada.vi.ui.draw2d

Class SymbolContext

java.lang.Object

org.eclipse.scada.vi.ui.draw2d.SymbolContext

public class SymbolContext
extends java.lang.Object

The context object that is exported to the script context

Since:

0.17.0

Constructor Summary

Constructors

Constructor and Description
SymbolContext(SymbolController controller)

Method Summary

Methods

Modifier and Type	Method and Description
void	executeCommand(java.lang.String commandId, java.util.Map<java.lang.String,java.lang.String> eventData) Execute an Eclipse command
java.lang.Object	getElement(java.lang.String name) Get an element from this symbol by name
SymbolContext	getParent()
java.util.Properties	getProperties()
java.util.Map<java.lang.String,java.lang.String>	getPropertiesAsMap()
java.lang.Object	getProperty(java.lang.String name)
java.lang.Object	getProperty(java.lang.String name, java.lang.String defaultValue)
SummaryInformation	getSummary()
void	registerItem(java.lang.String name, java.lang.String itemId, java.lang.String connectionId)
void	registerItem(java.lang.String name, java.lang.String itemId, java.lang.String connectionId, boolean ignoreSummary, boolean nullInvalid)
void	startWrite(java.lang.String connectionId, java.lang.String itemId, java.lang.Object value)
void	startWriteAttribute(java.lang.String connectionId, java.lang.String itemId, java.lang.String key, java.lang.Object value)
void	startWriteAttributes(java.lang.String connectionId, java.lang.String itemId, java.util.Map<java.lang.String,Variant> attributes)
void	startWriteAttributeString(java.lang.String connectionId, java.lang.String itemId, java.lang.String key, java.lang.String value)
void	startWriteString(java.lang.String connectionId, java.lang.String itemId, java.lang.String value)
void	unregisterItem(java.lang.String name) Unregister item for symbol

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SymbolContext

public SymbolContext(SymbolController controller)

Method Detail

getProperties

public java.util.Properties getProperties()

getPropertiesAsMap

public java.util.Map<java.lang.String,java.lang.String> getPropertiesAsMap()

getElement

public java.lang.Object getElement(java.lang.String name)

Get an element from this symbol by name

Parameters:

name - the name of the symbol to fetch

Returns:

returns either a reference to the element controller of null if the element could not be found.

See Also:

org.eclipse.scada.vi.ui.draw2d.primitives, FigureContainerController, ImageController, ShapeController, RectangleController

getProperty

public java.lang.Object getProperty(java.lang.String name)

getProperty

public java.lang.Object getProperty(java.lang.String name,
                           java.lang.String defaultValue)

registerItem

public void registerItem(java.lang.String name,
                java.lang.String itemId,
                java.lang.String connectionId)

registerItem

public void registerItem(java.lang.String name,
                java.lang.String itemId,
                java.lang.String connectionId,
                boolean ignoreSummary,
                boolean nullInvalid)

unregisterItem

public void unregisterItem(java.lang.String name)

Unregister item for symbol

There is no need to unregister items when the symbol is disposed. This will be performed automatically.

Parameters:

name - the name of the item (not the id) to unregister

startWrite

public void startWrite(java.lang.String connectionId,
              java.lang.String itemId,
              java.lang.Object value)
                throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

startWriteString

public void startWriteString(java.lang.String connectionId,
                    java.lang.String itemId,
                    java.lang.String value)
                      throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

startWriteAttributeString

public void startWriteAttributeString(java.lang.String connectionId,
                             java.lang.String itemId,
                             java.lang.String key,
                             java.lang.String value)
                               throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

startWriteAttribute

public void startWriteAttribute(java.lang.String connectionId,
                       java.lang.String itemId,
                       java.lang.String key,
                       java.lang.Object value)
                         throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

startWriteAttributes

public void startWriteAttributes(java.lang.String connectionId,
                        java.lang.String itemId,
                        java.util.Map<java.lang.String,Variant> attributes)
                          throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

getParent

public SymbolContext getParent()

getSummary

public SummaryInformation getSummary()

executeCommand

public void executeCommand(java.lang.String commandId,
                  java.util.Map<java.lang.String,java.lang.String> eventData)

Execute an Eclipse command

Parameters:

commandId - the command to execute

eventData - the parameter event data (depends on the command)