Package jmri.jmrit.display.logixng

Class WindowManagement

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.jmrit.logixng.implementation.AbstractBase

jmri.jmrit.logixng.actions.AbstractDigitalAction

jmri.jmrit.display.logixng.WindowManagement

All Implemented Interfaces:

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

public class WindowManagement
extends AbstractDigitalAction
implements PropertyChangeListener, VetoableChangeListener

This action acts on a Window.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WindowManagement.BringToFrontOrBack
static enum	WindowManagement.HideOrShow
static enum	WindowManagement.MaximizeMinimizeNormalize

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
WindowManagement(String sys, String user)

Method Summary

Modifier and Type	Method	Description
void	disposeMe()	Dispose this class.
void	execute()	Execute this DigitalActionBean.
NamedBeanAddressing	getAddressing()
LogixNG_Category	getCategory()	Get the category.
FemaleSocket	getChild(int index)	Get a child of this item
int	getChildCount()	Get the number of children.
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.
String	getFormula()
JmriJFrame	getJmriJFrame()
String	getJmriJFrameTitle()
String	getLocalVariable()
String	getLongDescription(Locale locale)	Get a long description of this item.
String	getReference()
LogixNG_SelectEnum<WindowManagement.BringToFrontOrBack>	getSelectEnumBringToFrontOrBack()
LogixNG_SelectEnum<WindowManagement.HideOrShow>	getSelectEnumHideOrShow()
LogixNG_SelectEnum<WindowManagement.MaximizeMinimizeNormalize>	getSelectEnumMaximizeMinimizeNormalize()
String	getShortDescription(Locale locale)	Get a short description of this item.
boolean	isIgnoreWindowNotFound()
void	propertyChange(PropertyChangeEvent evt)
void	registerListenersForThisClass()	Register listeners if this object needs that.
void	setAddressing(NamedBeanAddressing addressing)
void	setFormula(String formula)
void	setIgnoreWindowNotFound(boolean ignoreWindowNotFound)
void	setJmriJFrame(String jmriJFrameTitle)
void	setJmriJFrame(JmriJFrame jmriJFrame)
void	setLocalVariable(String localVariable)
void	setReference(String reference)
void	setup()	Setup this object and its children.
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, 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, 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

WindowManagement

public WindowManagement(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

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

getSelectEnumHideOrShow

public LogixNG_SelectEnum<WindowManagement.HideOrShow> getSelectEnumHideOrShow()

getSelectEnumMaximizeMinimizeNormalize

public LogixNG_SelectEnum<WindowManagement.MaximizeMinimizeNormalize> getSelectEnumMaximizeMinimizeNormalize()

getSelectEnumBringToFrontOrBack

public LogixNG_SelectEnum<WindowManagement.BringToFrontOrBack> getSelectEnumBringToFrontOrBack()

setJmriJFrame

public void setJmriJFrame(@CheckForNull
 String jmriJFrameTitle)

setJmriJFrame

public void setJmriJFrame(@CheckForNull
 JmriJFrame jmriJFrame)

getJmriJFrame

public JmriJFrame getJmriJFrame()

getJmriJFrameTitle

public String getJmriJFrameTitle()

setAddressing

public void setAddressing(NamedBeanAddressing addressing)
                   throws ParserException

Throws:

ParserException

getAddressing

public NamedBeanAddressing getAddressing()

setReference

public void setReference(@Nonnull
 String reference)

getReference

public String getReference()

setLocalVariable

public void setLocalVariable(@Nonnull
 String localVariable)

getLocalVariable

public String getLocalVariable()

setFormula

public void setFormula(@Nonnull
 String formula)
                throws ParserException

Throws:

ParserException

getFormula

public String getFormula()

setIgnoreWindowNotFound

public void setIgnoreWindowNotFound(boolean ignoreWindowNotFound)

isIgnoreWindowNotFound

public boolean isIgnoreWindowNotFound()

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

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

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

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener

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