org.eclipse.eavp.viz.service.widgets

Class TimeSliderComposite

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Scrollable

org.eclipse.swt.widgets.Composite

org.eclipse.eavp.viz.service.widgets.TimeSliderComposite

All Implemented Interfaces:

org.eclipse.swt.graphics.Drawable

public class TimeSliderComposite
extends org.eclipse.swt.widgets.Composite

This class provides a widget with three separate means of selecting times from a list of allowed times:

• dragging a Scale widget (coarse-grained control)
• pressing arrow keys (fine-grained control)
• typing a value near an existing timestep (very fine-grained control)

As input, the widget takes an ordered list of doubles. If the input list is not in ascending order, then the widget will order them on its own and provide timesteps based on the ordered list.

To receive notifications of changes to the selected timestep, a SelectionListener must be registered as with a typical SWT widget. Notifications will be posted on the UI thread.

Author:

Jordan Deyton

Field Summary

Fields inherited from class org.eclipse.swt.widgets.Control

view

Constructor Summary

Constructors

Constructor and Description
TimeSliderComposite(org.eclipse.swt.widgets.Composite parent, int style) The default constructor.

Method Summary

Modifier and Type	Method and Description
void	addSelectionListener(org.eclipse.swt.events.SelectionListener listener) Adds a new listener to be notified when the selected time changes.
void	dispose()
double	getFPS() Gets the current playback rate in frames per second.
boolean	getLoopPlayback() Gets whether or not playback will loop back to the first timestep after the last timestep is reached.
double	getTime() Gets the currently selected time.
int	getTimestep() Gets the currently selected timestep (the index of the selected time).
boolean	isPlaying() Gets whether the widget is currently playing.
boolean	pause() Stops playback on the widget at its current timestep.
boolean	play() Starts playback on the widget.
void	removeSelectionListener(org.eclipse.swt.events.SelectionListener listener) Removes the specified listener from this widget.
void	setBackground(org.eclipse.swt.graphics.Color color)
boolean	setFPS(double fps) Sets the current playback rate in frames per second.
boolean	setLoopPlayback(boolean loop) Sets whether or not playback will loop back to the first timestep after the last timestep is reached.
boolean	setTime(double time) Updates the timestep and all embedded widgets based on the nearest known time to the specified time.
void	setTimes(java.util.List<java.lang.Double> times) Sets the list of timesteps used by this widget.
boolean	setTimestep(int index) Updates the timestep and all embedded widgets based on the new timestep value.

Methods inherited from class org.eclipse.swt.widgets.Composite

changed, computeSize, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList

Methods inherited from class org.eclipse.swt.widgets.Scrollable

computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, reskin, setData, setData, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeSliderComposite

public TimeSliderComposite(org.eclipse.swt.widgets.Composite parent,
                           int style)

The default constructor.

Parameters:

parent - a widget which will be the parent of the new instance (cannot be null)

style - the style of widget to construct

Method Detail

addSelectionListener

public void addSelectionListener(org.eclipse.swt.events.SelectionListener listener)

Adds a new listener to be notified when the selected time changes.

Parameters:

listener - The new listener to add.

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

dispose

public void dispose()

Overrides:

dispose in class org.eclipse.swt.widgets.Widget

getFPS

public double getFPS()

Gets the current playback rate in frames per second.

Returns:

The current frames per second for playback.

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getLoopPlayback

public boolean getLoopPlayback()

Gets whether or not playback will loop back to the first timestep after the last timestep is reached.

Returns:

True if playback will be looped, false otherwise.

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getTime

public double getTime()

Gets the currently selected time.

Returns:

The selected time.

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getTimestep

public int getTimestep()

Gets the currently selected timestep (the index of the selected time).

Returns:

The selected timestep.

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

isPlaying

public boolean isPlaying()

Gets whether the widget is currently playing.

Returns:

True if the widget is playing, false if it is paused.

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

pause

public boolean pause()

Stops playback on the widget at its current timestep.

Returns:

True if the widget was playing and is now paused, false otherwise.

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

play

public boolean play()

Starts playback on the widget. Calling this method will not itself notify SelectionListeners, but the ensuing playback will.

Returns:

True if the widget was paused and is now playing, false otherwise.

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

removeSelectionListener

public void removeSelectionListener(org.eclipse.swt.events.SelectionListener listener)

Removes the specified listener from this widget. It will no longer be notified of time changes from this widget unless it has been registered multiple times.

Parameters:

listener - The listener to remove.

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setBackground

public void setBackground(org.eclipse.swt.graphics.Color color)

Overrides:

setBackground in class org.eclipse.swt.widgets.Control

setFPS

public boolean setFPS(double fps)

Sets the current playback rate in frames per second. The slowest allowed framerate is defined by minFPS.

Parameters:

fps - The new framerate. Must be greater than the minimum allowed framerate.

Returns:

True if the FPS was changed, false otherwise.

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setLoopPlayback

public boolean setLoopPlayback(boolean loop)

Sets whether or not playback will loop back to the first timestep after the last timestep is reached.

Parameters:

loop - If true, then the playback will be looped. If false, playback will not be looped.

Returns:

True if the property changed, false otherwise.

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setTime

public boolean setTime(double time)

Updates the timestep and all embedded widgets based on the nearest known time to the specified time. Calling this method will not notify SelectionListeners!

Note: Calling this method from the UI thread with valid arguments will pause the widget if it is currently playing.

Parameters:

time - The new time.

Returns:

True if the timestep changed, false otherwise.

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setTimes

public void setTimes(java.util.List<java.lang.Double> times)

Sets the list of timesteps used by this widget.

Note: Calling this method from the UI thread with valid arguments will pause the widget if it is currently playing.

Parameters:

times - The list of timesteps. Null values and duplicates will be ignored. The list will be ordered.

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the list of times is null

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setTimestep

public boolean setTimestep(int index)
                    throws java.lang.IndexOutOfBoundsException

Updates the timestep and all embedded widgets based on the new timestep value. Calling this method will not notify SelectionListeners!

Note: Calling this method from the UI thread with valid arguments will pause the widget if it is currently playing.

Parameters:

index - The new index of the timestep.

Returns:

True if the timestep changed, false otherwise.

Throws:

java.lang.IndexOutOfBoundsException - If the specified index is invalid.

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver