Package jmri.jmrit.throttle.implementation

Class ThrottleFrame

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLayeredPane

javax.swing.JDesktopPane

jmri.jmrit.throttle.implementation.ThrottleFrame

All Implemented Interfaces:

ComponentListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ThrottleControllerUI

public class ThrottleFrame
extends JDesktopPane
implements ComponentListener, ThrottleControllerUI

The classic JMRI throttle implementation as a JDesktopPane Class naming is bad but kept for backwards compatibility. This is the main class for the throttle UI, it contains the 4 main panels (address, control, function and speed) as JInternalFrames and manages them. It also manages the Jynstruments that can be added to the throttle frame. 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

Modifier and Type	Class	Description
(package private) class	ThrottleFrame.FrameListener	An extension of InternalFrameAdapter for listening to the closing of of this frame's internal frames.

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

JDesktopPane.AccessibleJDesktopPane

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

JLayeredPane.AccessibleJLayeredPane

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

JComponent.AccessibleJComponent

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

Field Summary

Fields inherited from class javax.swing.JDesktopPane

LIVE_DRAG_MODE, OUTLINE_DRAG_MODE

Fields inherited from class javax.swing.JLayeredPane

DEFAULT_LAYER, DRAG_LAYER, FRAME_CONTENT_LAYER, LAYER_PROPERTY, MODAL_LAYER, PALETTE_LAYER, POPUP_LAYER

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, 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

Constructor Summary

Constructors

Constructor	Description
ThrottleFrame(ThrottleWindow tw)
ThrottleFrame(ThrottleWindow tw, ThrottleManager tm)

Method Summary

Modifier and Type	Method	Description
void	activateNextJInternalFrame()
void	activatePreviousJInternalFrame()
void	addAddressListener(AddressListener l)	Add an address listener to that throttle control UI.
void	componentHidden(ComponentEvent e)
void	componentMoved(ComponentEvent e)
void	componentResized(ComponentEvent e)
void	componentShown(ComponentEvent e)
void	dispatchAddress()	Dispatch that throttle UI, will dispatch for that throttle control UI only.
void	dispose()	Handle my own destruction.
void	eStop()	Emergency stop that throttle
void	forceAddressPanelSelected()
DccLocoAddress	getAddress()	Get that throttle control address
JInternalFrame	getAddressPanelJIF()
JInternalFrame	getControlPanelJIF()
boolean	getEditMode()
JInternalFrame	getFunctionPanelJIF()
RosterEntry	getFunctionRosterEntry()	Get that throttle control roster entry for the function locomotive
DccThrottle	getFunctionThrottle()	Get that throttle control function throttle object (for consists)
JLabel	getLabel()	Get a copy of that throttle control UI label (a text or the roster entry icon, for consits a consist icon will be built from the locomotives in the consist).
RosterEntry	getRosterEntry()	Get that throttle control roster entry
RosterEntrySelectorPanel	getRosterEntrySelector()	Get that throttle control UI roster entry selector panel, or null if that throttle control UI does not have one.
DccThrottle	getThrottle()	Get that throttle control UI throttle object
ThrottleWindow	getThrottleControllersContainer()	Return that throttle control container
org.jdom2.Element	getXml()
org.jdom2.Element	getXmlFile()
boolean	isActive()	Check if that throttle control is active (non null speed and at least one active function)
boolean	isAddressPanelVisible()
boolean	isConsistFunctionsPanelVisible()
boolean	isControlPanelVisible()
boolean	isFunctionPanelVisible()
boolean	isKnownLastUsedSaveFile()
boolean	isKnownRosterEntry()
boolean	isLocoIconPanelVisible()
boolean	isRunning()	Check if that throttle control is running (non null speed)
boolean	isSpeedDisplayContinuous()	Check if that throttle control UI is using continuous speed display (a speed slider from -100 to 100) (Used by external controls like USB game controllers) See SimpleThrottlePanel for an example implementation
boolean	isSpeedPanelVisible()
boolean	isUsingAddress(DccLocoAddress la)	Check if that throttle control is using that address
void	loadThrottleFile(String sfile)	Load that throttle control UI from a throttle file.
void	makeAllComponentsInBounds()
void	removeAddressListener(AddressListener l)	Remove an address listener from that throttle control UI.
void	resetFunctionPanelButton()
void	saveRosterChanges()
void	saveThrottle()
void	saveThrottleAs()
void	setAddress(DccLocoAddress la)	Set that throttle control address
void	setAddressPanelVisible(boolean visible)
void	setConsistAddress(DccLocoAddress la)	Set that throttle consist control address
void	setConsistFunctionsPanelVisible(boolean visible)
void	setControlPanelVisible(boolean visible)
void	setEditMode(boolean mode)
void	setFunctionPanelVisible(boolean visible)
void	setLocation(int x, int y)	Sets the location of a throttle frame on the screen according to x and y coordinates
void	setLocoIconPanelVisible(boolean visible)
void	setRosterEntry(RosterEntry re)	Set that throttle control roster entry
void	setSpeedPanelVisible(boolean visible)
void	setThrottleControllersContainer(ThrottleControllersUIContainer tw)	Set that throttle control container
void	setTitle(String s)
void	setXml(org.jdom2.Element e)
void	toFront()	Bring that throttle UI control to front (window will be activated and raised if it is not already the case).
void	updateFrameTitle()	setFrameTitle - set the frame title based on type, text and address
void	updateGUI()	Update that throttle control UI.
JInternalFrame	ynstrument(String path)

