Package jmri.jmrit.display.logixng

Class ActionPositionableByClass

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.jmrit.logixng.implementation.AbstractBase

jmri.jmrit.logixng.actions.AbstractDigitalAction

jmri.jmrit.display.logixng.ActionPositionableByClass

All Implemented Interfaces:

java.beans.VetoableChangeListener, java.lang.Comparable<NamedBean>, java.util.EventListener, PropertyChangeProvider, Base, DigitalAction, DigitalActionBean, NamedBean

public class ActionPositionableByClass
extends AbstractDigitalAction
implements java.beans.VetoableChangeListener

This action controls various things of Positionables with a particular class name on a panel.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ActionPositionableByClass.Operation

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
ActionPositionableByClass(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.
NamedBeanAddressing	getAddressing()
Category	getCategory()	Get the category.
FemaleSocket	getChild(int index)	Get a child of this item
int	getChildCount()	Get the number of children.
java.lang.String	getClassName()
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	getEditorName()
java.lang.String	getFormula()
java.lang.String	getLocalVariable()
java.lang.String	getLongDescription(java.util.Locale locale)	Get a long description of this item.
ActionPositionableByClass.Operation	getOperation()
java.lang.String	getReference()
java.lang.String	getShortDescription(java.util.Locale locale)	Get a short description of this item.
NamedBeanAddressing	getStateAddressing()
java.lang.String	getStateFormula()
java.lang.String	getStateLocalVariable()
java.lang.String	getStateReference()
void	registerListenersForThisClass()	Register listeners if this object needs that.
void	setAddressing(NamedBeanAddressing addressing)
void	setClassName(java.lang.String className)
void	setEditor(java.lang.String editorName)
void	setFormula(java.lang.String formula)
void	setLocalVariable(java.lang.String localVariable)
void	setOperation(ActionPositionableByClass.Operation isControlling)
void	setReference(java.lang.String reference)
void	setStateAddressing(NamedBeanAddressing addressing)
void	setStateFormula(java.lang.String formula)
void	setStateLocalVariable(java.lang.String localVariable)
void	setStateReference(java.lang.String reference)
void	setup()	Setup this object and its children.
void	unregisterListenersForThisClass()	Unregister listeners if this object needs that.
void	vetoableChange(java.beans.PropertyChangeEvent evt)

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, firePropertyChange, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, hashCode, removeProperty, removePropertyChangeListener, removePropertyChangeListener, setComment, setProperty, setUserName, toString, toStringSuffix, updateListenerRef

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

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

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Constructor Detail

ActionPositionableByClass

public ActionPositionableByClass(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 ParserException

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.

Specified by:

getDeepCopy in interface Base

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:

ParserException

setEditor

public void setEditor(@CheckForNull
                      java.lang.String editorName)

getEditorName

public java.lang.String getEditorName()

setClassName

public void setClassName(@CheckForNull
                         java.lang.String className)

getClassName

public java.lang.String getClassName()

setAddressing

public void setAddressing(NamedBeanAddressing addressing)
                   throws ParserException

Throws:

ParserException

getAddressing

public NamedBeanAddressing getAddressing()

setReference

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

getReference

public java.lang.String getReference()

setLocalVariable

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

getLocalVariable

public java.lang.String getLocalVariable()

setFormula

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

Throws:

ParserException

getFormula

public java.lang.String getFormula()

setStateAddressing

public void setStateAddressing(NamedBeanAddressing addressing)
                        throws ParserException

Throws:

ParserException

getStateAddressing

public NamedBeanAddressing getStateAddressing()

setOperation

public void setOperation(ActionPositionableByClass.Operation isControlling)

getOperation

public ActionPositionableByClass.Operation getOperation()

setStateReference

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

getStateReference

public java.lang.String getStateReference()

setStateLocalVariable

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

getStateLocalVariable

public java.lang.String getStateLocalVariable()

setStateFormula

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

Throws:

ParserException

getStateFormula

public java.lang.String getStateFormula()

vetoableChange

public void vetoableChange(java.beans.PropertyChangeEvent evt)
                    throws java.beans.PropertyVetoException

Description copied from class: AbstractNamedBean

Specified by:

vetoableChange in interface Base

Specified by:

vetoableChange in interface NamedBean

Specified by:

vetoableChange in interface java.beans.VetoableChangeListener

Overrides:

vetoableChange in class AbstractNamedBean

Throws:

java.beans.PropertyVetoException

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.

Specified by:

execute in interface DigitalAction

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.

Specified by:

getShortDescription in interface Base

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.

Specified by:

getLongDescription in interface Base

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.

Specified by:

setup in interface Base

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

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