prajna.gui

Class TimeRuler

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

prajna.gui.TimeRuler

All Implemented Interfaces:

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

public class TimeRuler
extends javax.swing.JComponent
implements TimeSpanWidget

TimeRuler provides a class that marks regular intervals of time. It displays as a horizontal bar, with regular demarcations for each time unit. The actual units measured may be changed as needed. Time labels may optionally be displayed at the beginning and ending of the TimeRuler.

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

Modifier and Type	Field and Description
static int	LABEL_BOTTOM
static int	LABEL_NONE
static int	LABEL_TOP

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
TimeRuler(java.util.Date startDate, java.util.Date stopDate) Creates a new TimeRuler object.
TimeRuler(java.util.Date startDate, java.util.Date stopDate, TimeUnit interval) Creates a new TimeRuler object.

Method Summary

Methods

Modifier and Type	Method and Description
protected TimeSpan	calculateSpan() Recalculates the span of time represented by this TimeRuler.
javax.swing.JComponent	getComponent() Return the Graphical User Interface component used for displaying this TimeRuler.
TimeUnit	getDisplayedInterval() Get the actual increment displayed by this time ruler
TimeSpan	getDisplayedSpan() Get the span of time displayed by this TimeRuler.
int	getLabelLocation() Gets the label location
java.lang.String	getLabelString() Returns the labelString for the TimeRuler.
TimeSpan	getMeasuredSpan() Deprecated.
protected javax.swing.JPanel	makeTicPanel() Creates the panel used for drawing the tic marks, and returns it.
protected void	paintComponent(java.awt.Graphics g) Repaints the TimeRuler on the canvas.
void	setLabelLocation(int labelLocation) Sets the placement of the overall time label.
void	setTimeInterval(TimeUnit interval) Sets the interval used to mark out regular intervals.
void	setTimeSpan(TimeSpan span) Sets the time this TimeRuler measures.

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

Field Detail

LABEL_NONE

public static final int LABEL_NONE

See Also:

Constant Field Values

LABEL_TOP

public static final int LABEL_TOP

See Also:

Constant Field Values

LABEL_BOTTOM

public static final int LABEL_BOTTOM

See Also:

Constant Field Values

Constructor Detail

TimeRuler

public TimeRuler(java.util.Date startDate,
         java.util.Date stopDate)

Creates a new TimeRuler object.

Parameters:

startDate - The start date of this TimeSpan

stopDate - The stop date of this TimeSpan

TimeRuler

public TimeRuler(java.util.Date startDate,
         java.util.Date stopDate,
         TimeUnit interval)

Creates a new TimeRuler object.

Parameters:

startDate - The start date of this TimeSpan

stopDate - The stop date of this TimeSpan

interval - The interval of measure

Method Detail

calculateSpan

protected TimeSpan calculateSpan()

Recalculates the span of time represented by this TimeRuler. This rounds the start time down to the nearest interval, and the stoptime up to the next interval. Thus, if the requested Start Time was 4pm on February 3rd, and the stop time was 6am on February 14th, the actual measured span would be from midnight of Feb 3rd to midnight on Feb 15th (assuming a DAY interval, in this case).

getComponent

public javax.swing.JComponent getComponent()

Return the Graphical User Interface component used for displaying this TimeRuler. This method returns the TimeRuler itself

Specified by:

getComponent in interface TimeSpanWidget

Returns:

the TimeRuler itself

getDisplayedInterval

public TimeUnit getDisplayedInterval()

Get the actual increment displayed by this time ruler

Returns:

the time interval displayed

getDisplayedSpan

public TimeSpan getDisplayedSpan()

Get the span of time displayed by this TimeRuler. The displayed span will include the start and stop times. However, the TimeRuler will round the displayed time span to the previous or next time interval respectively

Specified by:

getDisplayedSpan in interface TimeSpanWidget

Returns:

The TimeSpan for this ruler

getLabelLocation

public int getLabelLocation()

Gets the label location

Returns:

the position of the label relative to the tic marks

getLabelString

public java.lang.String getLabelString()

Returns the labelString for the TimeRuler. This is a string that indicates the time that the TimeRuler measures. It is the same string that is displayed above (or below) the ticMarks.

Returns:

a labelString for the TimeRuler.

getMeasuredSpan

@Deprecated
public TimeSpan getMeasuredSpan()

Deprecated.

Gets the measured span of the TimeRuler. The MeasuredSpan is the actual time represented by the ruler, as it will be rounded to the nearest time interval. The Measured Span will always include the requested time used when the TimeRuler is created.

Returns:

the actual measured span of this TimeRuler

makeTicPanel

protected javax.swing.JPanel makeTicPanel()

Creates the panel used for drawing the tic marks, and returns it.

Returns:

the panel containing the tic marks

paintComponent

protected void paintComponent(java.awt.Graphics g)

Repaints the TimeRuler on the canvas.

Overrides:

paintComponent in class javax.swing.JComponent

Parameters:

g - the graphics context to render into

setLabelLocation

public void setLabelLocation(int labelLocation)

Sets the placement of the overall time label. Valid values are LABEL_NONE, LABEL_TOP, and LABEL_BOTTOM. The default value is LABEL_TOP.

Parameters:

labelLocation - the position of the label for the ruler, relative to the ticMarks

setTimeInterval

public void setTimeInterval(TimeUnit interval)

Sets the interval used to mark out regular intervals. The default value is determined by the span that the ruler displays.

Parameters:

interval - the interval used to mark out regular intervals

setTimeSpan

public void setTimeSpan(TimeSpan span)

Sets the time this TimeRuler measures. The span is modified by the increment, so the actual span may be different than the span specified. Therefore, when retrieving the span of time from a TimeRuler, getMeasuredSpan should be used.

Specified by:

setTimeSpan in interface TimeSpanWidget

Parameters:

span - the new TimeSpan for this ruler