org.gvsig.fmap.mapcontext.rendering.legend

Interface IVectorLegend

All Superinterfaces:

Cloneable, DrawingObservable, ILegend, Legend, Persistent

All Known Subinterfaces:

IBarsChartLegend, IChartLegend, IClassifiedVectorLegend, ILinkedChartLegend, IPieChartLegend, ISingleSymbolLegend, IVectorialIntervalLegend, IVectorialUniqueValueLegend, VectorComplexLegend

All Known Implementing Classes:

AbstractClassifiedVectorLegend, AbstractIntervalLegend, AbstractVectorialLegend, BarsChartLegend, BasePieChartLegend, DefaultVectorComplexLegend, LinkedChartLegend, PieChartLegend, SingleSymbolLegend, VectorialIntervalLegend, VectorialUniqueValueLegend

public interface IVectorLegend
extends ILegend, DrawingObservable

Interface of a vectorial legend.

Method Summary

Modifier and Type	Method and Description
void	draw(BufferedImage image, Graphics2D graphics2D, ViewPort viewPort, Cancellable cancel, double scale, Map queryParameters, ICoordTrans coordTrans, FeatureStore featureStore) Draws the FeatureStore data using this legend simbology.
void	draw(BufferedImage image, Graphics2D graphics2D, ViewPort viewPort, Cancellable cancel, double scale, Map queryParameters, ICoordTrans coordTrans, FeatureStore featureStore, FeatureQuery featureQuery) Draws the FeatureStore data using this legend simbology.
ISymbol	getDefaultSymbol() Obtains the default symbol of the legend.
int	getShapeType() Returns the type of the shape.
ISymbol	getSymbolByFeature(Feature feat) Returns a symbol starting from an IFeature.
boolean	isSuitableForShapeType(int shapeType)
boolean	isUseDefaultSymbol() Returns true or false depending on if the rest of values are used.
void	print(Graphics2D g, ViewPort viewPort, Cancellable cancel, double scale, Map queryParameters, ICoordTrans coordTrans, FeatureStore featureStore, FeatureQuery featureQuery, PrintAttributes properties)
void	print(Graphics2D g, ViewPort viewPort, Cancellable cancel, double scale, Map queryParameters, ICoordTrans coordTrans, FeatureStore featureStore, PrintAttributes properties)
void	setDefaultSymbol(ISymbol s) Establishes the default symbol of a legend.
void	setShapeType(int shapeType) Defines the type of the shape.
void	useDefaultSymbol(boolean b)

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

addLegendListener, cloneLegend, fireDefaultSymbolChangedEvent, getListeners, removeLegendListener

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

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

clone

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

addDrawingObserver, deleteDrawingObserver, deleteDrawingObservers

Method Detail

getDefaultSymbol

ISymbol getDefaultSymbol()

Obtains the default symbol of the legend.

Specified by:

getDefaultSymbol in interface ILegend

Returns:

default symbol.

getSymbolByFeature

ISymbol getSymbolByFeature(Feature feat)
                    throws MapContextException

Returns a symbol starting from an IFeature.

Parameters:

feat - IFeature.

Returns:

Símbolo.

Throws:

MapContextException

getShapeType

int getShapeType()

Returns the type of the shape.

Returns:

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

setShapeType

void setShapeType(int shapeType)

Defines the type of the shape.

Parameters:

shapeType - type of the shape.

setDefaultSymbol

void setDefaultSymbol(ISymbol s)

Establishes the default symbol of a legend. In a SingleSymbolLegend the symbol is established by calling this method.

Parameters:

s - default symbol.

isUseDefaultSymbol

boolean isUseDefaultSymbol()

Returns true or false depending on if the rest of values are used.

Returns:

True if the rest of values are used.

useDefaultSymbol

void useDefaultSymbol(boolean b)

isSuitableForShapeType

boolean isSuitableForShapeType(int shapeType)

draw

void draw(BufferedImage image,
          Graphics2D graphics2D,
          ViewPort viewPort,
          Cancellable cancel,
          double scale,
          Map queryParameters,
          ICoordTrans coordTrans,
          FeatureStore featureStore)
   throws LegendException

Draws the FeatureStore data using this legend simbology.

Parameters:

image - the base image to draw over

graphics2D - the Graphics2D to draw to

viewPort - the ViewPort to use

cancel - the Cancellable delegate object

scale - the scale of the view

queryParameters - the query parameters

coordTrans - the transformation coordinates to use for reprojection

featureStore - FeatureStore to load the data to draw from

Throws:

LegendException

draw

void draw(BufferedImage image,
          Graphics2D graphics2D,
          ViewPort viewPort,
          Cancellable cancel,
          double scale,
          Map queryParameters,
          ICoordTrans coordTrans,
          FeatureStore featureStore,
          FeatureQuery featureQuery)
   throws LegendException

Draws the FeatureStore data using this legend simbology.

Parameters:

image - the base image to draw over

graphics2D - the Graphics2D to draw to

viewPort - the ViewPort to use

cancel - the Cancellable delegate object

scale - the scale of the view

queryParameters - the query parameters

coordTrans - the transformation coordinates to use for reprojection

featureStore - FeatureStore to load the data to draw from

featureQuery - the query used to filter the features.

Throws:

LegendException

print

void print(Graphics2D g,
           ViewPort viewPort,
           Cancellable cancel,
           double scale,
           Map queryParameters,
           ICoordTrans coordTrans,
           FeatureStore featureStore,
           PrintAttributes properties)
    throws LegendException

Throws:

LegendException

print

void print(Graphics2D g,
           ViewPort viewPort,
           Cancellable cancel,
           double scale,
           Map queryParameters,
           ICoordTrans coordTrans,
           FeatureStore featureStore,
           FeatureQuery featureQuery,
           PrintAttributes properties)
    throws LegendException

Throws:

LegendException