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

Interface ElevationSelectorIF

All Superinterfaces:

com.google.gwt.user.client.ui.IsWidget

All Known Implementing Classes:

ElevationSelector

public interface ElevationSelectorIF
extends com.google.gwt.user.client.ui.IsWidget

Interface defining a widget for selecting elevation

Author:

Guy Griffiths

Method Summary

Modifier and Type	Method	Description
int	getNElevations()
String	getSelectedElevation()	Gets the currently selected elevation as a String
String	getSelectedElevationRange()	Gets the currently selected elevation range if applicable
String	getVerticalUnits()
boolean	isContinuous()
void	populateElevations(List<String> availableElevations)	Populates the available elevations
void	setContinuous(boolean continuous)	Sets this elevation selector to be continuous
void	setEnabled(boolean enabled)	Enables/disables the elevation selector
void	setId(String id)	Sets the layer ID which this widget is referring to
void	setSelectedElevation(String currentElevation)	Sets the current elevation to the desired value
void	setUnitsAndDirection(String units, boolean positive, boolean pressure)	Sets the units and direction of the vertical axis

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

asWidget

Method Detail

setId

void setId(String id)

Sets the layer ID which this widget is referring to

populateElevations

void populateElevations(List<String> availableElevations)

Populates the available elevations

Parameters:

availableElevations - The available elevations, represented as a List of Strings

setUnitsAndDirection

void setUnitsAndDirection(String units,
                          boolean positive,
                          boolean pressure)

Sets the units and direction of the vertical axis

Parameters:

units - A string representing the units

positive - true if increasing elevation value means increasing height. false if increasing elevation value means increasing depth

pressure - true if this axis represents pressure

getSelectedElevation

String getSelectedElevation()

Gets the currently selected elevation as a String

getSelectedElevationRange

String getSelectedElevationRange()

Gets the currently selected elevation range if applicable

setSelectedElevation

void setSelectedElevation(String currentElevation)

Sets the current elevation to the desired value

setEnabled

void setEnabled(boolean enabled)

Enables/disables the elevation selector

getNElevations

int getNElevations()

Returns:

The number of available elevations

getVerticalUnits

String getVerticalUnits()

Returns:

The units of the vertical axis

setContinuous

void setContinuous(boolean continuous)

Sets this elevation selector to be continuous

isContinuous

boolean isContinuous()

Returns:

true if this currently represents a continuous vertical axis