com.moximedia.ows
Class LayerListLegends

java.lang.Object
  com.moximedia.ows.LayerListLegends

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class LayerListLegends

extends java.lang.Object

implements java.lang.Cloneable, java.io.Serializable

Stores an array of layer list legends.

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Constructor Summary

LayerListLegends()
Creates a new instance of AimsLayerListLegends

Method Summary

void	add(LayerListLegend legend) Adds a new legend to the array.
java.lang.Object	clone() Gets a clone of this object.
LayerListLegend	get(int index) Gets the legend at the specified index.
boolean	getCanHide() Returns an indicator of whether the user can hide the legend for this layer.
LayerListLegends	getCopy() Gets a copy of this object.
LayerListLegend	getLegendForScale(double scale) Gets the first legend visible at the specified scale.
int	getLegendHeightForScale(double scale) Gets the height of the legend for the specified scale.
java.lang.String	getLegendUrlForScale(double scale) Gets the url for the legend for the specified scale.
int	getLegendWidthForScale(double scale) Gets the width of the legend for the specified scale.
boolean	getVisible() Returns an indicator of whether layer list legends are visible for this layer.
boolean	hasLegendForScale(double scale) Returns an indicator of whether there is a legend available at the specified scale.
void	setCanHide(boolean canHide) Sets whether layer list legends can be hidden by the user for this layer.
void	setVisible(boolean visible) Sets whether layer list legends are visible for this layer.
int	size() Returns the number of legends in the array.

Methods inherited from class java.lang.Object

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

Constructor Detail

LayerListLegends

public LayerListLegends()

Creates a new instance of AimsLayerListLegends

Method Detail

clone

public java.lang.Object clone()

Gets a clone of this object.

Returns:

The clone.

getCopy

public LayerListLegends getCopy()

Gets a copy of this object.

Returns:

The copy.

add

public void add(LayerListLegend legend)

Adds a new legend to the array.

Parameters:

legend - The legend.

getCanHide

public boolean getCanHide()

Returns an indicator of whether the user can hide the legend for this layer.

Returns:

True if it can be hidden, otherwise false.

setCanHide

public void setCanHide(boolean canHide)

Sets whether layer list legends can be hidden by the user for this layer.

Parameters:

canHide - True if it can be hidden, otherwise false.

get

public LayerListLegend get(int index)

Gets the legend at the specified index.

Parameters:

index - The index number.

Returns:

The legend, or null.

getLegendForScale

public LayerListLegend getLegendForScale(double scale)

Gets the first legend visible at the specified scale.

Parameters:

scale - The scale of the map.

Returns:

The legend, or null.

hasLegendForScale

public boolean hasLegendForScale(double scale)

Returns an indicator of whether there is a legend available at the specified scale.

Parameters:

scale - The scale.

Returns:

True if there is a legend, otherwise false.

getLegendHeightForScale

public int getLegendHeightForScale(double scale)

Gets the height of the legend for the specified scale.

Parameters:

scale - The scale.

Returns:

The image height, in pixels.

getLegendUrlForScale

public java.lang.String getLegendUrlForScale(double scale)

Gets the url for the legend for the specified scale.

Parameters:

scale - The scale.

Returns:

The utl of the legend image.

getLegendWidthForScale

public int getLegendWidthForScale(double scale)

Gets the width of the legend for the specified scale.

Parameters:

scale - The scale.

Returns:

The image width, in pixels.

size

public int size()

Returns the number of legends in the array.

Returns:

The count.

getVisible

public boolean getVisible()

Returns an indicator of whether layer list legends are visible for this layer.

Returns:

True if it is set to visible, otherwise false.

setVisible

public void setVisible(boolean visible)

Sets whether layer list legends are visible for this layer.

Parameters:

visible - True if it is set to visible, otherwise false.