Package jmri.jmrit.throttle.implementation

Class SimpleThrottlePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jmri.jmrit.throttle.implementation.SimpleThrottlePanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, ThrottleControllerUI

public class SimpleThrottlePanel
extends JPanel
implements ThrottleControllerUI

A basic throttle panel, with control and function panels only No addressPanel, setAddress() or setConsistAddress() or setRosterEntry() has to be called to initiate a throttle request 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 javax.swing.JPanel

JPanel.AccessibleJPanel

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

Modifier and Type	Field	Description
protected final ThrottleUICore	throuic

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
SimpleThrottlePanel(ThrottleControllersUIContainer stw, ThrottleManager tm, boolean isShowingCtrlPanel, boolean isShowingFnPanel, boolean isShowingIconPanel)

Method Summary

Modifier and Type	Method	Description
void	addAddressListener(AddressListener l)	Add an address listener to that throttle control UI.
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
DccLocoAddress	getAddress()	Get that throttle control address
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
ThrottleControllersUIContainer	getThrottleControllersContainer()	Return that throttle control container
org.jdom2.Element	getXmlFile()
boolean	isActive()	Check if that throttle control is active (non null speed and at least one active function)
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	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	removeAddressListener(AddressListener l)	Remove an address listener from that throttle control UI.
void	saveRosterChanges()
void	setAddress(DccLocoAddress la)	Set that throttle control address
void	setConsistAddress(DccLocoAddress la)	Set that throttle consist control address
void	setLocation(int x, int y)	Sets the location of a throttle frame on the screen according to x and y coordinates
void	setRosterEntry(RosterEntry re)	Set that throttle control roster entry
void	setThrottleControllersContainer(ThrottleControllersUIContainer tw)	Set that throttle control container
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()	Update that throttle control UI containing frame title (if any) with the current address and roster entry.
void	updateGUI()	Update that throttle control UI.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, 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, addImpl, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, 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

Field Details

throuic

protected final ThrottleUICore throuic

Constructor Details

SimpleThrottlePanel

public SimpleThrottlePanel(ThrottleControllersUIContainer stw,
 ThrottleManager tm,
 boolean isShowingCtrlPanel,
 boolean isShowingFnPanel,
 boolean isShowingIconPanel)

Method Details

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

updateFrameTitle

public void updateFrameTitle()

Description copied from interface: ThrottleControllerUI

Update that throttle control UI containing frame title (if any) with the current address and roster entry. Called by the throttle core UI when the controlled throttle address or roster entry is updated to update the frame title with the new information.

Specified by:

updateFrameTitle in interface ThrottleControllerUI

dispose

public void dispose()

Handle my own destruction.

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

getThrottleControllersContainer

public ThrottleControllersUIContainer 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

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

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

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

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

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

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

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)

getXmlFile

public org.jdom2.Element getXmlFile()

setXml

public void setXml(org.jdom2.Element e)

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