Package jmri.jmrit.display.logixng
Class ActionAudioIcon
- java.lang.Object
-
- jmri.implementation.AbstractNamedBean
-
- jmri.jmrit.logixng.implementation.AbstractBase
-
- jmri.jmrit.logixng.actions.AbstractDigitalAction
-
- jmri.jmrit.display.logixng.ActionAudioIcon
-
- All Implemented Interfaces:
java.beans.VetoableChangeListener
,java.lang.Comparable<NamedBean>
,java.util.EventListener
,PropertyChangeProvider
,Base
,DigitalAction
,DigitalActionBean
,NamedBean
public class ActionAudioIcon extends AbstractDigitalAction implements java.beans.VetoableChangeListener
This action controls various things of a AudioIcon on a panel.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ActionAudioIcon.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 ActionAudioIcon(java.lang.String sys, java.lang.String user)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
execute()
Execute this DigitalActionBean.NamedBeanAddressing
getAddressing()
java.lang.String
getAudioIconName()
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.ActionAudioIcon.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
setAddressing(NamedBeanAddressing addressing)
void
setAudioIcon(java.lang.String positionableName)
void
setEditor(java.lang.String editorName)
void
setFormula(java.lang.String formula)
void
setLocalVariable(java.lang.String localVariable)
void
setOperation(ActionAudioIcon.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
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, disposeMe, getCategory, getChild, getChildCount, getConditionalNG, getListenerRefsIncludingChildren, getLogixNG, getRoot, getUsageDetail, getUsageTree, isActive, printTree, printTree, printTree, printTreeRow, registerListeners, registerListenersForThisClass, setParentForAllChildren, unregisterListeners, unregisterListenersForThisClass
-
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, getCategory, getChild, getChildCount, 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
-
ActionAudioIcon
public ActionAudioIcon(java.lang.String sys, java.lang.String user) 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 interfaceBase
- Parameters:
systemNames
- a map of old and new system nameuserNames
- 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()
-
setAudioIcon
public void setAudioIcon(@CheckForNull java.lang.String positionableName)
-
getAudioIconName
public java.lang.String getAudioIconName()
-
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(ActionAudioIcon.Operation isControlling)
-
getOperation
public ActionAudioIcon.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 interfaceBase
- Specified by:
vetoableChange
in interfaceNamedBean
- Specified by:
vetoableChange
in interfacejava.beans.VetoableChangeListener
- Overrides:
vetoableChange
in classAbstractNamedBean
- Throws:
java.beans.PropertyVetoException
-
execute
public void execute() throws JmriException
Execute this DigitalActionBean.- Specified by:
execute
in interfaceDigitalAction
- Throws:
JmriException
- when an exception occurs
-
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 interfaceBase
- 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 interfaceBase
- Parameters:
locale
- The locale to be used- Returns:
- a long description
-
-