Methods inherited from class javax.swing.JDesktopPane

addImpl, getAccessibleContext, getAllFrames, getAllFramesInLayer, getDesktopManager, getDragMode, getSelectedFrame, getUI, getUIClassID, paramString, remove, remove, removeAll, selectFrame, setComponentZOrder, setDesktopManager, setDragMode, setSelectedFrame, setUI, updateUI

Methods inherited from class javax.swing.JLayeredPane

getComponentCountInLayer, getComponentsInLayer, getComponentToLayer, getIndexOf, getLayer, getLayer, getLayeredPaneAbove, getObjectForLayer, getPosition, highestLayer, insertIndexForLayer, isOptimizedDrawingEnabled, lowestLayer, moveToBack, moveToFront, paint, putLayer, setLayer, setLayer, setPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, 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 jmri.jmrit.throttle.interfaces.ThrottleControllerUI

isVisible

Constructor Details

ThrottleFrame

public ThrottleFrame(ThrottleWindow tw)

ThrottleFrame

public ThrottleFrame(ThrottleWindow tw,
 ThrottleManager tm)

Method Details

getControlPanelJIF

public JInternalFrame getControlPanelJIF()

getAddressPanelJIF

public JInternalFrame getAddressPanelJIF()

getFunctionPanelJIF

public JInternalFrame getFunctionPanelJIF()

updateGUI

public void updateGUI()

Description copied from interface: ThrottleControllerUI

Update that throttle control UI. Called by the throttle core UI when the controlled throttle address or roster entry is updated

Specified by:

updateGUI in interface ThrottleControllerUI

setAddressPanelVisible

public void setAddressPanelVisible(boolean visible)

setControlPanelVisible

public void setControlPanelVisible(boolean visible)

setFunctionPanelVisible

public void setFunctionPanelVisible(boolean visible)

setSpeedPanelVisible

public void setSpeedPanelVisible(boolean visible)

setLocoIconPanelVisible

public void setLocoIconPanelVisible(boolean visible)

setConsistFunctionsPanelVisible

public void setConsistFunctionsPanelVisible(boolean visible)

resetFunctionPanelButton

public void resetFunctionPanelButton()

dispose

public void dispose()

Handle my own destruction.

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

getThrottleControllersContainer

public ThrottleWindow getThrottleControllersContainer()

Description copied from interface: ThrottleControllerUI

Return that throttle control container

Specified by:

getThrottleControllersContainer in interface ThrottleControllerUI

Returns:

the throttle control container

setThrottleControllersContainer

public void setThrottleControllersContainer(ThrottleControllersUIContainer tw)

