Package jmri.jmrit.logixng.actions

Class ActionScript

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.jmrit.logixng.implementation.AbstractBase

jmri.jmrit.logixng.actions.AbstractDigitalAction

jmri.jmrit.logixng.actions.ActionScript

All Implemented Interfaces:

java.lang.Comparable<NamedBean>, PropertyChangeProvider, Base, DigitalAction, DigitalActionBean, NamedBean

public class ActionScript
extends AbstractDigitalAction

Executes a script.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ActionScript.OperationType

Nested classes/interfaces inherited from interface jmri.jmrit.logixng.Base

Base.PrintTreeSettings, Base.RunnableWithBase, Base.RunnableWithBaseThrowException

Nested classes/interfaces inherited from interface jmri.NamedBean

NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException

Field Summary

Fields inherited from class jmri.jmrit.logixng.implementation.AbstractBase

_listenersAreRegistered

Fields inherited from class jmri.implementation.AbstractNamedBean

listenerRefs, mSystemName, register

Fields inherited from interface jmri.jmrit.logixng.Base

PRINT_LINE_NUMBERS_FORMAT, PROPERTY_CHILD_COUNT, PROPERTY_CHILD_REORDER, PROPERTY_LAST_RESULT_CHANGED, PROPERTY_SOCKET_CONNECTED, PROPERTY_SOCKET_DISCONNECTED, SEPARATOR, SOCKET_CONNECTED, SOCKET_DISCONNECTED

Fields inherited from interface jmri.NamedBean

DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_STATE, QUOTED_NAME_FORMAT, UNKNOWN

Constructor Summary

Constructors

Constructor	Description
ActionScript(java.lang.String sys, java.lang.String user)

Method Summary

Modifier and Type	Method	Description
void	disposeMe()	Dispose this class.
void	execute()	Execute this DigitalActionBean.
void	firePropertyChange(java.lang.String p, java.lang.Object old, java.lang.Object n)
Category	getCategory()	Get the category.
FemaleSocket	getChild(int index)	Get a child of this item
int	getChildCount()	Get the number of children.
Base	getDeepCopy(java.util.Map<java.lang.String,java.lang.String> systemNames, java.util.Map<java.lang.String,java.lang.String> userNames)	Create a deep copy of myself and my children The item needs to try to lookup itself in both systemNames and userNames to see if the user has given a new system name and/or a new user name.If no new system name is given, an auto system name is used.
java.lang.String	getLongDescription(java.util.Locale locale)	Get a long description of this item.
NamedBeanAddressing	getOperationAddressing()
java.lang.String	getOperationFormula()
java.lang.String	getOperationLocalVariable()
java.lang.String	getOperationReference()
ActionScript.OperationType	getOperationType()
java.lang.String	getScript()
NamedBeanAddressing	getScriptAddressing()
ScriptEngineSelector	getScriptEngineSelector()
java.lang.String	getScriptFormula()
java.lang.String	getScriptLocalVariable()
java.lang.String	getScriptReference()
java.lang.String	getShortDescription(java.util.Locale locale)	Get a short description of this item.
void	registerListenersForThisClass()	Register listeners if this object needs that.
void	setOperationAddressing(NamedBeanAddressing addressing)
void	setOperationFormula(java.lang.String formula)
void	setOperationLocalVariable(java.lang.String localVariable)
void	setOperationReference(java.lang.String reference)
void	setOperationType(ActionScript.OperationType operationType)
void	setScript(java.lang.String script)
void	setScriptAddressing(NamedBeanAddressing addressing)
void	setScriptFormula(java.lang.String formula)
void	setScriptLocalVariable(java.lang.String localVariable)
void	setScriptReference(java.lang.String reference)
void	setup()	Setup this object and its children.
void	unregisterListenersForThisClass()	Unregister listeners if this object needs that.

Methods inherited from class jmri.jmrit.logixng.actions.AbstractDigitalAction

getBeanType, getNewSocketName, getNewSocketName, getParent, getPreferredSocketPrefix, getState, setParent, setState

Methods inherited from class jmri.jmrit.logixng.implementation.AbstractBase

assertListenersAreNotRegistered, compareSystemNameSuffix, deepCopyChildren, dispose, getConditionalNG, getListenerRefsIncludingChildren, getLogixNG, getRoot, getUsageDetail, getUsageTree, isActive, printTree, printTree, printTree, printTreeRow, registerListeners, setParentForAllChildren, unregisterListeners

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, describeState, equals, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, hashCode, removeProperty, removePropertyChangeListener, removePropertyChangeListener, setComment, setProperty, setUserName, toString, toStringSuffix, updateListenerRef, vetoableChange

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jmri.jmrit.logixng.Base

addPropertyChangeListener, addPropertyChangeListener, deepCopyChildren, dispose, doSocketOperation, existsInTree, forEntireTree, forEntireTreeWithException, getComment, getConditionalNG, getListenerRef, getListenerRefs, getListenerRefsIncludingChildren, getLogixNG, getLongDescription, getModule, getNumPropertyChangeListeners, getPropertyChangeListenersByReference, getRoot, getShortDescription, getSystemName, getUsageDetail, getUsageTree, getUserName, hasChild, isActive, isEnabled, isSocketOperationAllowed, printTree, printTree, printTree, printTree, printTree, registerListeners, setComment, setParentForAllChildren, setUserName, unregisterListeners, updateListenerRef, vetoableChange

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, describeState, dispose, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUsageReport, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef, vetoableChange

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Constructor Detail

