Package jmri.jmrit.throttle.panels

Class ControlPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jmri.jmrit.throttle.panels.ControlPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, Accessible, AddressListener

Direct Known Subclasses:

LearnControlPanel

public class ControlPanel
extends JPanel
implements PropertyChangeListener, AddressListener

A JPanel that contains a JSlider to control loco speed, and buttons for forward, reverse and STOP. 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
static final int	DEFAULT_BUTTON_SIZE
static final int	SLIDERDISPLAY
static final int	SLIDERDISPLAYCONTINUOUS
static final int	STEPDISPLAY
(package private) jmri.jmrit.throttle.panels.ControlPanel.MyTranscoder	transcoder

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
ControlPanel()	Constructor.
ControlPanel(ThrottleManager tm, boolean withPopupMenu)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	dispose()
int	getDisplaySlider()	Get the value indicating what speed input we're displaying
boolean	getHideSpeedStep()	Get status of hiding speed step selector
JSlider	getSpeedSlider()	Provide direct access to speed slider for scripting.
String	getSwitchSliderFunction()
boolean	getTrackSlider()	Get status of real-time speed slider tracking
org.jdom2.Element	getXml()	Collect the prefs of this object into XML Element Window prefs
boolean	isEnabled()	is this enabled?
boolean	isSpeedControllerAvailable(int displaySlider)	Is this Speed Control selection method possible?
void	notifyAddressChosen(LocoAddress l)	Receive notification that a new address has been selected and validated.
void	notifyAddressReleased(LocoAddress la)	Receive notification that an address has been released/dispatched
void	notifyAddressThrottleFound(DccThrottle t)	Receive notification that a throttle has been found
void	notifyConsistAddressChosen(LocoAddress l)	Receive notification that a new Consist address has been selected.
void	notifyConsistAddressReleased(LocoAddress la)	Receive notification that a consist address has been released/dispatched.
void	notifyConsistAddressThrottleFound(DccThrottle t)	Receive notification that a throttle has been found
void	notifyRosterEntrySelected(RosterEntry re)	Receive notification that a new roster entry has been selected (and not validated yet).
void	propertyChange(PropertyChangeEvent e)
void	saveToRoster(RosterEntry re)
void	setAddressPanel(AddressPanel ap)
void	setEnabled(boolean isEnabled)	Enable/Disable all buttons and slider.
void	setForwardDirection(boolean fwd)	Intended for throttle scripting
void	setHideSpeedStep(boolean hide)	Set hiding speed step selector (or not)
void	setSpeedController(int displaySlider)	Set the Speed Control selection method
void	setSpeedStepsMode(SpeedStepMode speedStepMode)	Set the GUI to match the speed steps of the current address.
void	setSwitchSliderFunction(String fn)
void	setTrackSlider(boolean track)	Set real-time tracking of speed slider, or not
void	setXml(org.jdom2.Element e)	Set the preferences based on the XML Element.
void	stop()	Perform an emergency stop.

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

Field Details

SLIDERDISPLAY

public static final int SLIDERDISPLAY

See Also:

• Constant Field Values

STEPDISPLAY

public static final int STEPDISPLAY

See Also:

• Constant Field Values

SLIDERDISPLAYCONTINUOUS

public static final int SLIDERDISPLAYCONTINUOUS

See Also:

• Constant Field Values

DEFAULT_BUTTON_SIZE

public static final int DEFAULT_BUTTON_SIZE

See Also:

• Constant Field Values

transcoder

jmri.jmrit.throttle.panels.ControlPanel.MyTranscoder transcoder

Constructor Details

ControlPanel

public ControlPanel()

Constructor.

ControlPanel

public ControlPanel(ThrottleManager tm,
 boolean withPopupMenu)

Constructor.

Parameters:

tm - the throttle manager

withPopupMenu - popup menu on control panel available if true

Method Details

setAddressPanel

public void setAddressPanel(AddressPanel ap)

dispose

public void dispose()

setEnabled

public void setEnabled(boolean isEnabled)

Enable/Disable all buttons and slider.

Overrides:

setEnabled in class JComponent

Parameters:

isEnabled - True if the buttons/slider should be enabled, false otherwise.

isEnabled

public boolean isEnabled()

is this enabled?

Overrides:

isEnabled in class Component

Returns:

true if enabled

setSpeedStepsMode

public void setSpeedStepsMode(SpeedStepMode speedStepMode)

Set the GUI to match the speed steps of the current address. Initialises the speed slider and spinner - including setting their maximums based on the speed step setting and the max speed for the particular loco

Parameters:

