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

Class PaletteSelector

java.lang.Object

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

All Implemented Interfaces:

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

public class PaletteSelector
extends Object
implements PaletteSelectorIF

Implementation of PaletteSelectorIF which can be either horizontally or vertically oriented, and contains controls for setting all palette variables

Author:

Guy Griffiths

Nested Class Summary

Nested classes/interfaces inherited from interface uk.ac.rdg.resc.godiva.client.state.PaletteSelectorIF

PaletteSelectorIF.OutOfRangeState

Constructor Summary

Constructors

Constructor	Description
PaletteSelector(String wmsLayerId, int height, int width, PaletteSelectionHandler handler, LayerSelectorIF wmsUrlProvider, DialogBoxWithCloseButton.CentrePosIF localCentre, boolean vertical)	Instantiates a new PaletteSelector

Method Summary

Modifier and Type	Method	Description
com.google.gwt.user.client.ui.Widget	asWidget()
String	getAboveMaxString()
String	getBelowMinString()
String	getDisplayScaleRange()
String	getNoDataColour()
int	getNumColorBands()
float	getOpacity()
String	getScaleRange()
String	getSelectedPalette()
String	getSelectedStyle()
boolean	isEnabled()
boolean	isLocked()
boolean	isLogScale()
void	populatePalettes(List<String> availablePalettes)	Populates the list of available palette names
void	populateStyles(List<String> availableStyles)
void	selectPalette(String paletteString)	Select the named palette, if available
void	selectStyle(String styleString)	Select the named style, if available
void	setAboveMax(PaletteSelectorIF.OutOfRangeState state)	Sets the behaviour of values above the maximum
void	setBelowMin(PaletteSelectorIF.OutOfRangeState state)	Sets the behaviour of values below the minimum
void	setCategorical(boolean categorical)
void	setEnabled(boolean enabled)	Enables/disables the palette selector
void	setExtraAboveMaxColour(String aboveMaxColour)	Sets a colour to use in addition to black/extend/transparent for values above the maximum scale value
void	setExtraBelowMinColour(String belowMinColour)	Sets a colour to use in addition to black/extend/transparent for values below the minimum scale value
void	setId(String id)	Sets the layer ID which this palette selector is currently active on
void	setLogScale(boolean isLogScale)
void	setNoDataColour(String noDataColour)
void	setNoPaletteStyles(List<String> noPaletteStyles)	Sets the list of styles which do not use a palette (e.g.
void	setNumColorBands(int nBands)	Sets the number of colour bands in the current palette
void	setOpacity(float opacityValue)	Sets the opacity of the current palette
void	setScaleLabels()
boolean	setScaleRange(String scaleRange, Boolean isLogScale)	Sets the scale range
void	setUnitConverter(UnitConverter converter)	Setting this allows the PaletteSelectorIF to work in different units to those used by the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaletteSelector

public PaletteSelector(String wmsLayerId,
                       int height,
                       int width,
                       PaletteSelectionHandler handler,
                       LayerSelectorIF wmsUrlProvider,
                       DialogBoxWithCloseButton.CentrePosIF localCentre,
                       boolean vertical)

Instantiates a new PaletteSelector

Parameters:

wmsLayerId - The ID of the WMS layer

height - The height of the palette image

width - The width of the palette image

handler - The PaletteSelectionHandler to handle palette events

wmsUrlProvider - A LayerSelectorIF which can be used to obtain the WMS URL for the current WMS layer

localCentre - A DialogBoxWithCloseButton.CentrePosIF to define the local centre (usually over the centre of the map)

vertical - true if this palette selector should be vertically aligned

Method Detail

setId

public void setId(String id)

Description copied from interface: PaletteSelectorIF

Sets the layer ID which this palette selector is currently active on

Specified by:

setId in interface PaletteSelectorIF

Parameters:

id - The ID

populatePalettes

public void populatePalettes(List<String> availablePalettes)

Description copied from interface: PaletteSelectorIF

Populates the list of available palette names

Specified by:

populatePalettes in interface PaletteSelectorIF

getSelectedPalette

public String getSelectedPalette()

Specified by:

getSelectedPalette in interface PaletteSelectorIF

Returns:

The name of the currently selected palette

getAboveMaxString

public String getAboveMaxString()

Specified by:

getAboveMaxString in interface PaletteSelectorIF

Returns:

The string representation of the colour to display when values are above the maximum

setAboveMax

public void setAboveMax(PaletteSelectorIF.OutOfRangeState state)

Description copied from interface: PaletteSelectorIF

Sets the behaviour of values above the maximum

Specified by:

setAboveMax in interface PaletteSelectorIF

setExtraAboveMaxColour

public void setExtraAboveMaxColour(String aboveMaxColour)

Description copied from interface: PaletteSelectorIF

Sets a colour to use in addition to black/extend/transparent for values above the maximum scale value

Specified by:

setExtraAboveMaxColour in interface PaletteSelectorIF

Parameters:

aboveMaxColour - The colour to display for values above the maximum scale range

getBelowMinString

public String getBelowMinString()

Specified by:

getBelowMinString in interface PaletteSelectorIF

Returns:

The string representation of the colour to display when values are below the minimum

setBelowMin

public void setBelowMin(PaletteSelectorIF.OutOfRangeState state)

Description copied from interface: PaletteSelectorIF

Sets the behaviour of values below the minimum

Specified by:

setBelowMin in interface PaletteSelectorIF

setExtraBelowMinColour

public void setExtraBelowMinColour(String belowMinColour)

Description copied from interface: PaletteSelectorIF

Sets a colour to use in addition to black/extend/transparent for values below the minimum scale value

Specified by:

setExtraBelowMinColour in interface PaletteSelectorIF

Parameters:

belowMinColour - The colour to display for values below the minimum scale range

setNoDataColour

public void setNoDataColour(String noDataColour)

Specified by:

setNoDataColour in interface PaletteSelectorIF

Parameters:

noDataColour - The colour to display for missing data

getNoDataColour

public String getNoDataColour()

Specified by:

getNoDataColour in interface PaletteSelectorIF

Returns:

The colour to display for missing data

selectPalette

public void selectPalette(String paletteString)

Description copied from interface: PaletteSelectorIF

Select the named palette, if available

Specified by:

selectPalette in interface PaletteSelectorIF

Parameters:

paletteString - The name of the palette to select

setScaleRange

public boolean setScaleRange(String scaleRange,
                             Boolean isLogScale)

Description copied from interface: PaletteSelectorIF

Sets the scale range

Specified by:

setScaleRange in interface PaletteSelectorIF

Parameters:

scaleRange - The desired scale range, of the form [min],[max]

isLogScale - Whether we want this to be a log scale or not

Returns:

true if the operation was successful (may not be if the palette is locked, or we want a negative value in a logarithmic range)

setScaleLabels

public void setScaleLabels()

getScaleRange

public String getScaleRange()

Specified by:

getScaleRange in interface PaletteSelectorIF

Returns:

A String of the form "[min],[max]" which represents the current scale range

getDisplayScaleRange

public String getDisplayScaleRange()

Specified by:

getDisplayScaleRange in interface PaletteSelectorIF

Returns:

A String of the form "[min],[max]" which represents the current scale range displayed. If there is no unit converter set, this will be equivalent to PaletteSelectorIF.getScaleRange().

getNumColorBands

public int getNumColorBands()

Specified by:

getNumColorBands in interface PaletteSelectorIF

Returns:

The number of colour bands in the currently selected palette

setNumColorBands

public void setNumColorBands(int nBands)

Description copied from interface: PaletteSelectorIF

Sets the number of colour bands in the current palette

Specified by:

setNumColorBands in interface PaletteSelectorIF

setLogScale

public void setLogScale(boolean isLogScale)

isLogScale

public boolean isLogScale()

Specified by:

isLogScale in interface PaletteSelectorIF

Returns:

Whether or not this is a logarithmic scale

isLocked

public boolean isLocked()

Specified by:

isLocked in interface PaletteSelectorIF

Returns:

Whether or not the palette is locked

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: PaletteSelectorIF

Enables/disables the palette selector

Specified by:

setEnabled in interface PaletteSelectorIF

asWidget

public com.google.gwt.user.client.ui.Widget asWidget()

Specified by:

asWidget in interface com.google.gwt.user.client.ui.IsWidget

populateStyles

public void populateStyles(List<String> availableStyles)

Specified by:

populateStyles in interface PaletteSelectorIF

Parameters:

availableStyles - The list of available style names

setNoPaletteStyles

public void setNoPaletteStyles(List<String> noPaletteStyles)

Description copied from interface: PaletteSelectorIF

Sets the list of styles which do not use a palette (e.g. contours, arrows)

Specified by:

setNoPaletteStyles in interface PaletteSelectorIF

Parameters:

noPaletteStyles - The list of styles which do not use a palette

getSelectedStyle

public String getSelectedStyle()

Specified by:

getSelectedStyle in interface PaletteSelectorIF

Returns:

The name of the currently selected style

selectStyle

public void selectStyle(String styleString)

Description copied from interface: PaletteSelectorIF

Select the named style, if available

Specified by:

selectStyle in interface PaletteSelectorIF

Parameters:

styleString - The name of the style to select

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface PaletteSelectorIF

Returns:

Whether or not the current palette selector is enabled

getOpacity

public float getOpacity()

Specified by:

getOpacity in interface PaletteSelectorIF

Returns:

The opacity of the current palette as a float ranging from 0-1

setOpacity

public void setOpacity(float opacityValue)

Description copied from interface: PaletteSelectorIF

Sets the opacity of the current palette

Specified by:

setOpacity in interface PaletteSelectorIF

Parameters:

opacityValue - The opacity, as a float ranging from 0-1

setUnitConverter

public void setUnitConverter(UnitConverter converter)

Description copied from interface: PaletteSelectorIF

Setting this allows the PaletteSelectorIF to work in different units to those used by the server. For example a client may always want to treat temperatures as degrees Celcius regardless of what the WMS server says.

Specified by:

setUnitConverter in interface PaletteSelectorIF

Parameters:

converter - The UnitConverter to use for converting display units to the underlying units used on the WMS server. Set to null to use the WMS native units

setCategorical

public void setCategorical(boolean categorical)

Specified by:

setCategorical in interface PaletteSelectorIF

Parameters:

categorical - Whether or not this palette should retrieve a categorical legend in place of the usual scaling tools