org.openlcb.cdi.swing

Class CdiPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.openlcb.cdi.swing.CdiPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class CdiPanel
extends JPanel

Simple example CDI display. Works with a CDI reader.

Author:

Bob Jacobsen Copyright 2011, Paul Bender Copyright 2016, Balazs Racz Copyright 2016

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CdiPanel.EntryPane
class	CdiPanel.EventIdPane
private class	CdiPanel.FindDescriptorVisitor This class descends into a CDI group (usually a group repeat) and tries to find a string field.
class	CdiPanel.GroupPane
static class	CdiPanel.GuiItemFactory Handle GUI hook requests if needed Default behavior is to do nothing
class	CdiPanel.IntPane
private class	CdiPanel.RendererVisitor This class renders the user interface for a config.
private class	CdiPanel.SearchPane
class	CdiPanel.SegmentPane
class	CdiPanel.StringPane
private class	CdiPanel.UpdateGroupNameVisitor This class descends into members of a group recursively and updates the visible names of event fields for their EventTable registration.

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 and Description
private List<CdiPanel.EntryPane>	allEntries
(package private) JPanel	buttonBar
private ArrayList<Runnable>	cleanupTasks
private static Color	COLOR_COPIED
private static Color	COLOR_EDITED
private static Color	COLOR_ERROR
private static Color	COLOR_UNFILLED
private static Color	COLOR_WRITTEN
(package private) JPanel	contentPanel
private Map<String,CdiPanel.EntryPane>	entriesByKey
private static Pattern	entrySuffixRe
private EventTable	eventTable
(package private) CdiPanel.GuiItemFactory	factory
(package private) static JFileChooser	fci We always use the same file chooser in this class, so that the user's last-accessed directory remains available.
(package private) long	lastColorRefreshDone
(package private) long	lastColorRefreshNeeded
(package private) boolean	loadingIsPacked
(package private) PropertyChangeListener	loadingListener
(package private) JPanel	loadingPanel
(package private) JLabel	loadingText
private static Logger	logger
(package private) JButton	moreButton
(package private) JPopupMenu	moreMenu
private String	nodeName
private JButton	reloadButton
private boolean	renderingInProgress
private ConfigRepresentation	rep
(package private) JScrollPane	scrollPane
(package private) CdiPanel.SearchPane	searchPane
private static Pattern	segmentPrefixRe
private ArrayList<Runnable>	startupTasks
private Timer	tabColorTimer
private Map<String,JTabbedPane>	tabsByKey

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 and Description
CdiPanel()

Method Summary

Modifier and Type	Method and Description
void	addButtonToFooter(JComponent c) Adds a button to the bar visible on the bottom line, below the scrollbar.
private void	addButtonToMoreFunctions(JButton b)
private void	addCopyPasteButtons(JPanel linePanel, JTextField textField)
private void	addLoadingListener()
(package private) void	createDescriptionPane(JPanel parent, String d)
(package private) JPanel	createIdentificationPane(CdiRep c)
(package private) void	createLoadingPane()
(package private) JPanel	createPropertyPane(CdiRep.Map map) Creates UI for a properties Map (for segments and groups).
private void	createSensorCreateHelper()
private void	displayCdi()
private void	displayComplete()
private void	displayLoadingProgress()
private void	hideLoadingProgress()
void	initComponents(ConfigRepresentation rep)
void	initComponents(ConfigRepresentation rep, CdiPanel.GuiItemFactory factory)
private void	notifyTabColorRefresh()
private void	performTabColorRefresh(long requestTick)
void	release() Cleans up all property change listeners etc in preparation when closing the window.
void	reloadAll() Refreshes all memory variable entries directly from the hardware node.
private void	removeLoadingListener()
private void	repack()
void	runBackup()
private void	runNowOrLater(Runnable r) If we are still building up the display, then enqueues the callback to run after the rendering is done.
private void	runReboot()
void	runRestore()
private void	runUpdateComplete()
void	saveChanged()
void	setEventTable(String nodeName, EventTable t) Call this function before initComponents in order to use an event table, both for read and write purposes in the UI.
private void	showMoreFunctionsMenu()

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, setEnabled, 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, 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, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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 Detail

logger

private static final Logger logger

COLOR_EDITED

private static final Color COLOR_EDITED

COLOR_UNFILLED

private static final Color COLOR_UNFILLED

COLOR_WRITTEN

private static final Color COLOR_WRITTEN

COLOR_ERROR

private static final Color COLOR_ERROR

segmentPrefixRe

private static final Pattern segmentPrefixRe

entrySuffixRe

private static final Pattern entrySuffixRe

COLOR_COPIED

private static final Color COLOR_COPIED

fci

static JFileChooser fci

We always use the same file chooser in this class, so that the user's last-accessed directory remains available.

rep

private ConfigRepresentation rep

eventTable

private EventTable eventTable

nodeName

private String nodeName

factory

CdiPanel.GuiItemFactory factory

loadingPanel

JPanel loadingPanel

loadingText

JLabel loadingText

loadingListener

PropertyChangeListener loadingListener

reloadButton

private JButton reloadButton

allEntries

private final List<CdiPanel.EntryPane> allEntries

entriesByKey

private final Map<String,CdiPanel.EntryPane> entriesByKey

tabsByKey

private final Map<String,JTabbedPane> tabsByKey

cleanupTasks

private final ArrayList<Runnable> cleanupTasks

startupTasks

private final ArrayList<Runnable> startupTasks

renderingInProgress

private boolean renderingInProgress

loadingIsPacked

boolean loadingIsPacked

scrollPane

JScrollPane scrollPane

contentPanel

JPanel contentPanel

buttonBar

JPanel buttonBar

moreMenu

JPopupMenu moreMenu

moreButton

JButton moreButton

searchPane

CdiPanel.SearchPane searchPane

tabColorTimer

private Timer tabColorTimer

lastColorRefreshNeeded

long lastColorRefreshNeeded

lastColorRefreshDone

long lastColorRefreshDone

Constructor Detail

CdiPanel

public CdiPanel()

Method Detail

release

public void release()

Cleans up all property change listeners etc in preparation when closing the window.

setEventTable

public void setEventTable(String nodeName,
                          EventTable t)

Call this function before initComponents in order to use an event table, both for read and write purposes in the UI.

Parameters:

t - the global event table, coming from the OlcbInterface.

nodeName - is the textual user name of the current node, as represented by SNIP.

initComponents

public void initComponents(ConfigRepresentation rep,
                           CdiPanel.GuiItemFactory factory)

Parameters:

rep - Representation of the config to be loaded

factory - Implements hooks for optional interface elements

createSensorCreateHelper

private void createSensorCreateHelper()

initComponents

public void initComponents(ConfigRepresentation rep)

Parameters:

rep - Representation of the config to be loaded

addButtonToFooter

public void addButtonToFooter(JComponent c)

Adds a button to the bar visible on the bottom line, below the scrollbar.

Parameters:

c - component to add (typically a button)

addButtonToMoreFunctions

private void addButtonToMoreFunctions(JButton b)

showMoreFunctionsMenu

private void showMoreFunctionsMenu()

reloadAll

public void reloadAll()

Refreshes all memory variable entries directly from the hardware node.

saveChanged

public void saveChanged()

runBackup

public void runBackup()

runRestore

public void runRestore()

runReboot

private void runReboot()

runUpdateComplete

private void runUpdateComplete()

notifyTabColorRefresh

private void notifyTabColorRefresh()

removeLoadingListener

private void removeLoadingListener()

addLoadingListener

private void addLoadingListener()

hideLoadingProgress

private void hideLoadingProgress()

displayLoadingProgress

private void displayLoadingProgress()

displayCdi

private void displayCdi()

displayComplete

private void displayComplete()

repack

private void repack()

performTabColorRefresh

private void performTabColorRefresh(long requestTick)

runNowOrLater

private void runNowOrLater(Runnable r)

If we are still building up the display, then enqueues the callback to run after the rendering is done. Otherwise runs the callback inline.

Parameters:

r - callback to run

createLoadingPane

void createLoadingPane()

createIdentificationPane

JPanel createIdentificationPane(CdiRep c)

createPropertyPane

JPanel createPropertyPane(CdiRep.Map map)

Creates UI for a properties Map (for segments and groups).

Parameters:

map - the properties to display

Returns:

panel with UI

createDescriptionPane

void createDescriptionPane(JPanel parent,
                           String d)

addCopyPasteButtons

private void addCopyPasteButtons(JPanel linePanel,
                                 JTextField textField)