speedStepMode - Desired speed step mode. One of: SpeedStepMode.NMRA_DCC_128, SpeedStepMode.NMRA_DCC_28, SpeedStepMode.NMRA_DCC_27, SpeedStepMode.NMRA_DCC_14 step mode

isSpeedControllerAvailable

public boolean isSpeedControllerAvailable(int displaySlider)

Is this Speed Control selection method possible?

Parameters:

displaySlider - integer value. possible values: SLIDERDISPLAY = use speed slider display STEPDISPLAY = use speed step display

Returns:

true if speed controller of the selected type is available.

setSpeedController

public void setSpeedController(int displaySlider)

Set the Speed Control selection method

Parameters:

displaySlider - integer value. possible values: SLIDERDISPLAY = use speed slider display STEPDISPLAY = use speed step display

getDisplaySlider

public int getDisplaySlider()

Get the value indicating what speed input we're displaying

Returns:

SLIDERDISPLAY, STEPDISPLAY or SLIDERDISPLAYCONTINUOUS

getSpeedSlider

public JSlider getSpeedSlider()

Provide direct access to speed slider for scripting.

Returns:

the speed slider

setTrackSlider

public void setTrackSlider(boolean track)

Set real-time tracking of speed slider, or not

Parameters:

track - boolean value, true to track, false to set speed on unclick

getTrackSlider

public boolean getTrackSlider()

Get status of real-time speed slider tracking

Returns:

true if slider is tracking.

setHideSpeedStep

public void setHideSpeedStep(boolean hide)

Set hiding speed step selector (or not)

Parameters:

hide - boolean value, true to hide, false to show

getHideSpeedStep

public boolean getHideSpeedStep()

Get status of hiding speed step selector

Returns:

true if speed step selector is hiden.

stop

public void stop()

Perform an emergency stop.

setForwardDirection

public void setForwardDirection(boolean fwd)

Intended for throttle scripting

Parameters:

fwd - direction: true for forward; false for reverse.

propertyChange

public void propertyChange(PropertyChangeEvent e)

Specified by:

propertyChange in interface PropertyChangeListener

getXml

public org.jdom2.Element getXml()

Collect the prefs of this object into XML Element

• Window prefs

Returns:

the XML of this object.

setXml

public void setXml(org.jdom2.Element e)

Set the preferences based on the XML Element.

• Window prefs

Parameters:

e - The Element for this object.

notifyAddressChosen

public void notifyAddressChosen(LocoAddress l)

Description copied from interface: AddressListener

Receive notification that a new address has been selected and validated.

Specified by:

notifyAddressChosen in interface AddressListener

Parameters:

l - The address that is now selected and validated.

notifyRosterEntrySelected

public void notifyRosterEntrySelected(RosterEntry re)

Description copied from interface: AddressListener

Receive notification that a new roster entry has been selected (and not validated yet). In the RosterEntry combobox for example.

Specified by:

notifyRosterEntrySelected in interface AddressListener

Parameters:

re - The roster entry that is now selected.

notifyAddressReleased

public void notifyAddressReleased(LocoAddress la)

Description copied from interface: AddressListener

Receive notification that an address has been released/dispatched

Specified by:

notifyAddressReleased in interface AddressListener

Parameters:

la - The address released/dispatched

notifyAddressThrottleFound

public void notifyAddressThrottleFound(DccThrottle t)

Description copied from interface: AddressListener

Receive notification that a throttle has been found

Specified by:

notifyAddressThrottleFound in interface AddressListener

Parameters:

t - The throttle

notifyConsistAddressChosen

public void notifyConsistAddressChosen(LocoAddress l)

Description copied from interface: AddressListener

Receive notification that a new Consist address has been selected.

Specified by:

notifyConsistAddressChosen in interface AddressListener

Parameters:

l - The address that is now selected.

notifyConsistAddressReleased

public void notifyConsistAddressReleased(LocoAddress la)

Description copied from interface: AddressListener

Receive notification that a consist address has been released/dispatched.

Specified by:

notifyConsistAddressReleased in interface AddressListener

Parameters:

la - The address that is now selected.

notifyConsistAddressThrottleFound

public void notifyConsistAddressThrottleFound(DccThrottle t)

Description copied from interface: AddressListener

Receive notification that a throttle has been found

Specified by:

notifyConsistAddressThrottleFound in interface AddressListener

Parameters:

t - The throttle

setSwitchSliderFunction

public void setSwitchSliderFunction(String fn)

getSwitchSliderFunction

public String getSwitchSliderFunction()

saveToRoster

public void saveToRoster(RosterEntry re)