prajna.gui

Class TimeBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

prajna.gui.TimeBar

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

Direct Known Subclasses:

DualTimeBar, ProgressTimeBar, ValueTimeBar

public class TimeBar
extends javax.swing.JComponent

Representation of a sequence of activity. The TimeBar is a JComponent which will draw a horizontal bar of activity. The bar is drawn so that the TimeSpan of the bar takes up the entire width of the component. The sequence of activity (which may include one or more periods of activity) are linearly interpolated, so that the periods of activity are drawn in the foreground color of the component.

The component has no preferred size, so it should be used with Layout Managers that explicitly set the size, or have its size set by the application.

Author:

Edward Swing

See Also:

Serialized Form

Nested Class Summary

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
TimeBar() Creates a new TimeBar object.
TimeBar(Sequential timeSequence) Creates a new TimeBar object.
TimeBar(Sequential timeSequence, java.lang.String name) Creates a new TimeBar object with a name.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getTimeForCoord(int xCoord) Return the time for the specified x coordinate.
Sequential	getTimeSequence() Returns the sequence of events for this timebar.
TimeSpan	getTimeSpan() Returns the time span represented by this timebar
protected int	getXCoord(java.util.Date date) Returns the X coordinate for a particular date for this timebar
protected void	paintComponent(java.awt.Graphics g) Repaints the TimeBar on the canvas.
protected void	paintSpan(java.awt.Graphics g, TimeSpan span, java.awt.Color color) Paint an individual span on this TimeBar in the provided color
void	setTimeSequence(Sequential timeSequence) Sets the sequence of events for this timebar.
void	setTimeSpan(java.util.Date startTime, java.util.Date stopTime) Sets the time span of this timebar.
void	setTimeSpan(TimeSpan span) Sets the time span of this timebar.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, isPaintingOrigin, 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, 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

TimeBar

public TimeBar()

Creates a new TimeBar object.

TimeBar

public TimeBar(Sequential timeSequence)

Creates a new TimeBar object. The TimeSpan of this TimeBar is set to include all time events of the sequence

Parameters:

timeSequence - the sequence of events

TimeBar

public TimeBar(Sequential timeSequence,
       java.lang.String name)

Creates a new TimeBar object with a name. The TimeSpan of this TimeBar is set to include all time events of the sequence

Parameters:

timeSequence - the sequence of events

name - the name for this TimeBar.

Method Detail

getTimeForCoord

public java.util.Date getTimeForCoord(int xCoord)

Return the time for the specified x coordinate. This method simply interpolates the date using the X coordinate and width of the TimeBar

Parameters:

xCoord - the x coordinate

Returns:

the date represented by the coordinate

getTimeSequence

public Sequential getTimeSequence()

Returns the sequence of events for this timebar.

Returns:

the sequence of events for this timebar.

getTimeSpan

public TimeSpan getTimeSpan()

Returns the time span represented by this timebar

Returns:

the time span represented by this timebar

getXCoord

protected int getXCoord(java.util.Date date)

Returns the X coordinate for a particular date for this timebar

Parameters:

date - The date to check

Returns:

the X Coordinate for the date.

paintComponent

protected void paintComponent(java.awt.Graphics g)

Repaints the TimeBar on the canvas. This method uses the button highlight color from the UIManager, and invokes paintSpan on each spen within the time sequence.

Overrides:

paintComponent in class javax.swing.JComponent

Parameters:

g - the graphics context to render into

paintSpan

protected void paintSpan(java.awt.Graphics g,
             TimeSpan span,
             java.awt.Color color)

Paint an individual span on this TimeBar in the provided color

Parameters:

g - the graphics context to render into

span - the timespan to render

color - the color to render the span in. If null, this method uses the current color

setTimeSequence

public void setTimeSequence(Sequential timeSequence)

Sets the sequence of events for this timebar.

Parameters:

timeSequence - the sequence of events for this timebar.

setTimeSpan

public void setTimeSpan(java.util.Date startTime,
               java.util.Date stopTime)

Sets the time span of this timebar. The TimeSpan is the entire time represented by the timebar, not just the active segments.

Parameters:

startTime - The start time of the timespan

stopTime - The end time of the timespan

setTimeSpan

public void setTimeSpan(TimeSpan span)

Sets the time span of this timebar. The TimeSpan is the entire time represented by the timebar, not just the active segments.

Parameters:

span - The timespan for this timebar