prajna.gui

Class TimeDisplayControl

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

prajna.gui.TimeDisplayControl

All Implemented Interfaces:

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

public class TimeDisplayControl
extends javax.swing.JPanel
implements TimeDisplay, TimeWidget

GUI Component to control temporal displays. This GUI component includes panes for both real-time and historical time displays. The component also displays the current display time, and other time functions. The TimeDisplayControl is able to control multiple TimeDisplays, allowing synchronized displays in different windows.

The TimeDisplayControl operates in two modes: Real Time and Playback. When in Real-Time mode, the Fade Time and the Purge time may be set; they are displayed in seconds. The Current display time continuously updates. When in playback mode, the control provides a TimeSlider to vary the time displayed.

This class also implements the TimeWidget interface, which allows it to be embedded in other temporal applications.

Author:

Edward Swing

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
TimeDisplayControl() Instantiates a new time display control.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChangeListener(javax.swing.event.ChangeListener listener) Adds a ChangeListener to the slider.
void	addTimeDisplay(TimeDisplay display) Adds the time display to this controller.
protected void	fireStateChanged() Send a ChangeEvent, whose source is this Slider, to each listener.
javax.swing.JComponent	getComponent() Return the Graphical User Interface component used for interacting with this TimeWidget.
java.util.Date	getDisplayTime() Get the current time displayed.
long	getFadeTime() Get the fade time for the temporal display.
long	getPurgeTime() Gets the purge time, which is used to remove stale temporal components.
java.util.Date	getTime() Gets the current time represented by this TimeDisplayControl.
boolean	isRealTime() Returns whether this TimeDisplayControl is currently displaying the Real Time display or the Playback display
void	purgeData() Purge any data which has exceeded the purgeTime.
void	removeChangeListener(javax.swing.event.ChangeListener listener) Removes a ChangeListener from the slider.
void	removeTimeDisplay(TimeDisplay display) Removes the time display.
void	setDisplayTime(java.util.Date time) Set the time currently displayed.
void	setFadeTime(long millis) Set the fade time.
void	setPurgeTime(long millis) Set the purge time.
void	setRealTime(boolean isRealTime) Sets the real time flag.
void	setTime(java.util.Date newTime) Sets the current time for this TimeDisplayControl.

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeDisplayControl

public TimeDisplayControl()

Instantiates a new time display control.

Method Detail

addChangeListener

public void addChangeListener(javax.swing.event.ChangeListener listener)

Adds a ChangeListener to the slider.

Specified by:

addChangeListener in interface TimeWidget

Parameters:

listener - the ChangeListener to add

addTimeDisplay

public void addTimeDisplay(TimeDisplay display)

Adds the time display to this controller. This controller will send time update events to the TimeDisplay, updating its current display time.

Parameters:

display - the timeDisplay

fireStateChanged

protected void fireStateChanged()

Send a ChangeEvent, whose source is this Slider, to each listener.

getComponent

public javax.swing.JComponent getComponent()

Return the Graphical User Interface component used for interacting with this TimeWidget. Simply returns the TimeDisplayControl itself

Specified by:

getComponent in interface TimeWidget

Returns:

this object

getDisplayTime

public java.util.Date getDisplayTime()

Get the current time displayed. The current time is the time that the display represents, not necessarily the actual system time.

Specified by:

getDisplayTime in interface TimeDisplay

Returns:

the current display time

getFadeTime

public long getFadeTime()

Get the fade time for the temporal display. The fade time is used for certain temporal dynamics

Specified by:

getFadeTime in interface TimeDisplay

Returns:

the fade time, in milliseconds.

getPurgeTime

public long getPurgeTime()

Gets the purge time, which is used to remove stale temporal components.

Specified by:

getPurgeTime in interface TimeDisplay

Returns:

the purgeTime, in milliseconds.

getTime

public java.util.Date getTime()

Gets the current time represented by this TimeDisplayControl. Identical to getDisplayTime()

Specified by:

getTime in interface TimeWidget

Returns:

The time represented by this TimeDisplayControl

isRealTime

public boolean isRealTime()

Returns whether this TimeDisplayControl is currently displaying the Real Time display or the Playback display

Specified by:

isRealTime in interface TimeDisplay

Returns:

true if the RealTime display is currently displayed, false otherwise.

purgeData

public void purgeData()

Purge any data which has exceeded the purgeTime. Since the TimeDisplayControl does not actually contain data, this method does nothing

Specified by:

purgeData in interface TimeDisplay

removeChangeListener

public void removeChangeListener(javax.swing.event.ChangeListener listener)

Removes a ChangeListener from the slider.

Specified by:

removeChangeListener in interface TimeWidget

Parameters:

listener - the ChangeListener to remove

removeTimeDisplay

public void removeTimeDisplay(TimeDisplay display)

Removes the time display. The TimeDisplay will no longer receive time updates.

Parameters:

display - the TimeDisplay

setDisplayTime

public void setDisplayTime(java.util.Date time)

Set the time currently displayed.

Specified by:

setDisplayTime in interface TimeDisplay

Parameters:

time - the new current time

setFadeTime

public void setFadeTime(long millis)

Set the fade time. This updates the displayed fade time. Any change to the fade time will be propagated to all of the TimeDisplays this controller controls. If the purgeTime is less than the fade time, it is set to the new fade time.

Specified by:

setFadeTime in interface TimeDisplay

Parameters:

millis - the fade time, in milliseconds.

setPurgeTime

public void setPurgeTime(long millis)

Set the purge time. This updates the displayed purge time. Any change to the fade time will be propagated to all of the TimeDisplays this controller controls. If the purgeTime is less than the fade time, the fade time is set to be equal to the purge time.

Specified by:

setPurgeTime in interface TimeDisplay

Parameters:

millis - the purgeTime in milliseconds

setRealTime

public void setRealTime(boolean isRealTime)

Sets the real time flag. If the real time flag is set, the Real Time pane is visible. The real time thread is started, and all TimeDisplays receive time updates at regular intervals

Specified by:

setRealTime in interface TimeDisplay

Parameters:

isRealTime - the real time flag.

setTime

public void setTime(java.util.Date newTime)

Sets the current time for this TimeDisplayControl. This will also trigger any ChangeListeners. Identical to setDisplayTime()

Specified by:

setTime in interface TimeWidget

Parameters:

newTime - The time this control should represent.