Package jmri.jmrit.swing.meter

Class MeterFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

jmri.util.JmriJFrame

jmri.jmrit.swing.meter.MeterFrame

All Implemented Interfaces:

ComponentListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants, BeanInterface, ModifiedFlag, WindowInterface

public class MeterFrame
extends JmriJFrame

Frame providing a simple LCD-based display of track voltage.

Adapted from ammeter to display voltage and current.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	MeterFrame.SelectMeterAction	Mechanism for acting upon selection of a meter from one of the menu items.
static enum	MeterFrame.Unit

Nested classes/interfaces inherited from class jmri.util.JmriJFrame

JmriJFrame.ScreenDimensions

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

JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

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

Nested classes/interfaces inherited from interface jmri.util.swing.WindowInterface

WindowInterface.Hint

Field Summary

Fields

Modifier and Type	Field	Description
(package private) NamedIcon	ampIcon
(package private) JMenu	currentMetersMenu
(package private) JLabel	decimal
(package private) ArrayList<JLabel>	decimalDigitIcons
(package private) NamedIcon[]	decimalDigits
(package private) Map<Integer,JCheckBoxMenuItem>	decimalDigits_MenuItemMap
(package private) boolean	decimalDot
(package private) NamedIcon	decimalIcon
(package private) int	decimalIconWidth
(package private) int	digitIconWidth
(package private) NamedIcon	errorIcon
(package private) boolean	frameIsInitialized
(package private) int	iconHeight
(package private) ArrayList<JLabel>	integerDigitIcons
(package private) NamedIcon[]	integerDigits
(package private) Map<Integer,JCheckBoxMenuItem>	integerDigits_MenuItemMap
(package private) JLabel	jlDisplayName
(package private) NamedIcon	kiloAmpIcon
(package private) NamedIcon	kiloVoltIcon
(package private) int	lastNumDecimalDigits
(package private) JMenuItem	lastSelectedDecimalDigitsMenuItem
(package private) JMenuItem	lastSelectedIntegerDigitsMenuItem
(package private) JMenuItem	lastSelectedMeterMenuItem
(package private) Map<Meter,JCheckBoxMenuItem>	meter_MenuItemMap
(package private) JPanel	meterPane
(package private) NamedIcon	microAmpIcon
(package private) NamedIcon	microVoltIcon
(package private) NamedIcon	milliAmpIcon
(package private) NamedIcon	milliVoltIcon
(package private) int	numDecimalDigits
(package private) int	numIntegerDigits
(package private) int	oldWidthOfAllIconsToDisplay
(package private) JLayeredPane	pane1
(package private) NamedIcon	percentIcon
(package private) MeterFrame.Unit	selectedUnit
(package private) int	unitIconWidth
(package private) Map<MeterFrame.Unit,JLabel>	unitLabels
(package private) Map<MeterFrame.Unit,JCheckBoxMenuItem>	units_MenuItemMap
(package private) JMenu	voltageMetersMenu
(package private) NamedIcon	voltIcon
(package private) int	widthOfAllIconsToDisplay

Fields inherited from class jmri.util.JmriJFrame

allowInFrameServlet, properties, reuseFrameSavedPosition, reuseFrameSavedSized, windowInterface

Fields inherited from class javax.swing.JFrame

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
MeterFrame()
MeterFrame(UUID uuid)

Method Summary

Modifier and Type	Method	Description
void	dispose()	When window is finally destroyed, remove it from the list of windows.
String	getInitialMeterName()
Meter	getMeter()	Get the meter that is displayed.
int	getNumDecimalDigits()	Get the number of decimal digits.
int	getNumIntegerDigits()	Get the number of integer digits.
MeterFrame.Unit	getUnit()	Get the unit.
UUID	getUUID()	Get the UUID of this frame.
void	initComponents()	By default, Swing components should be created an installed in this method, rather than in the ctor itself.
void	scaleComponents()
void	setInitialMeterName(String initialMeterName)
void	setMeter(Meter m)	Set the meter that is displayed.
void	setNumDecimalDigits(int digits)	Set the number of decimal digits.
void	setNumIntegerDigits(int digits)	Set the number of integer digits.
void	setUnit(MeterFrame.Unit unit)	Set the unit.
(package private) void	update()	Update the displayed value.

Methods inherited from class jmri.util.JmriJFrame

addHelpMenu, componentHidden, componentMoved, componentResized, componentShown, generateWindowRef, getAllowInFrameServlet, getEscapeKeyAction, getEscapeKeyClosesWindow, getFrame, getFrame, getFrameList, getFrameList, getIndexedProperty, getMaximumSize, getModifiedFlag, getPreferredSize, getProperty, getPropertyNames, getSavePosition, getSaveSize, getScreenDimensions, getWindowFrameRef, getWindowInterface, handleModified, hasIndexedProperty, hasProperty, makePrivateWindow, makePublicWindow, markWindowModified, multipleInstances, pack, setAllowInFrameServlet, setEscapeKeyAction, setEscapeKeyClosesWindow, setFrameLocation, setIndexedProperty, setModifiedFlag, setProperty, setSavePosition, setSaveSize, setShutDownTask, setWindowInterface, show, show, storeValues, undecorate, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMinimumSize, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, 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 java.awt.MenuContainer

