Package jmri.jmrit.throttle.panels

Class FunctionPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jmri.util.swing.OptionallyTabbedPanel

jmri.jmrit.throttle.panels.FunctionPanel

All Implemented Interfaces:

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

Direct Known Subclasses:

LearnFunctionPanel

public class FunctionPanel
extends OptionallyTabbedPanel
implements FunctionListener, PropertyChangeListener, AddressListener

A Panel that contains buttons for each decoder function. 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 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
FunctionPanel()
FunctionPanel(boolean withPopupMenu)	Constructor

Method Summary

Modifier and Type	Method	Description
void	dispose()
FunctionButton[]	getFunctionButtons()
org.jdom2.Element	getXml()	Collect the prefs of this object into XML Element.
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	notifyFunctionLockableChanged(int functionNumber, boolean isLockable)	Get notification that a function's lockable status has changed.
void	notifyFunctionStateChanged(int functionNumber, boolean isSet)	Get notification that a function has changed state.
void	notifyRosterEntrySelected(RosterEntry re)	Receive notification that a new roster entry has been selected (and not validated yet).
void	propertyChange(PropertyChangeEvent e)	Update the state of this panel if any of the functions change.
void	resetFnButtons()	Reset function buttons : - rebuild function buttons - reset their properties to default - update according to throttle and roster (if any)
void	saveFunctionButtonsToRoster(RosterEntry rosterEntry)
void	setAddressPanel(AddressPanel ap)
void	setEnabled()	Enable or disable all the buttons depending on throttle status If a throttle is assigned, enable all, else disable all
void	setEnabled(boolean isEnabled)	Enable or disable all the buttons.
void	setXml(org.jdom2.Element e)	Set the preferences based on the XML Element.

Methods inherited from class jmri.util.swing.OptionallyTabbedPanel

add, removeAll

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

Constructor Details

FunctionPanel

public FunctionPanel(boolean withPopupMenu)

Constructor

Parameters:

withPopupMenu - popup menu on function button available if true

FunctionPanel

public FunctionPanel()

Method Details

dispose

public void dispose()

getFunctionButtons

public FunctionButton[] getFunctionButtons()

notifyFunctionStateChanged

public void notifyFunctionStateChanged(int functionNumber,
 boolean isSet)

Get notification that a function has changed state.

Specified by:

notifyFunctionStateChanged in interface FunctionListener

Parameters:

functionNumber - The function that has changed.

isSet - True if the function is now active (or set).

notifyFunctionLockableChanged

public void notifyFunctionLockableChanged(int functionNumber,
 boolean isLockable)

Get notification that a function's lockable status has changed.

Specified by:

notifyFunctionLockableChanged in interface FunctionListener

Parameters:

functionNumber - The function that has changed (0-28).

isLockable - True if the function is now Lockable (continuously active).

setEnabled

public void setEnabled(boolean isEnabled)

Enable or disable all the buttons.

Overrides:

setEnabled in class JComponent

Parameters:

isEnabled - true to enable, false to disable.

setEnabled

public void setEnabled()

Enable or disable all the buttons depending on throttle status If a throttle is assigned, enable all, else disable all

setAddressPanel

public void setAddressPanel(AddressPanel ap)

saveFunctionButtonsToRoster

public void saveFunctionButtonsToRoster(RosterEntry rosterEntry)

resetFnButtons

public void resetFnButtons()

Reset function buttons : - rebuild function buttons - reset their properties to default - update according to throttle and roster (if any)

propertyChange

public void propertyChange(PropertyChangeEvent e)

Update the state of this panel if any of the functions change.

Specified by:

propertyChange in interface PropertyChangeListener

getXml

public org.jdom2.Element getXml()

Collect the prefs of this object into XML Element.

• Window prefs
• Each button has id, text, lock state.

Returns:

the XML of this object.

setXml

public void setXml(org.jdom2.Element e)

Set the preferences based on the XML Element.

• Window prefs
• Each button has id, text, lock state.

Parameters:

e - The Element for this object.

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

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

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.

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