edu.wpi.first.smartdashboard.gui

Class DashboardPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

edu.wpi.first.smartdashboard.gui.DashboardPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class DashboardPanel
extends javax.swing.JPanel

This is the main panel, it sits within the DashboardFrame and contains everything the user sees except for the window outline. This class is the workhorse of the GUI. Inside here is where the logic is contained for how to respond to new fields and various other things.

Author:

Joe Grinstead

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

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
DashboardPanel(DashboardFrame frame, ITable table) Instantiates the panel

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(DisplayElement element, java.awt.Point point) Adds the given display element to the screen, putting it at the given point.
void	addField(java.lang.String key) Adds the field of the given name to the screen.
void	addMouseListener(java.awt.event.MouseListener l)
void	addMouseMotionListener(java.awt.event.MouseMotionListener l)
void	addSubsystem(LWSubsystem subsystem) For resetting the LiveWindow.
void	clear() Clears the panel of all of its data, and then reload it.
DisplayElement	findElementContaining(java.awt.Point point) Returns the element that covers the given point.
java.lang.Iterable<DisplayElement>	getElements() Returns all the DisplayElements that are in this panel.
java.lang.Iterable<java.lang.String>	getHiddenFields() Returns the names of all the fields marked as hidden (they are the ones in the ITable that have been explicitly declared to be ignored by the user).
java.util.ArrayList<LWSubsystem>	getSubsystems() Gets the subsystems stored in this panel.
ITable	getTable()
boolean	isEditable() Returns whether or not this panel is editable.
void	removeElement(StaticWidget widget) Removes the given element from the screen.
void	removeField(java.lang.String field) Removes the field with the given name from the screen.
void	removeUnusedFields() Removes all fields which do not have values in the
void	revalidateBacking() Revalidates the content behind the glass pane
void	setEditable(boolean editable) Sets whether or not this panel is editable.
void	setField(java.lang.String key, java.lang.Class<? extends Widget> preferred, DataType type, java.lang.Object value, java.awt.Point point) Sets the field to use the given values.
void	setField(java.lang.String key, java.lang.Class<? extends Widget> preferred, java.lang.Object value, java.awt.Point point) Sets the field to use the given values.
void	setField(java.lang.String key, Widget element, DataType type, java.lang.Object value, java.awt.Point point) Sets the element to use for the given field, removing the current element if one exists for that field.
void	shiftToBack(DisplayElement element) Shifts the given element behind all the other ones.

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

Constructor Detail

DashboardPanel

public DashboardPanel(DashboardFrame frame,
              ITable table)

Instantiates the panel

Method Detail

getTable

public ITable getTable()

addMouseListener

public void addMouseListener(java.awt.event.MouseListener l)

Overrides:

addMouseListener in class java.awt.Component

addMouseMotionListener

public void addMouseMotionListener(java.awt.event.MouseMotionListener l)

Overrides:

addMouseMotionListener in class java.awt.Component

revalidateBacking

public void revalidateBacking()

Revalidates the content behind the glass pane

setEditable

public void setEditable(boolean editable)

Sets whether or not this panel is editable. If the panel becomes editable, then it will pull the focus from the widgets.

Parameters:

editable - whether or not the pane should be editable

isEditable

public boolean isEditable()

Returns whether or not this panel is editable.

Returns:

whether or not this panel is editable

getHiddenFields

public java.lang.Iterable<java.lang.String> getHiddenFields()

Returns the names of all the fields marked as hidden (they are the ones in the ITable that have been explicitly declared to be ignored by the user).

Returns:

the hidden fields

getElements

public java.lang.Iterable<DisplayElement> getElements()

Returns all the DisplayElements that are in this panel.

Returns:

all the elements

clear

public void clear()

Clears the panel of all of its data, and then reload it. This basically starts the panel over from the beginning.

removeUnusedFields

public void removeUnusedFields()

Removes all fields which do not have values in the

removeField

public void removeField(java.lang.String field)

Removes the field with the given name from the screen. The field will then be added to the list of fields which should remain hidden.

Parameters:

field - the field to remove

removeElement

public void removeElement(StaticWidget widget)

Removes the given element from the screen. If you would like to remove a Widget instead of a StaticWidget, then consider using removeField(...)

Parameters:

widget - the widget to remove

shiftToBack

public void shiftToBack(DisplayElement element)

Shifts the given element behind all the other ones. Every other element will then be drawn in front of the given one.

Parameters:

element - the element to shift

addElement

public void addElement(DisplayElement element,
              java.awt.Point point)

Adds the given display element to the screen, putting it at the given point. If the given point is null, then it will find a place to put it. If the point is not null, then the given DisplayElement should already have set its size.

Parameters:

element - the element to add

point - the location to put it (or null, if one needs to be found)

setField

public void setField(java.lang.String key,
            Widget element,
            DataType type,
            java.lang.Object value,
            java.awt.Point point)

Sets the element to use for the given field, removing the current element if one exists for that field. This is used mostly by the load(...) method.

Parameters:

key - the name of the field

element - the element to give to that field

type - the type of the data

value - the value of the data

point - the point to put it

addField

public void addField(java.lang.String key)

Adds the field of the given name to the screen. The field does not need to be in the SmartDashboard table. This will add some default widget (for that type) with no value.

Parameters:

key - the key to add

setField

public void setField(java.lang.String key,
            java.lang.Class<? extends Widget> preferred,
            java.lang.Object value,
            java.awt.Point point)

Sets the field to use the given values.

Parameters:

key - the key of the field

preferred - the preferred widget to use

value - the value of the field (must not be null)

point - the point the widget should be (can be null)

setField

public void setField(java.lang.String key,
            java.lang.Class<? extends Widget> preferred,
            DataType type,
            java.lang.Object value,
            java.awt.Point point)

Sets the field to use the given values.

Parameters:

key - the key of the field

preferred - the preferred widget to use

type - the type of the field

value - the value of the field (can be null)

point - the point the widget should be (can be null)

findElementContaining

public DisplayElement findElementContaining(java.awt.Point point)

Returns the element that covers the given point. It will return the forward most element.

Parameters:

point - the point on the screen

Returns:

the element

getSubsystems

public java.util.ArrayList<LWSubsystem> getSubsystems()

Gets the subsystems stored in this panel.

addSubsystem

public void addSubsystem(LWSubsystem subsystem)

For resetting the LiveWindow.

Parameters:

subsystem - The subsystem to add to this panel's list of subsystems.