edu.ucdavis.cstars.client.dijits

Class TimeSlider

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

edu.ucdavis.cstars.client.dijits.TimeSlider

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget

public class TimeSlider
extends com.google.gwt.user.client.ui.Composite

Widget for visualizing time enabled layers.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeSlider.Parameters

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
TimeSlider(TimeSlider.Parameters params, DijitLoadHandler handler) Creates a new TimeSlider object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTimeExtentChangeHandler(TimeExtentChangeHandler handler) Add time extent changed handler.
static boolean	assertLoaded() Check that the esri.dijit.TimeSlider package has been loaded
void	createTimeStopsByCount(TimeExtent timeExtent) The specified number of time stops are created for the input time extent.
void	createTimeStopsByCount(TimeExtent timeExtent, int count) The specified number of time stops are created for the input time extent.
void	createTimeStopsByTimeInterval(TimeExtent timeExtent) Create a time stop for each interval specified, i.e.(week,month, day).
void	createTimeStopsByTimeInterval(TimeExtent timeExtent, int timeInterval, TimeInfo.TimeUnits timeIntervalUnits) Create a time stop for each interval specified, i.e.(week,month, day).
TimeExtent	getCurrentTimeExtent() Gets the current time extent for the time slider.
int	getThumbCount() Default value is 1.
int	getThumbMovingRate() Rate at which the time animation plays.
com.google.gwt.core.client.JavaScriptObject	getTimeSliderObject()
com.google.gwt.core.client.JsArray<com.google.gwt.core.client.JsDate>	getTimeStops() An array of dates representing the stops (tics) on the TimeSlider.
boolean	isLoop() Default value is false.
boolean	isPlaying() Default value is false.
void	next() Move to the next time step.
void	pause() Pause the time slider.
void	play() Play the time slider.
void	previous() Move to the previous time step.
void	setLabels(java.lang.String[] labels) Specify an array of strings to be used as labels.
void	setLoop(boolean loop) Determines whether or not loop.
void	setThumbCount(int thumbCount) The number of thumbs to display.
void	setThumbIndexes(int first, int second)
void	setThumbMovingRate(int thumbMovingRate) Change the rate at which the time animation plays.
void	setTickCount(int tickCount) Specify the number of ticks to display on the time slider.
void	setTimeStops(com.google.gwt.core.client.JsDate[] stops) Manually define the time stop locations by providing an array of dates.
void	singleThumbAsTimeInstant(boolean createTimeInstants) Determine if the time is displayed for an instant in time.
void	startup() This is not in the docs but in the examples.

Methods inherited from class com.google.gwt.user.client.ui.Composite

claimElement, initializeClaimedElement, isAttached, onBrowserEvent, render, render

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, fireEvent, getLayoutData, getParent, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeSlider

public TimeSlider(TimeSlider.Parameters params,
          DijitLoadHandler handler)

Creates a new TimeSlider object.

Parameters:

params - - Parameters for the time slider object.

loadHandler - - handler to fire when dijit is created. All method calls will fail untill this event fires.

Method Detail

assertLoaded

public static boolean assertLoaded()

Check that the esri.dijit.TimeSlider package has been loaded

Returns:

boolean

getTimeSliderObject

public com.google.gwt.core.client.JavaScriptObject getTimeSliderObject()

isLoop

public boolean isLoop()

Default value is false.

Returns:

boolean

isPlaying

public boolean isPlaying()

Default value is false.

Returns:

boolean

getThumbCount

public int getThumbCount()

Default value is 1.

Returns:

int

getThumbMovingRate

public int getThumbMovingRate()

Rate at which the time animation plays. Default value is 1000 milliseconds.

Returns:

int

getTimeStops

public com.google.gwt.core.client.JsArray<com.google.gwt.core.client.JsDate> getTimeStops()

An array of dates representing the stops (tics) on the TimeSlider.

Returns:

JsArray

createTimeStopsByCount

public void createTimeStopsByCount(TimeExtent timeExtent)

The specified number of time stops are created for the input time extent.

Parameters:

timeExtent - - The time extent used to define the time slider's start and end time stops.

createTimeStopsByCount

public void createTimeStopsByCount(TimeExtent timeExtent,
                          int count)

The specified number of time stops are created for the input time extent.

Parameters:

timeExtent - - The time extent used to define the time slider's start and end time stops.

count - - The number of time stops to create.

createTimeStopsByTimeInterval

public void createTimeStopsByTimeInterval(TimeExtent timeExtent)

Create a time stop for each interval specified, i.e.(week,month, day).

Parameters:

timeExtent - - The time extent used to define the time slider's start and end time stops.

createTimeStopsByTimeInterval

public void createTimeStopsByTimeInterval(TimeExtent timeExtent,
                                 int timeInterval,
                                 TimeInfo.TimeUnits timeIntervalUnits)

Create a time stop for each interval specified, i.e.(week,month, day).

Parameters:

timeExtent - - The time extent used to define the time slider's start and end time stops.

timeInterval - - The length of the time interval.

timeIntervalUnits - - Time units.

getCurrentTimeExtent

public TimeExtent getCurrentTimeExtent()

Gets the current time extent for the time slider.

Returns:

TimeExtent

next

public void next()

Move to the next time step.

pause

public void pause()

Pause the time slider.

play

public void play()

Play the time slider.

previous

public void previous()

Move to the previous time step.

setLabels

public void setLabels(java.lang.String[] labels)

Specify an array of strings to be used as labels. The array position for each string defines which tick it will be placed on.

Parameters:

labels - - An array of strings that define the labels for each tick.

setLoop

public void setLoop(boolean loop)

Determines whether or not loop. Default value is false.

Parameters:

loop - - True plays the time slider continuously. Default value is false.

setThumbCount

public void setThumbCount(int thumbCount)

The number of thumbs to display. A value of one displays a single thumb. Setting the value to 2 displays a range slider.

Parameters:

thumbCount - - The number of thumbs to display. Default value is one.

setThumbIndexes

public void setThumbIndexes(int first,
                   int second)

Parameters:

first - - determinds where to put the first thumb.

second - - If it is a two thumb slider the second value determines where to place the additional thumb.

setThumbMovingRate

public void setThumbMovingRate(int thumbMovingRate)

Change the rate at which the time animation plays.

Parameters:

thumbMovingRate - - The rate at which the time slider plays. Default value is 1500.

setTickCount

public void setTickCount(int tickCount)

Specify the number of ticks to display on the time slider.

Parameters:

tickCount - - The number of ticks to display on the slider.

setTimeStops

public void setTimeStops(com.google.gwt.core.client.JsDate[] stops)

Manually define the time stop locations by providing an array of dates.

Parameters:

stops - - Array of dates

singleThumbAsTimeInstant

public void singleThumbAsTimeInstant(boolean createTimeInstants)

Determine if the time is displayed for an instant in time. Only valid when the thumb count is set to one.

Parameters:

createTimeInstants - - When true, the time slider displays features for the current point in time. When false cumulative data is displayed from the start time to the current thumb location. The default value is false.

startup

public void startup()

This is not in the docs but in the examples. Required to start the dijit. Seems to error so I have wrapped it up till the bug is figured out.

addTimeExtentChangeHandler

public final void addTimeExtentChangeHandler(TimeExtentChangeHandler handler)

Add time extent changed handler.

Parameters:

handler - - Fires when the timeExtent of the TimeSlider is changed.