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

Interface TimeSelectorIF

  • All Superinterfaces:
    com.google.gwt.user.client.ui.IsWidget
    All Known Implementing Classes:
    TimeSelector
    public interface TimeSelectorIF
extends com.google.gwt.user.client.ui.IsWidget
    Interface defining a time selector
    Author:
    Guy Griffiths

    • Method Detail

      • setId

        void setId​(String id)
        Sets the ID of the layer which this time selector applies to
        Parameters:
        id -

      • populateDates

        void populateDates​(List<String> availableDates)
        Populate the available dates
        Parameters:
        availableDates - The available dates, as a List of Strings

      • getAvailableDates

        List<String> getAvailableDates()
        Return the available dates
        Returns:
        A List of Strings representing the available dates

      • populateTimes

        void populateTimes​(List<String> availableTimes)
        Populate the available times. This may change as the date changes
        Parameters:
        availableTimes - The available times, as a List of Strings

      • getAvailableTimes

        List<String> getAvailableTimes()
        Return the available times
        Returns:
        A List of Strings representing the available times for the selected date

      • getSelectedDate

        String getSelectedDate()
        Returns:
        A String representation of the currently selected date

      • getSelectedDateTime

        String getSelectedDateTime()
        Returns:
        A String representation of the currently selected datetime

      • getSelectedTime

        String getSelectedTime()
        Returns:
        A String representation of the currently selected time

      • getSelectedDateTimeRange

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

      • selectDate

        boolean selectDate​(String dateString)
        Choose a specified date
        Parameters:
        dateString - The desired date
        Returns:
        true if the operation was successfull

      • selectDateTime

        boolean selectDateTime​(String timeString)
        Choose a specified datetime
        Parameters:
        timeString - The desired datetime
        Returns:
        true if the operation was successfull

      • setEnabled

        void setEnabled​(boolean enabled)
        Enable/disable the widget
        Parameters:
        enabled - true to enable the widget, false to disable it

      • hasMultipleTimes

        boolean hasMultipleTimes()
        Returns:
        true if this time selector can represent multiple datetimes

      • setContinuous

        void setContinuous​(boolean continuous)
        Sets whether this TimeSelectorIF needs to represent discrete or continous time
        Parameters:
        continuous -

      • isContinuous

        boolean isContinuous()
        Returns:
        true if this TimeSelectorIF is currently representing a continuous time range, false if it is a discrete one

      • selectRange

        void selectRange​(String currentRange)
        Sets the range (i.e. +/- how much) for a continuous axis
        Parameters:
        currentRange -

      • getRange

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