org.gvsig.fmap.mapcontext.rendering.symbols

Interface ISymbol

All Superinterfaces:

Cloneable, IPrintable, Persistent

All Known Subinterfaces:

IChartSymbol, IFillSymbol, ILineSymbol, IMarkerFillSymbol, IMarkerSymbol, IMultiChartSymbol, IMultiLayerFillSymbol, IMultiLayerLineSymbol, IMultiLayerMarkerSymbol, IMultiLayerSymbol, IPictureFillSymbol, IPictureLineSymbol, IPictureMarkerSymbol, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol, ISimpleTextSymbol, ISymbol_v2, ITextSymbol, IWarningSymbol

All Known Implementing Classes:

AbstractFillSymbol, AbstractLineSymbol, AbstractMarkerSymbol, AbstractSymbol, ArrowMarkerSymbol, CharacterMarkerSymbol, ChartSymbol, LinkedChartSymbol, MarkerFillSymbol, MultiLayerFillSymbol, MultiLayerLineSymbol, MultiLayerMarkerSymbol, MultiShapeSymbol, PictureFillSymbol, PictureLineSymbol, PictureMarkerSymbol, SimpleFillSymbol, SimpleLineSymbol, SimpleMarkerSymbol, SimpleTextSymbol, SmartTextSymbol, WarningSymbol

public interface ISymbol
extends Persistent, IPrintable, Cloneable

Interface for symbols.It is the most general one which is implemented by other specific symbols.For this reason this interface has a method to obtain the derived version of a common symbol(apart from others). The main purpose is to offer a set of symbols that will be part of the FMap kernel and allow the developer to add new symbols without changes in the initial implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static Color	SELECTION_COLOR

Method Summary

Modifier and Type	Method and Description
void	draw(Graphics2D g, AffineTransform affineTransform, Geometry geom, Feature f, Cancellable cancel) Used when a symbol is going to be drawn.The method to do it will depend on the derived version of the symbol.
void	drawInsideRectangle(Graphics2D g, AffineTransform scaleInstance, Rectangle r, PrintAttributes properties) Useful to render the symbol inside the TOC, or inside little rectangles.
Color	getColor() Returns the Color to use to render the symbol.
String	getDescription() The description is a human-readable text used to label it when show in a symbol menu or something like that.
int	getOnePointRgb() Returns the rgb of the symbol when it is drawn like a point.
void	getPixExtentPlus(Geometry geom, float[] distances, ViewPort viewPort, int dpi) Returns the distance between the shape's bounding box and the symbol-that-represents-this-shape's bounding box in a two-length-float array passed as parameter.
ISymbol	getSymbolForSelection() Returns the derived version of the symbol that will be used to draw the feature when it is selected.
int	getSymbolType() The use of this method -and its mechanism- is being valorated.
boolean	isOneDotOrPixel(Geometry geom, double[] positionOfDotOrPixel, ViewPort viewPort, int dpi) Informs that the geometry will be represented with that symbol in just one pixel or dot
boolean	isShapeVisible() Tells whether the shape of the symbol will be drawn or not.
boolean	isSuitableFor(Geometry geom) True if this symbol is ok for the geometry.
void	setColor(Color color) Sets the Color to use to render the symbol.
void	setDescription(String desc) Sets the description of this symbol

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

loadFromState, saveToState

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.IPrintable

print

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

clone

Field Detail

SELECTION_COLOR

static final Color SELECTION_COLOR

Method Detail

getSymbolForSelection

ISymbol getSymbolForSelection()

Returns the derived version of the symbol that will be used to draw the feature when it is selected.

Returns:

ISymbol applied to a feature when it has been selected.

draw

void draw(Graphics2D g,
          AffineTransform affineTransform,
          Geometry geom,
          Feature f,
          Cancellable cancel)

Used when a symbol is going to be drawn.The method to do it will depend on the derived version of the symbol.

Parameters:

g -

affineTransform -

shp -

cancel - TODO

getPixExtentPlus

void getPixExtentPlus(Geometry geom,
                      float[] distances,
                      ViewPort viewPort,
                      int dpi)

Returns the distance between the shape's bounding box and the symbol-that-represents-this-shape's bounding box in a two-length-float array passed as parameter.

After this method returns, the float array passed will contain two values representing the amount of pixels separating each of the X (first element) and Y (second element) axes.

This distance maybe dependent on:

1. The ViewPort: if the symbol is an instance of CartographicSupport the units it uses are not pixels and the reference system is CarthographicSupport.WORLD.
2. The target rendering context's dpi (dots-per-inch): if the symbol is an instance of CartographicSupport the units it uses are not pixels and CarthographicSupport.PAPER.

And in any other case, if the unit of the symbol is pixels or the symbol is not even an instance of CartographicSupport, the returning values are only defined by the symbol and are not calculated.

Parameters:

ViewPort - viewPort

Shape - shp

int - dpi

float[] - distances, the array of floats where to store the distances in x and y axis

isOneDotOrPixel

boolean isOneDotOrPixel(Geometry geom,
                        double[] positionOfDotOrPixel,
                        ViewPort viewPort,
                        int dpi)

Informs that the geometry will be represented with that symbol in just one pixel or dot

Parameters:

geom -

positionOfDotOrPixel - (out) filled with pixel or dot location

viewPort -

dpi -

Returns:

getOnePointRgb

int getOnePointRgb()

Returns the rgb of the symbol when it is drawn like a point.

Returns:

rgb of the symbol.

getDescription

String getDescription()

The description is a human-readable text used to label it when show in a symbol menu or something like that.

Returns:

description of this symbol.

isShapeVisible

boolean isShapeVisible()

Tells whether the shape of the symbol will be drawn or not.

Returns:

true if Shape must be drawn. Useful if you are labelling

setDescription

void setDescription(String desc)

Sets the description of this symbol

Parameters:

desc, - a string with the description

See Also:

ISymbol.getDescription();

getSymbolType

int getSymbolType()

The use of this method -and its mechanism- is being valorated. It probably will be deprecated.

Returns:

FSymbol constants. I think it is better to use isSuitableFor

isSuitableFor

boolean isSuitableFor(Geometry geom)

True if this symbol is ok for the geometry. For example, a FillSymbol will be suitable for a Polygon.

Parameters:

geom -

Returns:

drawInsideRectangle

void drawInsideRectangle(Graphics2D g,
                         AffineTransform scaleInstance,
                         Rectangle r,
                         PrintAttributes properties)
                  throws SymbolDrawingException

Useful to render the symbol inside the TOC, or inside little rectangles. For example, think about rendering a Label with size in meters => You will need to specify a size in pixels. Of course, you can also to choose to render a prepared image, etc.

Parameters:

scaleInstance -

r -

properties - TODO

g2 -

Throws:

SymbolDrawingException - TODO

getColor

Color getColor()

Returns the Color to use to render the symbol.

Parameters:

-

Returns:

the Color to use to render the symbol

setColor

void setColor(Color color)

Sets the Color to use to render the symbol.

Parameters:

color - to render the symbol