shady.common.ui
Class Display.FaultField

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.Box
                  extended by shady.common.ui.Display.Field
                      extended by shady.common.ui.Display.FaultField
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
Enclosing class:
Display

protected abstract class Display.FaultField
extends Display.Field

Displays a fault.

See Also:
Serialized Form

Nested Class Summary
protected  class Display.FaultField.DetailsDialog
          Shows fault details.
 
Nested classes/interfaces inherited from class javax.swing.Box
javax.swing.Box.AccessibleBox, javax.swing.Box.Filler
 
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.FaultField.DetailsDialog detailsDialog
          The Display.FaultField.DetailsDialog.
protected  ShadyCommonAPI shady
          a shady instance so we can look up fault names, if null use enclosing Display's Display.shady, if that's null too then use numbers only
 
Fields inherited from class shady.common.ui.Display.Field
nameLabel, unitsLabel, valueLabel
 
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
protected Display.FaultField()
          Same as Display.FaultField(ShadyCommonAPI), always tries to use enclosing Display's shady.
protected Display.FaultField(int strutWidth, ShadyCommonAPI shady)
          Create a new fault field.
protected Display.FaultField(ShadyCommonAPI shady)
          Same as Display.FaultField(int, ShadyCommonAPI), never uses fixed strut.
 
Method Summary
protected  java.lang.String getDummyValueString()
          Get a dummy value string for preferred size determination.
protected abstract  int getFault()
          Get the fault.
protected abstract  java.lang.String getFaultDetails()
          Get the fault details.
protected  java.lang.String getUnits()
          Get the units to display, null for none.
protected  java.lang.String getValueString()
          Get the value to display.
protected  void showDetails()
          Update and show the details dialog.
protected  void update()
          Update the value displayed from Display.Field.getValueString().
 
Methods inherited from class shady.common.ui.Display.Field
setColor
 
Methods inherited from class javax.swing.Box
createGlue, createHorizontalBox, createHorizontalGlue, createHorizontalStrut, createRigidArea, createVerticalBox, createVerticalGlue, createVerticalStrut, getAccessibleContext, paintComponent, setLayout
 
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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, updateUI
 
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, 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

shady

protected ShadyCommonAPI shady

a shady instance so we can look up fault names, if null use enclosing Display's Display.shady, if that's null too then use numbers only


detailsDialog

protected Display.FaultField.DetailsDialog detailsDialog

The Display.FaultField.DetailsDialog.

Constructor Detail

Display.FaultField

protected Display.FaultField(int strutWidth,
                             ShadyCommonAPI shady)

Create a new fault field.

Parameters:
strutWidth - the distance in pixels between the end of the name label and the start of the value label. If negative then the distance will not be fixed (i.e. it will be glue not strut).
shady - a shady instance so we can look up fault names, if null use enclosing Display's Display.shady, if that's null too then use numbers only

Display.FaultField

protected Display.FaultField(ShadyCommonAPI shady)

Same as Display.FaultField(int, ShadyCommonAPI), never uses fixed strut.


Display.FaultField

protected Display.FaultField()

Same as Display.FaultField(ShadyCommonAPI), always tries to use enclosing Display's shady.

Method Detail

update

protected void update()

Update the value displayed from Display.Field.getValueString().

This impl chains to super then updates detailsDialog iff it's around.

Overrides:
update in class Display.Field

showDetails

protected void showDetails()

Update and show the details dialog.


getFault

protected abstract int getFault()

Get the fault.

Returns:
the fault

getFaultDetails

protected abstract java.lang.String getFaultDetails()

Get the fault details.

Returns:
the fault details

getValueString

protected java.lang.String getValueString()

Get the value to display.

This impl formats getFault() with ShadyCommonAPI.faultName(int).

Specified by:
getValueString in class Display.Field
Returns:
the value to display

getUnits

protected java.lang.String getUnits()

Get the units to display, null for none.

This impl returns null.

Specified by:
getUnits in class Display.Field
Returns:
the units to display, null for none

getDummyValueString

protected java.lang.String getDummyValueString()

Get a dummy value string for preferred size determination.

This impl returns the name of the ShadyCommonAPI.WOULD_MOTION_LIMIT fault.

Specified by:
getDummyValueString in class Display.Field
Returns:
a dummy value string for preferred size determination