ca.spaz.cron.summary
Class SummaryPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  ca.spaz.cron.summary.SummaryPanel

All Implemented Interfaces:

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

Direct Known Subclasses:

SwitchableSummaryPanel

Deprecated. No longer needed for UI.

public abstract class SummaryPanel
extends javax.swing.JPanel

An abstract UI class for display of a set of field values. Supports arbitrary numbers of rows in 3-column displays.

Author:

Chris Rose

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.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

protected	SummaryPanel() Deprecated. Construct a summary panel with the default ordering of components.
protected	SummaryPanel(java.util.Comparator fieldOrdering) Deprecated. Construct a summary panel with the specified number of columns and field ordering.

Method Summary

protected void	addValueField(java.lang.String valueName, java.lang.String valueUnit) Deprecated. Add a new value field to the component.
protected void	addValueField(java.lang.String valueName, java.lang.String labelText, java.lang.String valueUnit) Deprecated. Add a new value field to the component.
protected java.lang.String	doBooleanString(java.lang.String valueName, java.lang.Boolean value) Deprecated. Format a Boolean for display.
protected java.lang.String	doDoubleString(java.lang.String valueName, java.lang.Double value) Deprecated. Format a Double for display.
protected java.lang.String	doGetTextForValue(java.lang.String valueName, java.lang.Object value) Deprecated. Get the label text for a value.
protected java.lang.String	doIntegerString(java.lang.String valueName, java.lang.Integer value) Deprecated. Format a Integer for display.
protected java.lang.String	doString(java.lang.String valueName, java.lang.String value) Deprecated. Format a String for display.
protected abstract void	doValueUpdate(java.lang.String valueName) Deprecated. Subclass-specific behaviour on value settings occurs here.
protected void	generateContentPane() Deprecated. Regenerate the UI components.
boolean	getBooleanValue(java.lang.String valueName) Deprecated. Retrieve a boolean value.
protected javax.swing.JComponent	getContentPane(java.util.List contentValues) Deprecated. Overridable method to select the actual content panel of the display component.
double	getDoubleValue(java.lang.String valueName) Deprecated. Retrieve a double value.
int	getIntValue(java.lang.String valueName) Deprecated. Retrieve an int value.
java.lang.String	getLabelText(java.lang.String valueName) Deprecated.
java.lang.String	getStringValue(java.lang.String valueName) Deprecated. Retrieve a String value.
protected java.lang.String	getText(java.lang.String valueName) Deprecated.
protected java.lang.String	getUnit(java.lang.String valueName) Deprecated. get the unit string for the value, with all the fixings.
protected java.util.List	getValueList() Deprecated. Get a list of the values in this summary panel.
java.lang.String	getValueText(java.lang.String valueName) Deprecated.
protected void	removeValueField(java.lang.String valueName) Deprecated. Purge a value from the component.
void	setValue(java.lang.String valueName, boolean value) Deprecated. Set a boolean value in the value set.
void	setValue(java.lang.String valueName, double value) Deprecated. Set a double value in the value set.
void	setValue(java.lang.String valueName, int value) Deprecated. Set an int value in the value set.
void	setValue(java.lang.String valueName, java.lang.String value) Deprecated. Set a String value in the value set.

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

Constructor Detail

SummaryPanel

protected SummaryPanel()

Deprecated.

Construct a summary panel with the default ordering of components.

SummaryPanel

protected SummaryPanel(java.util.Comparator fieldOrdering)

Deprecated.

Construct a summary panel with the specified number of columns and field ordering.

Parameters:

fieldOrdering - The Comparator to sort the fields with. If null, the field default ordering is the order they are added in.

Method Detail

addValueField

protected final void addValueField(java.lang.String valueName,
                                   java.lang.String valueUnit)

Deprecated.

Add a new value field to the component. Sets a default value of "" (empty string) for the value.

Parameters:

valueName - The name to use for both the label and as the key. Must be unique.

valueUnit - The unit of measure (will be appended to the output value by default).

addValueField

protected final void addValueField(java.lang.String valueName,
                                   java.lang.String labelText,
                                   java.lang.String valueUnit)

Deprecated.

Add a new value field to the component. Sets a default value of "" (empty string) for the value.

Parameters:

valueName - The name to use for both the label and as the key. Must be unique.

labelText - The text to be displayed on the label.

valueUnit - The unit of measure (will be appended to the output value by default).

doBooleanString

protected java.lang.String doBooleanString(java.lang.String valueName,
                                           java.lang.Boolean value)

Deprecated.

Format a Boolean for display. Defaults to toString(), but sublcasses can override this behaviour.

