Package jmri.jmrit.logixng.actions

Class ShowDialog

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.jmrit.logixng.implementation.AbstractBase

jmri.jmrit.logixng.actions.AbstractDigitalAction

jmri.jmrit.logixng.actions.ShowDialog

All Implemented Interfaces:

PropertyChangeListener, VetoableChangeListener, Comparable<NamedBean>, EventListener, PropertyChangeProvider, Base, DigitalAction, DigitalActionBean, FemaleSocketListener, NamedBean

public class ShowDialog
extends AbstractDigitalAction
implements FemaleSocketListener, PropertyChangeListener, VetoableChangeListener

This action show a dialog.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ShowDialog.Button
static class	ShowDialog.Data
static enum	ShowDialog.DataType
static enum	ShowDialog.FormatType

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_COMMENT, PROPERTY_ENABLED, PROPERTY_KNOWN_STATE, PROPERTY_STATE, PROPERTY_USERNAME, QUOTED_NAME_FORMAT, UNKNOWN

Constructor Summary

Constructors

Constructor	Description
ShowDialog(String sys, String user)

Method Summary

Modifier and Type	Method	Description
void	connected(FemaleSocket socket)	The socket is connected.
void	disconnected(FemaleSocket socket)	The socket is disconnected.
void	disposeMe()	Dispose this class.
void	execute()	Execute this DigitalActionBean.
LogixNG_Category	getCategory()	Get the category.
FemaleSocket	getChild(int index)	Get a child of this item
int	getChildCount()	Get the number of children.
List<ShowDialog.Data>	getDataList()
Base	getDeepCopy(Map<String,String> systemNames, Map<String,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.
Set<ShowDialog.Button>	getEnabledButtons()	Return the list of buttons.
FemaleDigitalActionSocket	getExecuteSocket()
String	getExecuteSocketSystemName()
String	getFormat()
ShowDialog.FormatType	getFormatType()
String	getLocalVariableForInputString()
String	getLocalVariableForSelectedButton()
String	getLongDescription(Locale locale)	Get a long description of this item.
boolean	getModal()
boolean	getMultiLine()
String	getShortDescription(Locale locale)	Get a short description of this item.
void	getUsageDetail(int level, NamedBean bean, List<NamedBeanUsageReport> report, NamedBean cdl)	Add a new NamedBeanUsageReport to the report list if there are any matches in this action or expresssion.
FemaleDigitalExpressionSocket	getValidateSocket()
String	getValidateSocketSystemName()
void	propertyChange(PropertyChangeEvent evt)
void	registerListenersForThisClass()	Register listeners if this object needs that.
void	setExecuteSocketSystemName(String systemName)
void	setFormat(String format)
void	setFormatType(ShowDialog.FormatType formatType)
void	setLocalVariableForInputString(String localVariableForInputString)
void	setLocalVariableForSelectedButton(String localVariable)
void	setModal(boolean modal)
void	setMultiLine(boolean multiLine)
void	setup()	Setup this object and its children.
void	setValidateSocketSystemName(String systemName)
void	unregisterListenersForThisClass()	Unregister listeners if this object needs that.
void	vetoableChange(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, 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, getUsageTree, getUserName, hasChild, isActive, isEnabled, isSocketOperationAllowed, printTree, printTree, printTree, printTree, printTree, registerListeners, setComment, setParentForAllChildren, setUserName, unregisterListeners, updateListenerRef

Methods inherited from interface jmri.jmrit.logixng.FemaleSocketListener

socketNameChanged

Methods inherited from interface jmri.NamedBean

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

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Constructor Details

ShowDialog

public ShowDialog(String sys,
 String user)
           throws NamedBean.BadUserNameException,
NamedBean.BadSystemNameException

Throws:

NamedBean.BadUserNameException

NamedBean.BadSystemNameException

Method Details

getDeepCopy

public Base getDeepCopy(Map<String,String> systemNames,
 Map<String,String> userNames)
                 throws ParserException,
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.

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:

JmriException - in case of an error

ParserException

getEnabledButtons

public Set<ShowDialog.Button> getEnabledButtons()

Return the list of buttons.

Returns:

the list of buttons.

setModal

public void setModal(boolean modal)

getModal

public boolean getModal()

setMultiLine

public void setMultiLine(boolean multiLine)

getMultiLine

public boolean getMultiLine()

setLocalVariableForSelectedButton

public void setLocalVariableForSelectedButton(String localVariable)

getLocalVariableForSelectedButton

public String getLocalVariableForSelectedButton()

setLocalVariableForInputString

public void setLocalVariableForInputString(String localVariableForInputString)

getLocalVariableForInputString

public String getLocalVariableForInputString()

setFormatType

public void setFormatType(ShowDialog.FormatType formatType)

getFormatType

public ShowDialog.FormatType getFormatType()

setFormat

public void setFormat(String format)

getFormat

public String getFormat()

getDataList

public List<ShowDialog.Data> getDataList()

vetoableChange

public void vetoableChange(PropertyChangeEvent evt)
                    throws PropertyVetoException

Description copied from class: AbstractNamedBean

Specified by:

vetoableChange in interface Base

Specified by:

vetoableChange in interface NamedBean

Specified by:

vetoableChange in interface VetoableChangeListener

Overrides:

vetoableChange in class AbstractNamedBean

Throws:

PropertyVetoException

getCategory

public LogixNG_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 IllegalArgumentException,
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:

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

UnsupportedOperationException - when needed

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

connected

public void connected(FemaleSocket socket)

Description copied from interface: FemaleSocketListener

The socket is connected.

Specified by:

connected in interface FemaleSocketListener

Parameters:

socket - the socket

disconnected

public void disconnected(FemaleSocket socket)

Description copied from interface: FemaleSocketListener

The socket is disconnected.

Specified by:

disconnected in interface FemaleSocketListener

Parameters:

socket - the socket

getShortDescription

public String getShortDescription(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 String getLongDescription(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

getValidateSocket

public FemaleDigitalExpressionSocket getValidateSocket()

getValidateSocketSystemName

public String getValidateSocketSystemName()

setValidateSocketSystemName

public void setValidateSocketSystemName(String systemName)

getExecuteSocket

public FemaleDigitalActionSocket getExecuteSocket()

getExecuteSocketSystemName

public String getExecuteSocketSystemName()

setExecuteSocketSystemName

public void setExecuteSocketSystemName(String systemName)

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

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener

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

getUsageDetail

public void getUsageDetail(int level,
 NamedBean bean,
 List<NamedBeanUsageReport> report,
 NamedBean cdl)

Add a new NamedBeanUsageReport to the report list if there are any matches in this action or expresssion.

NamedBeanUsageReport Usage keys:

• LogixNGAction
• LogixNGExpression

Specified by:

getUsageDetail in interface Base

Overrides:

getUsageDetail in class AbstractBase

Parameters:

level - The current recursion level for debugging.

bean - The named bean that is the object of the search.

report - A list of NamedBeanUsageReport usage reports.

cdl - The current ConditionalNG bean. Null for Module searches since there is no conditional