Package uk.ac.rdg.resc.godiva.client.widgets

Class TimeSelector

java.lang.Object

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

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

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

com.google.gwt.user.client.ui.CellPanel

com.google.gwt.user.client.ui.HorizontalPanel

uk.ac.rdg.resc.godiva.client.widgets.BaseSelector

uk.ac.rdg.resc.godiva.client.widgets.TimeSelector

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.HasAlignment, com.google.gwt.user.client.ui.HasHorizontalAlignment, com.google.gwt.user.client.ui.HasVerticalAlignment, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.InsertPanel, com.google.gwt.user.client.ui.InsertPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>, TimeSelectorIF

public class TimeSelector
extends BaseSelector
implements TimeSelectorIF

Implementation of TimeSelectorIF which presents dates and times (and ranges where applicable) as separate drop-down boxes

Author:

Guy Griffiths

Nested Class Summary

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

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment

com.google.gwt.user.client.ui.HasHorizontalAlignment.AutoHorizontalAlignmentConstant, com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasVerticalAlignment

com.google.gwt.user.client.ui.HasVerticalAlignment.VerticalAlignmentConstant

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.InsertPanel

com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

Field Summary

Fields

Modifier and Type	Field	Description
protected static String[]	allTimes

Fields inherited from class uk.ac.rdg.resc.godiva.client.widgets.BaseSelector

label

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

DEBUG_ID_PREFIX

Fields inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment

ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_JUSTIFY, ALIGN_LEFT, ALIGN_LOCALE_END, ALIGN_LOCALE_START, ALIGN_RIGHT

Fields inherited from interface com.google.gwt.user.client.ui.HasVerticalAlignment

ALIGN_BOTTOM, ALIGN_MIDDLE, ALIGN_TOP

Constructor Summary

Constructors

Constructor	Description
TimeSelector(String id, String label, TimeDateSelectionHandler handler)
TimeSelector(String id, TimeDateSelectionHandler handler)

Method Summary

