org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl

Class VectorialIntervalLegend

java.lang.Object

org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractLegend

org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractVectorialLegend

org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend

org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractIntervalLegend

org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialIntervalLegend

All Implemented Interfaces:

java.lang.Cloneable, DrawingObservable, IClassifiedLegend, IClassifiedVectorLegend, ILegend, IVectorialIntervalLegend, IVectorLegend, Legend, Persistent

public class VectorialIntervalLegend
extends AbstractIntervalLegend

VectorialIntervalLegend (which should be better called GraduatedColorLegend) is a legend that allows to classify ranges of values using a color gradient based on a value.

The color gradient will be calculated according the starting color, the ending color and the amount of intervals.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VectorialIntervalLegend.RegisterLegend
static class	VectorialIntervalLegend.RegisterPersistence

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VECTORIAL_INTERVAL_LEGEND_PERSISTENCE_DEFINITION_NAME

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractIntervalLegend

defaultSymbol, EQUAL_INTERVALS, INTERVAL_LEGEND_PERSISTENCE_DEFINITION_NAME, intervalType, keys, NATURAL_INTERVALS, QUANTILE_INTERVALS, symbols, useDefaultSymbol

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend

CLASSIFIED_VECTOR_LEGEND_PERSISTENCE_DEFINITION_NAME

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractVectorialLegend

LOG, VECTORIAL_LEGEND_PERSISTENCE_DEFINITION_NAME, zSort

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractLegend

LEGEND_PERSISTENCE_DEFINITION_NAME

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.IVectorialIntervalLegend

LEGEND_NAME

Constructor Summary

Constructors

Constructor and Description
VectorialIntervalLegend() Constructor method
VectorialIntervalLegend(int type) Constructor method

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
IInterval	createInterval(double min, double max)
java.lang.String	getClassName()
java.awt.Color	getEndColor() Returns the final color
int	getShapeType() Returns the type of the shape.
java.awt.Color	getStartColor() Returns the initial color.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setEndColor(java.awt.Color endColor) Inserts the final color.
void	setShapeType(int shapeType) Defines the type of the shape.
void	setStartColor(java.awt.Color startColor) Inserts the initial color

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractIntervalLegend

addSymbol, calculateIntervals, clear, createSymbols, delSymbol, getDefaultSymbol, getDescriptions, getInterval, getIntervalType, getSymbol, getSymbolByFeature, getSymbolByInterval, getSymbols, getValues, isUseDefaultSymbol, replace, setDefaultSymbol, setIntervals, setIntervalType, useDefaultSymbol

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend

fireClassifiedSymbolChangeEvent, fireLegendClearEvent, getClassifyingFieldNames, getClassifyingFieldTypes, getRequiredFeatureAttributeNames, isSuitableForShapeType, setClassifyingFieldNames, setClassifyingFieldTypes

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractVectorialLegend

draw, draw, draw, drawFeatures, getZSort, internalDraw, isDrawSymbolInEeachPrimitive, print, print, setDrawSymbolInEeachPrimitive, setZSort

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractLegend

addDrawingObserver, addLegendListener, addObserver, beginComplexNotification, cloneLegend, countObservers, deleteDrawingObserver, deleteDrawingObservers, deleteObserver, disableNotifications, enableNotifications, endComplexNotification, fireDefaultSymbolChangedEvent, getListeners, getManager, getSymbolManager, inComplex, isEnabledNotifications, notifyObservers, notifyObservers, removeLegendListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.IClassifiedVectorLegend

getClassifyingFieldNames, getClassifyingFieldTypes, setClassifyingFieldNames, setClassifyingFieldTypes

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.IVectorLegend

draw, draw, isSuitableForShapeType, print, print

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.ILegend

addLegendListener, cloneLegend, fireDefaultSymbolChangedEvent, getListeners, removeLegendListener

Methods inherited from interface org.gvsig.tools.lang.Cloneable

cloneQuietly, cloneQuietly

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.DrawingObservable

addDrawingObserver, deleteDrawingObserver, deleteDrawingObservers

Field Detail

VECTORIAL_INTERVAL_LEGEND_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String VECTORIAL_INTERVAL_LEGEND_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

VectorialIntervalLegend

public VectorialIntervalLegend()

Constructor method

VectorialIntervalLegend

public VectorialIntervalLegend(int type)

Constructor method

Parameters:

type - type of the shape.

Method Detail

getEndColor

public java.awt.Color getEndColor()

Returns the final color

Returns:

Color final color.

setEndColor

public void setEndColor(java.awt.Color endColor)

Inserts the final color.

Parameters:

endColor - final color.

getStartColor

public java.awt.Color getStartColor()

Returns the initial color.

Returns:

Color initial color.

setStartColor

public void setStartColor(java.awt.Color startColor)

Inserts the initial color

Parameters:

startColor - initial color.

getShapeType

public int getShapeType()

Description copied from interface: IVectorLegend

Returns the type of the shape.

Returns:

Returns the type of the shapes that the legend is ready to use.

setShapeType

public void setShapeType(int shapeType)

Description copied from interface: IVectorLegend

Defines the type of the shape.

Parameters:

shapeType - type of the shape.

getClassName

public java.lang.String getClassName()

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class AbstractIntervalLegend

Returns:

a copy of the object

Throws:

java.lang.CloneNotSupportedException - if the instance of the object cannot be cloned. As this is extending Cloneable so its sure it implements it, so this exception may be used for problems on specific object instances.

See Also:

Object#clone()}.

createInterval

public IInterval createInterval(double min,
                                double max)

loadFromState

public void loadFromState(PersistentState state)
                   throws PersistenceException

Description copied from interface: Persistent

Set the state of the object from the state passed as parameter.

Specified by:

loadFromState in interface Persistent

Overrides:

loadFromState in class AbstractIntervalLegend

Throws:

PersistenceException

saveToState

public void saveToState(PersistentState state)
                 throws PersistenceException

Description copied from interface: Persistent

Saves the internal state of the object on the provided PersistentState object.

Specified by:

saveToState in interface Persistent

Overrides:

saveToState in class AbstractIntervalLegend

Throws:

PersistenceException