prajna.gui

Class TimeSlider

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

prajna.gui.TimeSlider

All Implemented Interfaces:

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

public class TimeSlider
extends javax.swing.JComponent
implements TimeWidget, TimeSpanWidget

The TimeSlider is a slider which interpolates across a range of times. The TimeSlider adds a slider to a TimeRuler, and delegates many of the methods to the internal TimeRuler. A TimeSlider has values that are Dates. The value of the slider is the date represented by the slider, between the start and stop times. The TimeSlider supports ChangeListeners in a similar fashion that a JSlider does.

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
TimeSlider(java.util.Date startDate, java.util.Date stopDate) Creates a new TimeSlider object.
TimeSlider(java.util.Date startDate, java.util.Date stopDate, TimeUnit interval) Creates a new TimeSlider object.
TimeSlider(TimeSpan span) Create a new TimeSlider, using a TimeSpan to specify the time range

Method Summary

Methods

Modifier and Type	Method and Description
void	addChangeListener(javax.swing.event.ChangeListener listener) Adds a ChangeListener to the slider.
protected void	fireStateChanged() Send a ChangeEvent, whose source is this Slider, to each listener.
javax.swing.event.ChangeListener[]	getChangeListeners() Returns an array of all the ChangeListeners added to this TimeSlider with addChangeListener().
javax.swing.JComponent	getComponent() Return the Graphical User Interface component used for interacting with this TimeSlider.
TimeSpan	getDisplayedSpan() Return the time span this time slider measures.
java.util.Date	getTime() Gets the current time represented by this TimeSlider
void	removeChangeListener(javax.swing.event.ChangeListener listener) Removes a ChangeListener from the slider.
void	setTime(java.util.Date newTime) Sets the current time for this TimeSlider.
void	setTimeInterval(TimeUnit interval) Sets the interval used to mark out regular intervals.
void	setTimeSpan(TimeSpan span) Sets the time this TimeSlider 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, paintComponent, 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

TimeSlider

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

Creates a new TimeSlider object.

Parameters:

startDate - The start date of this TimeSpan

stopDate - The stop date of this TimeSpan

TimeSlider

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

Creates a new TimeSlider object.

Parameters:

startDate - The start date of this TimeSpan

stopDate - The stop date of this TimeSpan

interval - The interval of measure

TimeSlider

public TimeSlider(TimeSpan span)

Create a new TimeSlider, using a TimeSpan to specify the time range

Parameters:

span - the time range for the TimeSlider

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

fireStateChanged

protected void fireStateChanged()

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

getChangeListeners

public javax.swing.event.ChangeListener[] getChangeListeners()

Returns an array of all the ChangeListeners added to this TimeSlider with addChangeListener().

Returns:

all of the ChangeListeners added or an empty array if no listeners have been added

getComponent

public javax.swing.JComponent getComponent()

Return the Graphical User Interface component used for interacting with this TimeSlider. This method returns the TimeSlider itself

Specified by:

getComponent in interface TimeSpanWidget

Specified by:

getComponent in interface TimeWidget

Returns:

the TimeSlider itself

getDisplayedSpan

public TimeSpan getDisplayedSpan()

Return the time span this time slider measures. This method returns the actual time span, which is rounded off by the time increment.

Specified by:

getDisplayedSpan in interface TimeSpanWidget

Returns:

The time span of this TimeSlider

getTime

public java.util.Date getTime()

Gets the current time represented by this TimeSlider

Specified by:

getTime in interface TimeWidget

Returns:

The time represented by this TimeSlider

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

setTime

public void setTime(java.util.Date newTime)

Sets the current time for this TimeSlider. This will also trigger any ChangeListeners.

Specified by:

setTime in interface TimeWidget

Parameters:

newTime - The time this slider should represent.

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 TimeSlider 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 displayed, getDisplayedSpan should be used.

Specified by:

setTimeSpan in interface TimeSpanWidget

Parameters:

span - the new TimeSpan for this ruler