Modifier and Type	Method	Description
List<String>	getAvailableDates()	Return the available dates
List<String>	getAvailableTimes()	Return the available times
static List<String>	getDatesInRange(String startDateTimeStr, String endDateTimeStr)
String	getRange()
String	getSelectedDate()
int	getSelectedDateIndex()
String	getSelectedDateTime()
String	getSelectedDateTimeRange()
String	getSelectedTime()
boolean	hasMultipleTimes()
boolean	isContinuous()
void	populateDates(List<String> availableDatetimes)	Populate the available dates
void	populateTimes(List<String> availableTimes)	Populate the available times.
boolean	selectDate(String dateString)	Choose a specified date
boolean	selectDateTime(String timeString)	Choose a specified datetime
void	selectRange(String currentRange)	Sets the range (i.e.
void	setContinuous(boolean continuous)	Sets whether this TimeSelectorIF needs to represent discrete or continous time
void	setEnabled(boolean enabled)	Enable/disable the widget
void	setId(String id)	Sets the ID of the layer which this time selector applies to

Methods inherited from class uk.ac.rdg.resc.godiva.client.widgets.BaseSelector

setTitle

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

add, getHorizontalAlignment, getVerticalAlignment, insert, insert, onEnsureDebugId, remove, setHorizontalAlignment, setVerticalAlignment

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

getBody, getSpacing, getTable, setBorderWidth, setCellHeight, setCellHeight, setCellHorizontalAlignment, setCellHorizontalAlignment, setCellHorizontalAlignment, setCellHorizontalAlignment, setCellVerticalAlignment, setCellVerticalAlignment, setCellVerticalAlignment, setCellVerticalAlignment, setCellWidth, setCellWidth, setSpacing

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

add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove

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

add, adopt, clear, doAttachChildren, doDetachChildren, orphan, remove

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel

getWidget, getWidgetCount, getWidgetIndex, remove

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

getWidgetIndex

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

add

Methods inherited from interface com.google.gwt.user.client.ui.IsWidget

asWidget

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

allTimes

protected static final String[] allTimes

Constructor Detail

TimeSelector

public TimeSelector(String id,
                    TimeDateSelectionHandler handler)

TimeSelector

public TimeSelector(String id,
                    String label,
                    TimeDateSelectionHandler handler)

Method Detail

setId

public void setId(String id)

Description copied from interface: TimeSelectorIF

Sets the ID of the layer which this time selector applies to

Specified by:

setId in interface TimeSelectorIF

populateDates

public void populateDates(List<String> availableDatetimes)

Description copied from interface: TimeSelectorIF

Populate the available dates

Specified by:

populateDates in interface TimeSelectorIF

Parameters:

availableDatetimes - The available dates, as a List of Strings

populateTimes

public void populateTimes(List<String> availableTimes)

Description copied from interface: TimeSelectorIF

Populate the available times. This may change as the date changes

Specified by:

populateTimes in interface TimeSelectorIF

Parameters:

availableTimes - The available times, as a List of Strings

getSelectedDate

public String getSelectedDate()

Specified by:

getSelectedDate in interface TimeSelectorIF

Returns:

A String representation of the currently selected date

getSelectedDateTime

public String getSelectedDateTime()

Specified by:

getSelectedDateTime in interface TimeSelectorIF

Returns:

A String representation of the currently selected datetime

getSelectedDateTimeRange

public String getSelectedDateTimeRange()

Specified by:

getSelectedDateTimeRange in interface TimeSelectorIF

Returns:

A String representation of the currently selected datetime range. This may be null if isContinous() returns false

getSelectedTime

public String getSelectedTime()

Specified by:

getSelectedTime in interface TimeSelectorIF

Returns:

A String representation of the currently selected time

selectDate

public boolean selectDate(String dateString)

Description copied from interface: TimeSelectorIF

Choose a specified date

Specified by:

selectDate in interface TimeSelectorIF

Parameters:

dateString - The desired date

Returns:

true if the operation was successfull

selectDateTime

public boolean selectDateTime(String timeString)

Description copied from interface: TimeSelectorIF

Choose a specified datetime

Specified by:

selectDateTime in interface TimeSelectorIF

Parameters:

timeString - The desired datetime

Returns:

true if the operation was successfull

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: TimeSelectorIF

Enable/disable the widget

Specified by:

setEnabled in interface TimeSelectorIF

Parameters:

enabled - true to enable the widget, false to disable it

hasMultipleTimes

public boolean hasMultipleTimes()

Specified by:

hasMultipleTimes in interface TimeSelectorIF

Returns:

true if this time selector can represent multiple datetimes

setContinuous

public void setContinuous(boolean continuous)

Description copied from interface: TimeSelectorIF

Sets whether this TimeSelectorIF needs to represent discrete or continous time

Specified by:

setContinuous in interface TimeSelectorIF

getDatesInRange

public static List<String> getDatesInRange(String startDateTimeStr,
                                           String endDateTimeStr)

isContinuous

public boolean isContinuous()

Specified by:

isContinuous in interface TimeSelectorIF

Returns:

true if this TimeSelectorIF is currently representing a continuous time range, false if it is a discrete one

getAvailableDates

public List<String> getAvailableDates()

Description copied from interface: TimeSelectorIF

Return the available dates

Specified by:

getAvailableDates in interface TimeSelectorIF

Returns:

A List of Strings representing the available dates

getAvailableTimes

public List<String> getAvailableTimes()

Description copied from interface: TimeSelectorIF

Return the available times

Specified by:

getAvailableTimes in interface TimeSelectorIF

Returns:

A List of Strings representing the available times for the selected date

selectRange

public void selectRange(String currentRange)

Description copied from interface: TimeSelectorIF

Sets the range (i.e. +/- how much) for a continuous axis

Specified by:

selectRange in interface TimeSelectorIF

getRange

public String getRange()

Specified by:

getRange in interface TimeSelectorIF

Returns:

The currently selected range (i.e. +/- how much) for a continuous axis

getSelectedDateIndex

public int getSelectedDateIndex()

Returns:

The index of the selected date. Used in StartEndTimePopup