shady.common.ui
Class StateDisplay

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  shady.common.ui.Display
                      shady.common.ui.StateDisplay

All Implemented Interfaces:

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

public class StateDisplay
extends Display

Shady state display.

TBD more doc

Target: 1.4 JRE.

Copyright (C) 2006 Marsette A. Vona, III

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Author:

Marsette (Marty) A. Vona, III

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class shady.common.ui.Display

Display.AngleField, Display.BarrelAngleField, Display.BarrelField, Display.BooleanField, Display.CharField, Display.CountField, Display.CurrentField, Display.DecimalField, Display.EnergyField, Display.FaultField, Display.Field, Display.GripperField, Display.PointField, Display.StringField, Display.TimeField, Display.TorqueField, Display.VoltageField

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

protected Display.Field[]	barrelAngleField Shows barrel angle.
protected java.awt.Color[]	barrelColor The barrel colors.
private static java.lang.String	cvsid CVS id.
static double	DEFAULT_FPS Default update frames per second.
protected Display.Field	faultField Shows any fault.
protected Display.Field[]	gripperStateField Shows gripper state.
protected Display.Field	shadeAngleField Shows shade angle.
protected ShadyState	state The intrinsic state of Display.shady.

Fields inherited from class shady.common.ui.Display

DEFAULT_BORDER_PAD, DEFAULT_WIDTH, fields, fps, paused, shady, shadyUI, UNITS_WIDTH

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

StateDisplay(UI ui, ShadyCommonAPI shady, java.awt.Color[] barrelColor)
Create a new state Display.

Method Summary

protected void	addExtraActuatorDisplays() Add extra actuator displays before the common display.
protected void	addExtraFieldsAbove() Hook to add extra fields above the usual ones.
protected void	addExtraFieldsBelow() Hook to add extra fields below the usual ones.
protected javax.swing.JComponent	getBarrelDisplay(int barrel) Get a barrel actuator display.
protected javax.swing.JComponent	getCommonDisplay() Get the common display.
protected double	getDefaultFPS() Get the default frames per sec.
protected javax.swing.JComponent	getGripperDisplay(int gripper) Get a gripper actuator display.
protected void	update() This will be called at Display.getUpdateInterval().
protected void	updateState() Copies state from Display.shady.

Methods inherited from class shady.common.ui.Display

getFPS, getUpdateInterval, isPaused, lockHeight, lockMinimumSize, lockPreferredSize, pause, setBorder, setBorder, setBorder, setFPS, unPause, unPause

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, 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, transferFocusBackward, 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, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

cvsid

private static final java.lang.String cvsid

CVS id.

See Also:

Constant Field Values

DEFAULT_FPS

public static final double DEFAULT_FPS

Default update frames per second.

See Also:

Constant Field Values

barrelAngleField

protected final Display.Field[] barrelAngleField

Shows barrel angle.

gripperStateField

protected final Display.Field[] gripperStateField

Shows gripper state.

shadeAngleField

protected Display.Field shadeAngleField

Shows shade angle.

faultField

protected final Display.Field faultField

Shows any fault.

state

protected ShadyState state

The intrinsic state of Display.shady.

barrelColor

protected final java.awt.Color[] barrelColor

The barrel colors.

Constructor Detail

StateDisplay

public StateDisplay(UI ui,
                    ShadyCommonAPI shady,
                    java.awt.Color[] barrelColor)

Create a new state Display.

Parameters:

ui - the UI that contains this Display

shady - the mechanism to display, not null

barrelColor - the barrel colors

Method Detail

getBarrelDisplay

protected javax.swing.JComponent getBarrelDisplay(int barrel)

Get a barrel actuator display.

Default impl returns the corresp barrelAngleField.

Parameters:

barrel - the barrel

Returns:

the display for barrel

getGripperDisplay

protected javax.swing.JComponent getGripperDisplay(int gripper)

Get a gripper actuator display.

Default impl returns the corresp gripperStateField.

Parameters:

gripper - the gripper

Returns:

the display for gripper

getCommonDisplay

protected javax.swing.JComponent getCommonDisplay()

Get the common display.

Default impl returns a vertical box containing faultField and shadeAngleField.

Returns:

the common display

addExtraActuatorDisplays

protected void addExtraActuatorDisplays()

Add extra actuator displays before the common display.

addExtraFieldsAbove

protected void addExtraFieldsAbove()

Hook to add extra fields above the usual ones.

addExtraFieldsBelow

protected void addExtraFieldsBelow()

Hook to add extra fields below the usual ones.

getDefaultFPS

protected double getDefaultFPS()

Get the default frames per sec.

Overrides:

getDefaultFPS in class Display

Returns:

Display.DEFAULT_FPS

update

protected void update()

This will be called at Display.getUpdateInterval().

Default impl updates any Display.Fields (in Display.fields).

updateState(), then call superclass impl.

Overrides:

update in class Display

updateState

protected void updateState()

Copies state from Display.shady.