getFont, postEvent

Field Details

integerDigitIcons

ArrayList<JLabel> integerDigitIcons

decimalDigitIcons

ArrayList<JLabel> decimalDigitIcons

decimal

JLabel decimal

decimalDot

boolean decimalDot

unitLabels

Map<MeterFrame.Unit,JLabel> unitLabels

meter_MenuItemMap

Map<Meter,JCheckBoxMenuItem> meter_MenuItemMap

units_MenuItemMap

Map<MeterFrame.Unit,JCheckBoxMenuItem> units_MenuItemMap

integerDigits_MenuItemMap

Map<Integer,JCheckBoxMenuItem> integerDigits_MenuItemMap

decimalDigits_MenuItemMap

Map<Integer,JCheckBoxMenuItem> decimalDigits_MenuItemMap

lastSelectedMeterMenuItem

JMenuItem lastSelectedMeterMenuItem

lastSelectedIntegerDigitsMenuItem

JMenuItem lastSelectedIntegerDigitsMenuItem

lastSelectedDecimalDigitsMenuItem

JMenuItem lastSelectedDecimalDigitsMenuItem

numIntegerDigits

int numIntegerDigits

numDecimalDigits

int numDecimalDigits

lastNumDecimalDigits

int lastNumDecimalDigits

widthOfAllIconsToDisplay

int widthOfAllIconsToDisplay

oldWidthOfAllIconsToDisplay

int oldWidthOfAllIconsToDisplay

frameIsInitialized

boolean frameIsInitialized

selectedUnit

MeterFrame.Unit selectedUnit

digitIconWidth

int digitIconWidth

decimalIconWidth

int decimalIconWidth

unitIconWidth

int unitIconWidth

iconHeight

int iconHeight

integerDigits

NamedIcon[] integerDigits

decimalDigits

NamedIcon[] decimalDigits

decimalIcon

NamedIcon decimalIcon

microVoltIcon

NamedIcon microVoltIcon

milliVoltIcon

NamedIcon milliVoltIcon

voltIcon

NamedIcon voltIcon

kiloVoltIcon

NamedIcon kiloVoltIcon

microAmpIcon

NamedIcon microAmpIcon

milliAmpIcon

NamedIcon milliAmpIcon

ampIcon

NamedIcon ampIcon

kiloAmpIcon

NamedIcon kiloAmpIcon

percentIcon

NamedIcon percentIcon

errorIcon

NamedIcon errorIcon

pane1

JLayeredPane pane1

meterPane

JPanel meterPane

jlDisplayName

JLabel jlDisplayName

voltageMetersMenu

JMenu voltageMetersMenu

currentMetersMenu

JMenu currentMetersMenu

Constructor Details

MeterFrame

public MeterFrame()

MeterFrame

public MeterFrame(UUID uuid)

Method Details

getUUID

public UUID getUUID()

Get the UUID of this frame.

The UUID is used if two different panel files are loaded with the same meter frame.

Returns:

the UUID of this frame

getMeter

public Meter getMeter()

Get the meter that is displayed.

Returns:

the meter

setMeter

public void setMeter(Meter m)

Set the meter that is displayed.

Parameters:

m - the meter or null if no meter is to be shown

initComponents

public void initComponents()

Description copied from class: JmriJFrame

By default, Swing components should be created an installed in this method, rather than in the ctor itself.

Overrides:

initComponents in class JmriJFrame

scaleComponents

public void scaleComponents()

update

void update()

Update the displayed value. Assumes an integer value has an extra, non-displayed decimal digit.

dispose

public void dispose()

Description copied from class: JmriJFrame

When window is finally destroyed, remove it from the list of windows.

Subclasses that over-ride this method must invoke this implementation with super.dispose() right before returning.

Specified by:

dispose in interface WindowInterface

Overrides:

dispose in class JmriJFrame

getNumIntegerDigits

public int getNumIntegerDigits()

Get the number of integer digits.

Returns:

the number of integer digits

setNumIntegerDigits

public void setNumIntegerDigits(int digits)

Set the number of integer digits.

Parameters:

digits - the number of integer digits

getNumDecimalDigits

public int getNumDecimalDigits()

Get the number of decimal digits.

Returns:

the number of decimal digits

setNumDecimalDigits

public void setNumDecimalDigits(int digits)

Set the number of decimal digits.

Parameters:

digits - the number of decimal digits

getUnit

public MeterFrame.Unit getUnit()

Get the unit.

Returns:

the unit

setUnit

public void setUnit(MeterFrame.Unit unit)

Set the unit.

Parameters:

unit - the unit

getInitialMeterName

public String getInitialMeterName()

setInitialMeterName

public void setInitialMeterName(String initialMeterName)