Parameters:

valueName - The name of the value to be formatted.

value - The value to format.

Returns:

a formatted String for value.

doDoubleString

protected java.lang.String doDoubleString(java.lang.String valueName,
                                          java.lang.Double value)

Deprecated.

Format a Double for display. Defaults to toString(), but sublcasses can override this behaviour.

Parameters:

valueName - The name of the value to be formatted.

value - The value to format.

Returns:

a formatted String for value.

doGetTextForValue

protected final java.lang.String doGetTextForValue(java.lang.String valueName,
                                                   java.lang.Object value)

Deprecated.

Get the label text for a value.

Parameters:

valueName - The name of the value to retrieve.

value - The actual value to display.

Returns:

a String with the value name and the value itself formatted according to the policy of this component.

doIntegerString

protected java.lang.String doIntegerString(java.lang.String valueName,
                                           java.lang.Integer value)

Deprecated.

Format a Integer for display. Defaults to toString(), but sublcasses can override this behaviour.

Parameters:

valueName - The name of the value to be formatted.

value - The value to format.

Returns:

a formatted String for value.

doString

protected java.lang.String doString(java.lang.String valueName,
                                    java.lang.String value)

Deprecated.

Format a String for display. Defaults to unmodified, but sublcasses can override this behaviour.

Parameters:

valueName - The name of the value to be formatted.

value - The value to format.

Returns:

a formatted String for value.

getUnit

protected final java.lang.String getUnit(java.lang.String valueName)

Deprecated.

get the unit string for the value, with all the fixings.

Parameters:

valueName - the value to get the unit for.

Returns:

the unit stored in valueSuffixes, or an empty string if there was none.

getText

protected final java.lang.String getText(java.lang.String valueName)

Deprecated.

getValueText

public final java.lang.String getValueText(java.lang.String valueName)

Deprecated.

getLabelText

public final java.lang.String getLabelText(java.lang.String valueName)

Deprecated.

doValueUpdate

protected abstract void doValueUpdate(java.lang.String valueName)

Deprecated.

Subclass-specific behaviour on value settings occurs here. By the time this is called, the value will already be set, but the UI will not have been updated yet. Empty implementations of this are perfectly valid.

Parameters:

valueName - the name of the value that was updated.

getBooleanValue

public final boolean getBooleanValue(java.lang.String valueName)

Deprecated.

Retrieve a boolean value.

Parameters:

valueName - the name of the value to return.

Returns:

the value stored under valueName. False if no boolean stored.

getDoubleValue

public final double getDoubleValue(java.lang.String valueName)

Deprecated.

Retrieve a double value.

Parameters:

valueName - the name of the value to return.

Returns:

the value stored under valueName. Double.NaN if no double stored.

getIntValue

public final int getIntValue(java.lang.String valueName)

Deprecated.

Retrieve an int value.

Parameters:

valueName - the name of the value to return.

Returns:

the value stored under valueName. 0 if no int stored.

getStringValue

public final java.lang.String getStringValue(java.lang.String valueName)

Deprecated.

Retrieve a String value.

Parameters:

valueName - the name of the value to return.

Returns:

the value stored under valueName. Empty string if no object stored.

generateContentPane

protected final void generateContentPane()

Deprecated.

Regenerate the UI components. Call this whenever the return value of getContentPane() would change.

getValueList

protected final java.util.List getValueList()

Deprecated.

Get a list of the values in this summary panel.

Returns:

a List containing all the values in this summary panel.

getContentPane

protected javax.swing.JComponent getContentPane(java.util.List contentValues)

Deprecated.

Overridable method to select the actual content panel of the display component.

Parameters:

contentValues - The list of value tags that will be displayed in this component.

removeValueField

protected final void removeValueField(java.lang.String valueName)

Deprecated.

Purge a value from the component. Removes all versions of it.

Parameters:

valueName -

setValue

public final void setValue(java.lang.String valueName,
                           boolean value)

Deprecated.

Set a boolean value in the value set.

Parameters:

valueName - the name of the value to set.

value - the value to set.

setValue

public final void setValue(java.lang.String valueName,
                           double value)

Deprecated.

Set a double value in the value set.

Parameters:

valueName - the name of the value to set.

value - the value to set.

setValue

public final void setValue(java.lang.String valueName,
                           int value)

Deprecated.

Set an int value in the value set.

Parameters:

valueName - the name of the value to set.

value - the value to set.

setValue

public final void setValue(java.lang.String valueName,
                           java.lang.String value)

Deprecated.

Set a String value in the value set.

Parameters:

valueName - the name of the value to set.

value - the value to set.