ActionScript

public ActionScript(java.lang.String sys,
                    java.lang.String user)
             throws NamedBean.BadUserNameException,
                    NamedBean.BadSystemNameException

Throws:

NamedBean.BadUserNameException

NamedBean.BadSystemNameException

Method Detail

getDeepCopy

public Base getDeepCopy(java.util.Map<java.lang.String,java.lang.String> systemNames,
                        java.util.Map<java.lang.String,java.lang.String> userNames)
                 throws JmriException

Description copied from interface: Base

Create a deep copy of myself and my children The item needs to try to lookup itself in both systemNames and userNames to see if the user has given a new system name and/or a new user name.If no new system name is given, an auto system name is used. If no user name is given, a null user name is used.

Parameters:

systemNames - a map of old and new system name

userNames - a map of old system name and new user name

Returns:

a deep copy

Throws:

JmriException - in case of an error

getScriptEngineSelector

public ScriptEngineSelector getScriptEngineSelector()

setOperationAddressing

public void setOperationAddressing(NamedBeanAddressing addressing)
                            throws ParserException

Throws:

ParserException

getOperationAddressing

public NamedBeanAddressing getOperationAddressing()

setOperationType

public void setOperationType(ActionScript.OperationType operationType)

getOperationType

public ActionScript.OperationType getOperationType()

setOperationReference

public void setOperationReference(@Nonnull
                                  java.lang.String reference)

getOperationReference

public java.lang.String getOperationReference()

setOperationLocalVariable

public void setOperationLocalVariable(@Nonnull
                                      java.lang.String localVariable)

getOperationLocalVariable

public java.lang.String getOperationLocalVariable()

setOperationFormula

public void setOperationFormula(@Nonnull
                                java.lang.String formula)
                         throws ParserException

Throws:

ParserException

getOperationFormula

public java.lang.String getOperationFormula()

setScriptAddressing

public void setScriptAddressing(NamedBeanAddressing addressing)
                         throws ParserException

Throws:

ParserException

getScriptAddressing

public NamedBeanAddressing getScriptAddressing()

setScript

public void setScript(java.lang.String script)

getScript

public java.lang.String getScript()

setScriptReference

public void setScriptReference(@Nonnull
                               java.lang.String reference)

getScriptReference

public java.lang.String getScriptReference()

setScriptLocalVariable

public void setScriptLocalVariable(@Nonnull
                                   java.lang.String localVariable)

getScriptLocalVariable

public java.lang.String getScriptLocalVariable()

setScriptFormula

public void setScriptFormula(@Nonnull
                             java.lang.String formula)
                      throws ParserException

Throws:

ParserException

getScriptFormula

public java.lang.String getScriptFormula()

getCategory

public Category getCategory()

Get the category.

Specified by:

getCategory in interface Base

Overrides:

getCategory in class AbstractBase

Returns:

the category

execute

public void execute()
             throws JmriException

Execute this DigitalActionBean.

Throws:

JmriException - when an exception occurs

getChild

public FemaleSocket getChild(int index)
                      throws java.lang.IllegalArgumentException,
                             java.lang.UnsupportedOperationException

Description copied from class: AbstractBase

Get a child of this item

Specified by:

getChild in interface Base

Overrides:

getChild in class AbstractBase

Parameters:

index - the index of the child to get

Returns:

the child

Throws:

java.lang.IllegalArgumentException - if the index is less than 0 or greater or equal with the value returned by getChildCount()

java.lang.UnsupportedOperationException

getChildCount

public int getChildCount()

Description copied from class: AbstractBase

Get the number of children.

Specified by:

getChildCount in interface Base

Overrides:

getChildCount in class AbstractBase

Returns:

the number of children

getShortDescription

public java.lang.String getShortDescription(java.util.Locale locale)

Description copied from interface: Base

Get a short description of this item.

Parameters:

locale - The locale to be used

Returns:

a short description

getLongDescription

public java.lang.String getLongDescription(java.util.Locale locale)

Description copied from interface: Base

Get a long description of this item.

Parameters:

locale - The locale to be used

Returns:

a long description

setup

public void setup()

Setup this object and its children. This method is used to lookup system names for child sockets, turnouts, sensors, and so on.

registerListenersForThisClass

public void registerListenersForThisClass()

Register listeners if this object needs that.

Important: This method may be called more than once. Methods overriding this method must ensure that listeners are not registered more than once.

Overrides:

registerListenersForThisClass in class AbstractBase

unregisterListenersForThisClass

public void unregisterListenersForThisClass()

Unregister listeners if this object needs that.

Important: This method may be called more than once. Methods overriding this method must ensure that listeners are not unregistered more than once.

Overrides:

unregisterListenersForThisClass in class AbstractBase

firePropertyChange

public void firePropertyChange(java.lang.String p,
                               java.lang.Object old,
                               java.lang.Object n)

Overrides:

firePropertyChange in class AbstractNamedBean

disposeMe

public void disposeMe()

Dispose this class. Listeners do not need to be unregistered by this method since they are unregistered by dispose().

Overrides:

disposeMe in class AbstractBase