Description copied from interface: ThrottleControllerUI

Set that throttle control container

Specified by:

setThrottleControllersContainer in interface ThrottleControllerUI

Parameters:

tw - the throttle control container to set

toFront

public void toFront()

Description copied from interface: ThrottleControllerUI

Bring that throttle UI control to front (window will be activated and raised if it is not already the case).

Specified by:

toFront in interface ThrottleControllerUI

setRosterEntry

public void setRosterEntry(RosterEntry re)

Description copied from interface: ThrottleControllerUI

Set that throttle control roster entry

Specified by:

setRosterEntry in interface ThrottleControllerUI

Parameters:

re - the roster entry

getRosterEntry

public RosterEntry getRosterEntry()

Description copied from interface: ThrottleControllerUI

Get that throttle control roster entry

Specified by:

getRosterEntry in interface ThrottleControllerUI

Returns:

the roster entry or null

getFunctionRosterEntry

public RosterEntry getFunctionRosterEntry()

Description copied from interface: ThrottleControllerUI

Get that throttle control roster entry for the function locomotive

Specified by:

getFunctionRosterEntry in interface ThrottleControllerUI

Returns:

the roster entry or null

setAddress

public void setAddress(DccLocoAddress la)

Description copied from interface: ThrottleControllerUI

Set that throttle control address

Specified by:

setAddress in interface ThrottleControllerUI

Parameters:

la - locomotive DccLocoAddress

getAddress

public DccLocoAddress getAddress()

Description copied from interface: ThrottleControllerUI

Get that throttle control address

Specified by:

getAddress in interface ThrottleControllerUI

Returns:

the throttle control address or null

setConsistAddress

public void setConsistAddress(DccLocoAddress la)

Description copied from interface: ThrottleControllerUI

Set that throttle consist control address

Specified by:

setConsistAddress in interface ThrottleControllerUI

Parameters:

la - consist DccLocoAddress

dispatchAddress

public void dispatchAddress()

Description copied from interface: ThrottleControllerUI

Dispatch that throttle UI, will dispatch for that throttle control UI only. Throttle will actully be released only if that throttle control UI is the only one using that address.

Specified by:

dispatchAddress in interface ThrottleControllerUI

isUsingAddress

public boolean isUsingAddress(DccLocoAddress la)

Description copied from interface: ThrottleControllerUI

Check if that throttle control is using that address

Specified by:

isUsingAddress in interface ThrottleControllerUI

Parameters:

la - the DccLocoAddress to check

Returns:

true if that throttle control is using that address, false otherwise

eStop

public void eStop()

Description copied from interface: ThrottleControllerUI

Emergency stop that throttle

Specified by:

eStop in interface ThrottleControllerUI

isRunning

public boolean isRunning()

Description copied from interface: ThrottleControllerUI

Check if that throttle control is running (non null speed)

Specified by:

isRunning in interface ThrottleControllerUI

Returns:

true if that throttle control is running, false otherwise

isActive

public boolean isActive()

Description copied from interface: ThrottleControllerUI

Check if that throttle control is active (non null speed and at least one active function)

Specified by:

isActive in interface ThrottleControllerUI

Returns:

true if that throttle control is active, false otherwise

getThrottle

public DccThrottle getThrottle()

Description copied from interface: ThrottleControllerUI

Get that throttle control UI throttle object

Specified by:

getThrottle in interface ThrottleControllerUI

Returns:

the throttle or null

getFunctionThrottle

public DccThrottle getFunctionThrottle()

Description copied from interface: ThrottleControllerUI

Get that throttle control function throttle object (for consists)

Specified by:

getFunctionThrottle in interface ThrottleControllerUI

Returns:

the function throttle or null

getLabel

public JLabel getLabel()

Description copied from interface: ThrottleControllerUI

Get a copy of that throttle control UI label (a text or the roster entry icon, for consits a consist icon will be built from the locomotives in the consist). See SimpleThrottlePanel for an example implementation

Specified by:

getLabel in interface ThrottleControllerUI

Returns:

