Package jmri.jmrix

Class AbstractMonFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

jmri.util.JmriJFrame

jmri.jmrix.AbstractMonFrame

All Implemented Interfaces:

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

Direct Known Subclasses:

AcelaMonFrame, DCCppMonFrame, EasyDccMonFrame, MonitorFrame, QsiMonFrame, RpsMonFrame, SerialMonFrame, SerialMonFrame, SerialMonFrame, SerialMonFrame, SerialMonFrame, SerialMonFrame, SprogConsoleFrame, SprogMonFrame

public abstract class AbstractMonFrame
extends JmriJFrame

Abstract base class for Frames displaying communications monitor information.

See Also:

• Serialized Form

Nested Class Summary

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
protected JCheckBox	alwaysOnTopCheckBox
protected JCheckBox	autoScrollCheckBox
protected JButton	clearButton
(package private) DateFormat	df
protected JButton	enterButton
protected JTextField	entryField
protected JToggleButton	freezeButton
protected JScrollPane	jScrollPane1
(package private) StringBuffer	linesBuffer
final JFileChooser	logFileChooser
protected TextAreaFIFO	monTextPane
(package private) String	newline
protected JButton	openFileChooserButton
protected JCheckBox	rawCheckBox
(package private) final AbstractMonFrame	self
protected JButton	startLogButton
protected JButton	stopLogButton
protected JCheckBox	timeCheckBox
UserPreferencesManager	userPrefs

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

Method Summary

Modifier and Type	Method	Description
void	clearButtonActionPerformed(ActionEvent e)
void	dispose()	When window is finally destroyed, remove it from the list of windows.
void	enterButtonActionPerformed(ActionEvent e)
protected JPanel	getActionButtonsPanel()
protected JPanel	getCheckBoxPanel()
protected JPanel	getLogToFilePanel()
final JTextArea	getTextArea()	Get access to the main text area.
protected abstract void	init()	Initialize the data source.
void	initComponents()	By default, Swing components should be created an installed in this method, rather than in the ctor itself.
void	nextLine(String line, String raw)	Handle display of traffic.
void	openFileChooserButtonActionPerformed(ActionEvent e)
protected void	setHelp()	Define help menu for this window.
void	startLogButtonActionPerformed(ActionEvent e)
void	stopLogButtonActionPerformed(ActionEvent e)
protected abstract String	title()

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

clearButton

protected JButton clearButton

freezeButton

protected JToggleButton freezeButton

jScrollPane1

protected JScrollPane jScrollPane1

monTextPane

protected TextAreaFIFO monTextPane

startLogButton

protected JButton startLogButton

stopLogButton

protected JButton stopLogButton

rawCheckBox

protected JCheckBox rawCheckBox

timeCheckBox

protected JCheckBox timeCheckBox

alwaysOnTopCheckBox

protected JCheckBox alwaysOnTopCheckBox

autoScrollCheckBox

protected JCheckBox autoScrollCheckBox

openFileChooserButton

protected JButton openFileChooserButton

entryField

protected JTextField entryField

enterButton

protected JButton enterButton

userPrefs

public UserPreferencesManager userPrefs

self

final AbstractMonFrame self

logFileChooser

public final JFileChooser logFileChooser

newline

String newline

df

DateFormat df

linesBuffer

StringBuffer linesBuffer

Constructor Details

AbstractMonFrame

public AbstractMonFrame()

Method Details

title

protected abstract String title()

init

protected abstract void init()

Initialize the data source.

This is invoked at the end of the GUI initialization phase. Subclass implementations should connect to their data source here.

dispose

@OverridingMethodsMustInvokeSuper
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

initComponents

public void initComponents()

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

Overrides:

initComponents in class JmriJFrame

getCheckBoxPanel

protected JPanel getCheckBoxPanel()

getActionButtonsPanel

protected JPanel getActionButtonsPanel()

getLogToFilePanel

protected JPanel getLogToFilePanel()

setHelp

protected void setHelp()

Define help menu for this window.

By default, provides a generic help page that covers general features. Specific implementations can override this to show their own help page if desired.

nextLine

public void nextLine(String line,
 String raw)

Handle display of traffic.

Parameters:

line - is the traffic in 'normal form'. Should end with \n

raw - is the "raw form" , should NOT end with \n

clearButtonActionPerformed

public void clearButtonActionPerformed(ActionEvent e)

startLogButtonActionPerformed

public void startLogButtonActionPerformed(ActionEvent e)

stopLogButtonActionPerformed

public void stopLogButtonActionPerformed(ActionEvent e)

openFileChooserButtonActionPerformed

public void openFileChooserButtonActionPerformed(ActionEvent e)

enterButtonActionPerformed

public void enterButtonActionPerformed(ActionEvent e)

getTextArea

public final JTextArea getTextArea()

Get access to the main text area. This is intended for use in e.g. scripting to extend the behaviour of the window.

Returns:

the text area.