de.jaret.util.ui.timebars
Interface TimeBarMarker

All Known Implementing Classes:

AbstractTimeBarMarker, TimeBarMarkerImpl, TimeBarNowMarker

public interface TimeBarMarker

Interface for a vertical marker to be displayed in a TimeBarViewer.

Version:

$Id: TimeBarMarker.java 160 2007-01-02 22:02:40Z olk $

Author:

Peter Kliem

Method Summary

void	addTimeBarMarkerListener(TimeBarMarkerListener tbml) Add a listener to be informed about changes to the marker.
de.jaret.util.date.JaretDate	getDate() Retrieve the current time marked by the marker.
java.lang.String	getDescription() Retrieve the description of the marker.
java.lang.String	getTooltipText() Retrieve the tooltip text for the marker.
boolean	isDraggable() Retrieve the draggable state of the marker.
void	remTimeBarMarkerListener(TimeBarMarkerListener tbml) Remove a TimeBarMarkerListener for this marker.
void	setDate(de.jaret.util.date.JaretDate date) Set the timestamp to be marked.
void	setDraggable(boolean draggable) Set whether the marker can be dragged by the user.

Method Detail

addTimeBarMarkerListener

void addTimeBarMarkerListener(TimeBarMarkerListener tbml)

Add a listener to be informed about changes to the marker.

Parameters:

tbml - the TimeBarMarkerListener to be added

remTimeBarMarkerListener

void remTimeBarMarkerListener(TimeBarMarkerListener tbml)

Remove a TimeBarMarkerListener for this marker.

Parameters:

tbml - TimeBarMArkerListener to be removed

getDate

de.jaret.util.date.JaretDate getDate()

Retrieve the current time marked by the marker.

Returns:

Returns the timestamp currently marked.

setDate

void setDate(de.jaret.util.date.JaretDate date)

Set the timestamp to be marked.

Parameters:

date - The date to be marked by the marker

isDraggable

boolean isDraggable()

Retrieve the draggable state of the marker.

Returns:

Return true if the marker is draggable

setDraggable

void setDraggable(boolean draggable)

Set whether the marker can be dragged by the user.

Parameters:

draggable - if true the marker can be dragged by the user.

getDescription

java.lang.String getDescription()

Retrieve the description of the marker.

Returns:

description to be displayed

getTooltipText

java.lang.String getTooltipText()

Retrieve the tooltip text for the marker.

Returns:

the tooltip text