the label or null

isSpeedDisplayContinuous

public boolean isSpeedDisplayContinuous()

Description copied from interface: ThrottleControllerUI

Check if that throttle control UI is using continuous speed display (a speed slider from -100 to 100) (Used by external controls like USB game controllers) See SimpleThrottlePanel for an example implementation

Specified by:

isSpeedDisplayContinuous in interface ThrottleControllerUI

Returns:

true if that throttle control UI is using continuous speed display, false otherwise

forceAddressPanelSelected

public void forceAddressPanelSelected()

isAddressPanelVisible

public boolean isAddressPanelVisible()

isControlPanelVisible

public boolean isControlPanelVisible()

isFunctionPanelVisible

public boolean isFunctionPanelVisible()

isSpeedPanelVisible

public boolean isSpeedPanelVisible()

isLocoIconPanelVisible

public boolean isLocoIconPanelVisible()

isConsistFunctionsPanelVisible

public boolean isConsistFunctionsPanelVisible()

isKnownLastUsedSaveFile

public boolean isKnownLastUsedSaveFile()

isKnownRosterEntry

public boolean isKnownRosterEntry()

setTitle

public void setTitle(String s)

saveRosterChanges

public void saveRosterChanges()

getRosterEntrySelector

public RosterEntrySelectorPanel getRosterEntrySelector()

Description copied from interface: ThrottleControllerUI

Get that throttle control UI roster entry selector panel, or null if that throttle control UI does not have one. (Used by external controls like USB game controllers) See SimpleThrottlePanel for an example implementation

Specified by:

getRosterEntrySelector in interface ThrottleControllerUI

Returns:

the roster entry selector panel or null

addAddressListener

public void addAddressListener(AddressListener l)

Description copied from interface: ThrottleControllerUI

Add an address listener to that throttle control UI. See SimpleThrottlePanel for an example implementation

Specified by:

addAddressListener in interface ThrottleControllerUI

Parameters:

l - the address listener to add

removeAddressListener

public void removeAddressListener(AddressListener l)

Description copied from interface: ThrottleControllerUI

Remove an address listener from that throttle control UI. See SimpleThrottlePanel for an example implementation

Specified by:

removeAddressListener in interface ThrottleControllerUI

Parameters:

l - the address listener to remove

setLocation

public void setLocation(int x,
 int y)

Sets the location of a throttle frame on the screen according to x and y coordinates

Overrides:

setLocation in class Component

See Also:

• Component.setLocation(int, int)

componentResized

public void componentResized(ComponentEvent e)

Specified by:

componentResized in interface ComponentListener

componentMoved

public void componentMoved(ComponentEvent e)

Specified by:

componentMoved in interface ComponentListener

componentShown

public void componentShown(ComponentEvent e)

Specified by:

componentShown in interface ComponentListener

componentHidden

public void componentHidden(ComponentEvent e)

Specified by:

componentHidden in interface ComponentListener

ynstrument

public JInternalFrame ynstrument(String path)

makeAllComponentsInBounds

public void makeAllComponentsInBounds()

setEditMode

public void setEditMode(boolean mode)

getEditMode

public boolean getEditMode()

activateNextJInternalFrame

public void activateNextJInternalFrame()

activatePreviousJInternalFrame

public void activatePreviousJInternalFrame()

updateFrameTitle

public void updateFrameTitle()

setFrameTitle - set the frame title based on type, text and address

Specified by:

updateFrameTitle in interface ThrottleControllerUI

getXmlFile

public org.jdom2.Element getXmlFile()

setXml

public void setXml(org.jdom2.Element e)

getXml

public org.jdom2.Element getXml()

saveThrottle

public void saveThrottle()

saveThrottleAs

public void saveThrottleAs()

loadThrottleFile

public void loadThrottleFile(String sfile)

Description copied from interface: ThrottleControllerUI

Load that throttle control UI from a throttle file.

Specified by:

loadThrottleFile in interface ThrottleControllerUI

Parameters:

sfile - the throttle file to load, if null a file chooser will be prompted to select the throttle file to load