prajna.gui

Interface TimeSpanWidget

All Known Implementing Classes:

TimeRuler, TimeSlider

public interface TimeSpanWidget

Interface for GUI components which represent a span of time. Implementations of this class can include temporal rulers or interactive components

Author:

Edward Swing

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.JComponent	getComponent() Return the Graphical User Interface component used for displaying the TimeSpan or interacting with this component.
TimeSpan	getDisplayedSpan() Return the time span this time slider measures.
void	setTimeSpan(TimeSpan span) Sets the time this TimeSpanWidget measures.

Method Detail

getComponent

javax.swing.JComponent getComponent()

Return the Graphical User Interface component used for displaying the TimeSpan or interacting with this component. For JComponents which implement this interface, this method should simply return the component itself.

Returns:

the component used to render the interface for this TimeSpanWidget

getDisplayedSpan

TimeSpan getDisplayedSpan()

Return the time span this time slider measures. This method returns the actual time span displayedby the widget, which may be modified by the behavior of this widget.

Returns:

The time span of this TimeSpanWidget

setTimeSpan

void setTimeSpan(TimeSpan span)

Sets the time this TimeSpanWidget measures. The span may be modified by the widget for particular reasons. 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.

Parameters:

span - the new TimeSpan for this ruler