jmri.jmrit.throttle
Class FunctionPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JInternalFrame
                  jmri.jmrit.throttle.FunctionPanel

All Implemented Interfaces:

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

public class FunctionPanel
extends JInternalFrame
implements FunctionListener, PropertyChangeListener, AddressListener

A JInternalFrame that contains buttons for each decoder function.

See Also:

Serialized Form

Nested Class Summary

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

JInternalFrame.AccessibleJInternalFrame, JInternalFrame.JDesktopIcon

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

static int	NUM_FUNC_BUTTONS_INIT
static int	NUM_FUNCTION_BUTTONS

Fields inherited from class javax.swing.JInternalFrame

closable, CONTENT_PANE_PROPERTY, desktopIcon, FRAME_ICON_PROPERTY, frameIcon, GLASS_PANE_PROPERTY, iconable, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, isClosed, isIcon, isMaximum, isSelected, LAYERED_PANE_PROPERTY, maximizable, MENU_BAR_PROPERTY, resizable, ROOT_PANE_PROPERTY, rootPane, rootPaneCheckingEnabled, title, TITLE_PROPERTY

Fields inherited from class javax.swing.JComponent

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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

FunctionPanel()
Constructor

Method Summary

void	buttonActionCmdPerformed()
void	destroy()
FunctionButton[]	getFunctionButtons()
Element	getXml() Collect the prefs of this object into XML Element Window prefs Each button has id, text, lock state.
void	notifyAddressChosen(int newAddress, boolean isLong) Receive notification that a new address has been selected.
void	notifyAddressReleased(int address, boolean isLong) Receive notification that an address has been released/dispatched
void	notifyAddressThrottleFound(DccThrottle t) Get notification that a throttle has been found as we requested.
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	propertyChange(PropertyChangeEvent e)
void	resetFnButtons() Make sure that all function buttons are being displayed if buttons label loaded from a roster entry, update buttons accordingly
void	saveFunctionButtonsToRoster(RosterEntry rosterEntry)
void	setAddressPanel(AddressPanel addressPanel)
void	setEnabled()
void	setEnabled(boolean isEnabled) Enable or disable all the buttons
void	setXml(Element e) Set the preferences based on the XML Element.

Methods inherited from class javax.swing.JInternalFrame

addImpl, addInternalFrameListener, createRootPane, dispose, doDefaultCloseAction, fireInternalFrameEvent, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLastCursor, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isRootPaneCheckingEnabled, isSelected, moveToBack, moveToFront, pack, paintComponent, paramString, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setCursor, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setRootPane, setRootPaneCheckingEnabled, setSelected, setTitle, setUI, show, toBack, toFront, 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, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, 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, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

NUM_FUNCTION_BUTTONS

public static final int NUM_FUNCTION_BUTTONS

See Also:

Constant Field Values

NUM_FUNC_BUTTONS_INIT

public static final int NUM_FUNC_BUTTONS_INIT

See Also:

Constant Field Values

Constructor Detail

FunctionPanel

public FunctionPanel()

Constructor

Method Detail

destroy

public void destroy()

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 (0-9).

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

setEnabled

public void setEnabled()

setAddressPanel

public void setAddressPanel(AddressPanel addressPanel)

saveFunctionButtonsToRoster

public void saveFunctionButtonsToRoster(RosterEntry rosterEntry)

buttonActionCmdPerformed

public void buttonActionCmdPerformed()

resetFnButtons

public void resetFnButtons()

Make sure that all function buttons are being displayed if buttons label loaded from a roster entry, update buttons accordingly

propertyChange

public void propertyChange(PropertyChangeEvent e)

Specified by:

propertyChange in interface PropertyChangeListener

getXml

public 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(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)

Get notification that a throttle has been found as we requested. Use reflection to find the proper getF? method for each button.

Specified by:

notifyAddressThrottleFound in interface AddressListener

Parameters:

t - An instantiation of the DccThrottle with the address requested.

notifyAddressReleased

public void notifyAddressReleased(int address,
                                  boolean isLong)

Description copied from interface: AddressListener

Receive notification that an address has been released/dispatched

Specified by:

notifyAddressReleased in interface AddressListener

Parameters:

address - The address released/dispatched

notifyAddressChosen

public void notifyAddressChosen(int newAddress,
                                boolean isLong)

Description copied from interface: AddressListener

Receive notification that a new address has been selected.

Specified by:

notifyAddressChosen in interface AddressListener

Parameters:

newAddress - The address that is now selected.