Package jmri.jmrit.throttle

Class ThrottleWindow

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

jmri.util.JmriJFrame

jmri.jmrit.throttle.ThrottleWindow

All Implemented Interfaces:

ComponentListener, WindowListener, ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants, BeanInterface, ThrottleControllersUIContainer, ModifiedFlag, WindowInterface

public class ThrottleWindow
extends JmriJFrame
implements ThrottleControllersUIContainer, PropertyChangeListener

The JMRI throttle window. This file is part of JMRI.

JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.

JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class jmri.util.JmriJFrame

JmriJFrame.ScreenDimensions

Nested classes/interfaces inherited from class javax.swing.JFrame

JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Nested classes/interfaces inherited from interface jmri.util.swing.WindowInterface

WindowInterface.Hint

Field Summary

Fields

Modifier and Type	Field	Description
(package private) PropertyChangeSupport	pcs

Fields inherited from class jmri.util.JmriJFrame

allowInFrameServlet, properties, reuseFrameSavedPosition, reuseFrameSavedSized, windowInterface

Fields inherited from class javax.swing.JFrame

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
ThrottleWindow()	Default constructor
ThrottleWindow(ConnectionConfig connectionConfig)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener l)
void	addThrottleControllerAt(ThrottleControllerUI tp, int idx)	Adds an existing throttle controller to that container list at position n
static ThrottleWindow	createThrottleWindow(org.jdom2.Element e)	Create a ThrottleWindow
void	dispose()	Handle my own destruction.
void	emergencyStopAll()	Force estop all throttles managed by that controllers container
ThrottleFrame	getCurentThrottleController()	Get the throttle controller being used now (or on top)
int	getNbThrottlesControllers()	Return the number of active thottle frames.
int	getNumberOfEntriesFor(DccLocoAddress la)	Get the number of usages of a particular Loco Address.
ThrottleControllerUI	getThrottleControllerAt(int n)	Return the nth thottle frame of that throttle window
String	getTitleText()
String	getTitleTextType()
JCheckBoxMenuItem	getViewAddressPanel()
JCheckBoxMenuItem	getViewConsistFunctionsPanel()
JCheckBoxMenuItem	getViewControlPanel()
JCheckBoxMenuItem	getViewFunctionPanel()
JCheckBoxMenuItem	getViewLocoIconPanel()
JCheckBoxMenuItem	getViewSpeedPanel()
org.jdom2.Element	getXml()
boolean	isEditMode()
ThrottleControllerUI	newThrottleController()	Created a new throttle controller
void	nextRunningThrottleFrame()	Set next running (with non null speed) throttle frame as current frame.
void	nextThrottleFrame()	Set next throttle frame as current frame.
void	nextThrottleFrameWithActiveFunction()	Set next throttle frame with active function (at least one function ON) or non null speed as current frame.
void	previousRunningThrottleFrame()	Set previous running (with non null speed) throttle frame as current frame.
void	previousThrottleFrame()	Set previous throttle frame as current frame.
void	previousThrottleFrameWithActiveFunction()	Set previous throttle frame with active function (at least one function ON) or non null speed as current frame.
void	propertyChange(PropertyChangeEvent evt)
void	removePropertyChangeListener(PropertyChangeListener l)
void	removeThrottleController(ThrottleControllerUI tf)	Remove a throttle controller from that container
void	setCurrentThrottleFrame(ThrottleFrame tf)
void	setEditMode(boolean mode)
void	setTitle(String title)
void	setTitleText(String titleText)
void	setTitleTextType(String titleTextType)
void	toFront(String throttleFrameTitle)
void	updateGUI()
Jynstrument	ynstrument(String path)

Methods inherited from class jmri.util.JmriJFrame

addHelpMenu, componentHidden, componentMoved, componentResized, componentShown, generateWindowRef, getAllowInFrameServlet, getEscapeKeyAction, getEscapeKeyClosesWindow, getFrame, getFrame, getFrameList, getFrameList, getIndexedProperty, getMaximumSize, getModifiedFlag, getPreferredSize, getProperty, getPropertyNames, getSavePosition, getSaveSize, getScreenDimensions, getWindowFrameRef, getWindowInterface, handleModified, hasIndexedProperty, hasProperty, initComponents, makePrivateWindow, makePublicWindow, markWindowModified, multipleInstances, pack, setAllowInFrameServlet, setEscapeKeyAction, setEscapeKeyClosesWindow, setFrameLocation, setIndexedProperty, setModifiedFlag, setProperty, setSavePosition, setSaveSize, setShutDownTask, setWindowInterface, show, show, storeValues, undecorate, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMinimumSize, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Details

pcs

PropertyChangeSupport pcs

Constructor Details

ThrottleWindow

public ThrottleWindow()

Default constructor

ThrottleWindow

public ThrottleWindow(ConnectionConfig connectionConfig)

Constructor

Parameters:

connectionConfig - the connection config

Method Details

createThrottleWindow

public static ThrottleWindow createThrottleWindow(org.jdom2.Element e)

Create a ThrottleWindow

Parameters:

e - the xml element for the throttle window

Returns:

the throttle window

updateGUI

public void updateGUI()

getNbThrottlesControllers

public int getNbThrottlesControllers()

Return the number of active thottle frames.

Specified by:

getNbThrottlesControllers in interface ThrottleControllersUIContainer

Returns:

the number of active thottle frames.

getThrottleControllerAt

public ThrottleControllerUI getThrottleControllerAt(int n)

Return the nth thottle frame of that throttle window

Specified by:

getThrottleControllerAt in interface ThrottleControllersUIContainer

Parameters:

n - index of thr throtle frame

Returns:

the nth thottle frame of that throttle window

getNumberOfEntriesFor

public int getNumberOfEntriesFor(@CheckForNull
 DccLocoAddress la)

Get the number of usages of a particular Loco Address.

Specified by:

getNumberOfEntriesFor in interface ThrottleControllersUIContainer

Parameters:

la - the Loco Address, can be null.

Returns:

0 if no usages, else number of AddressPanel usages.

emergencyStopAll

public void emergencyStopAll()

Description copied from interface: ThrottleControllersUIContainer

Force estop all throttles managed by that controllers container

Specified by:

emergencyStopAll in interface ThrottleControllersUIContainer

setTitle

public void setTitle(String title)

Overrides:

setTitle in class Frame

setEditMode

public void setEditMode(boolean mode)

isEditMode

public boolean isEditMode()

ynstrument

public Jynstrument ynstrument(String path)

dispose

public void dispose()

Handle my own destruction.

1. dispose of sub windows.
2. notify my manager of my demise.

Specified by:

dispose in interface ThrottleControllersUIContainer

Specified by:

dispose in interface WindowInterface

Overrides:

dispose in class JmriJFrame

getViewControlPanel

public JCheckBoxMenuItem getViewControlPanel()

getViewFunctionPanel

public JCheckBoxMenuItem getViewFunctionPanel()

getViewAddressPanel

public JCheckBoxMenuItem getViewAddressPanel()

getViewSpeedPanel

public JCheckBoxMenuItem getViewSpeedPanel()

getViewLocoIconPanel

public JCheckBoxMenuItem getViewLocoIconPanel()

getViewConsistFunctionsPanel

public JCheckBoxMenuItem getViewConsistFunctionsPanel()

getCurentThrottleController

public ThrottleFrame getCurentThrottleController()

Description copied from interface: ThrottleControllersUIContainer

Get the throttle controller being used now (or on top)

Specified by:

getCurentThrottleController in interface ThrottleControllersUIContainer

Returns:

the throttle controller

setCurrentThrottleFrame

public void setCurrentThrottleFrame(ThrottleFrame tf)

removeThrottleController

public void removeThrottleController(ThrottleControllerUI tf)

Description copied from interface: ThrottleControllersUIContainer

Remove a throttle controller from that container

Specified by:

removeThrottleController in interface ThrottleControllersUIContainer

Parameters:

tf - the throttle controller to add

nextThrottleFrame

public void nextThrottleFrame()

Set next throttle frame as current frame. If the current frame is the only one, then do nothing.

previousThrottleFrame

public void previousThrottleFrame()

Set previous throttle frame as current frame. If the current frame is the only one, then do nothing.

nextRunningThrottleFrame

public void nextRunningThrottleFrame()

Set next running (with non null speed) throttle frame as current frame. If the current frame is the only one running, then do nothing.

previousRunningThrottleFrame

public void previousRunningThrottleFrame()

Set previous running (with non null speed) throttle frame as current frame. If the current frame is the only one running, then do nothing.

nextThrottleFrameWithActiveFunction

public void nextThrottleFrameWithActiveFunction()

Set next throttle frame with active function (at least one function ON) or non null speed as current frame. If the current frame is the only one with active function, then do nothing.

previousThrottleFrameWithActiveFunction

public void previousThrottleFrameWithActiveFunction()

Set previous throttle frame with active function (at least one function ON) or non null speed as current frame. If the current frame is the only one with active function, then do nothing.

addThrottleControllerAt

public void addThrottleControllerAt(ThrottleControllerUI tp,
 int idx)

Description copied from interface: ThrottleControllersUIContainer

Adds an existing throttle controller to that container list at position n

Specified by:

addThrottleControllerAt in interface ThrottleControllersUIContainer

Parameters:

tp - the throttle controller to add

idx - position that it will inserted at

newThrottleController

public ThrottleControllerUI newThrottleController()

Description copied from interface: ThrottleControllersUIContainer

Created a new throttle controller

Specified by:

newThrottleController in interface ThrottleControllersUIContainer

Returns:

the newly created throttle controller

toFront

public void toFront(String throttleFrameTitle)

getTitleTextType

public String getTitleTextType()

getTitleText

public String getTitleText()

setTitleText

public void setTitleText(String titleText)

setTitleTextType

public void setTitleTextType(String titleTextType)

getXml

public org.jdom2.Element getXml()

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Overrides:

addPropertyChangeListener in class Window

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Overrides:

removePropertyChangeListener in class Component

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener