Class ConnectionStatusPanel
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JPanel
-
- com.inductiveautomation.ignition.client.util.gui.diagnostics.ConnectionStatusPanel
-
- All Implemented Interfaces:
ConnectionStatusListener
,java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,javax.accessibility.Accessible
public class ConnectionStatusPanel extends javax.swing.JPanel implements ConnectionStatusListener
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
-
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
-
-
Field Summary
Fields Modifier and Type Field Description static java.text.NumberFormat
FORMAT_MILLIS
static LoggerEx
logger
static java.awt.Color
URL_BASE_COLOR
static java.awt.Color
URL_ROLLOVER_COLOR
-
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
-
-
Constructor Summary
Constructors Constructor Description ConnectionStatusPanel(boolean showPingCharts)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
updateNodeRole(java.lang.String newRole)
Informs any listeners that the client's redundancy node role has changed.void
updatePingTime(java.lang.String nodeRole, java.lang.Double pingTime)
Informs listeners about how long the last successful ping operation took to run against the Gateway..void
updateStatus(GatewayInterface gateway, java.lang.String nodeRole, int connectionStatus, java.lang.String projectState, java.lang.String additionalInfo)
Expect this method to be called every few seconds by a timer in the AbstractGatewayConnection.-
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, 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
-
-
-
-
Field Detail
-
FORMAT_MILLIS
public static final java.text.NumberFormat FORMAT_MILLIS
-
logger
public static final LoggerEx logger
-
URL_BASE_COLOR
public static final java.awt.Color URL_BASE_COLOR
-
URL_ROLLOVER_COLOR
public static final java.awt.Color URL_ROLLOVER_COLOR
-
-
Method Detail
-
updateStatus
public void updateStatus(GatewayInterface gateway, java.lang.String nodeRole, int connectionStatus, java.lang.String projectState, java.lang.String additionalInfo)
Description copied from interface:ConnectionStatusListener
Expect this method to be called every few seconds by a timer in the AbstractGatewayConnection. The timer continually tests the status of the master and backup connections. This method also gets fired when a connection changed event occurs for independent connections.- Specified by:
updateStatus
in interfaceConnectionStatusListener
- Parameters:
gateway
- the Gateway address of the connection as a GatewayInterfacenodeRole
- the redundant node role. May be "Master", "Backup", or "" for independent connections.connectionStatus
- one of the Status_* variables in AbstractGatewayConnection, representing the updated connection status.projectState
- applies to redundant system and can be Unknown, Incompatible, OutOfDate, or Good as per the ProjectState enum. Pass in null for unknown project state or non-redundant systems.additionalInfo
- any extra information that can be provided about the status. Connection events tend to have extra info, particularly when Exceptions have been thrown.
-
updateNodeRole
public void updateNodeRole(java.lang.String newRole)
Description copied from interface:ConnectionStatusListener
Informs any listeners that the client's redundancy node role has changed. This affects the how connections are displayed (either Master/Backup mode or Independent mode). The new role could be "Master", "Backup" or "Independent".- Specified by:
updateNodeRole
in interfaceConnectionStatusListener
- Parameters:
newRole
- Name of new role
-
updatePingTime
public void updatePingTime(java.lang.String nodeRole, java.lang.Double pingTime)
Description copied from interface:ConnectionStatusListener
Informs listeners about how long the last successful ping operation took to run against the Gateway..- Specified by:
updatePingTime
in interfaceConnectionStatusListener
- Parameters:
nodeRole
- the redundant node role. May be "Master", "Backup", or "" for independent connections.pingTime
- the number of milliseconds that it took to run the ping. Pass Double.NAN to indicate an error occurred during the ping.
-
-