org.gvsig.fmap.mapcontext.rendering.symbols

Interface ISymbol

All Superinterfaces:

java.lang.Cloneable, IPrintable, Persistent

All Known Subinterfaces:

DynamicSymbol, IFillSymbol, ILineSymbol, IMarkerFillSymbol, IMarkerSymbol, IMarkerSymbol_v2, 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, DefaultDynamicSymbol, 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 java.awt.Color	SELECTION_COLOR

Method Summary

Modifier and Type	Method and Description
void	draw(java.awt.Graphics2D g, java.awt.geom.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	draw(java.awt.Graphics2D g, java.awt.geom.AffineTransform affineTransform, Geometry geom, Feature f, Cancellable cancel, java.awt.Rectangle r)
void	drawInsideRectangle(java.awt.Graphics2D g, java.awt.geom.AffineTransform scaleInstance, java.awt.Rectangle r) Useful to render the symbol inside the TOC, or inside little rectangles.
java.awt.Color	getColor() Returns the Color to use to render the symbol.
java.lang.String	getDescription() The description is a human-readable text used to label it when show in a symbol menu or something like that.
Feature	getFeature()
java.lang.String	getID() Get the id ob the symbol (the basename of file).This attribute is not persistent.
ISymbol	getSymbolForSelection() Returns the derived version of the symbol that will be used to draw the feature when it is selected.
ISymbol	getSymbolForSelection(java.awt.Color selectionColor)
int	getSymbolType() The use of this method -and its mechanism- is being valorated.
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(java.awt.Color color) Sets the Color to use to render the symbol.
void	setDescription(java.lang.String desc) Sets the description of this symbol
void	setFeature(Feature feature)
void	setID(java.lang.String id) Set the id ob the symbol (the basename of file).

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, cloneQuietly, cloneQuietly

Field Detail

SELECTION_COLOR

static final java.awt.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.

getSymbolForSelection

ISymbol getSymbolForSelection(java.awt.Color selectionColor)

draw

void draw(java.awt.Graphics2D g,
          java.awt.geom.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

getDescription

java.lang.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(java.lang.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(java.awt.Graphics2D g,
                         java.awt.geom.AffineTransform scaleInstance,
                         java.awt.Rectangle r)
                  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 -

g2 -

Throws:

SymbolDrawingException - TODO

getColor

java.awt.Color getColor()

Returns the Color to use to render the symbol.

Parameters:

-

Returns:

the Color to use to render the symbol

setColor

void setColor(java.awt.Color color)

Sets the Color to use to render the symbol.

Parameters:

color - to render the symbol

setID

void setID(java.lang.String id)

Set the id ob the symbol (the basename of file). This attribute is not persistent.

Parameters:

id -

getID

java.lang.String getID()

Get the id ob the symbol (the basename of file).This attribute is not persistent.

Returns:

getFeature

Feature getFeature()

setFeature

void setFeature(Feature feature)

draw

void draw(java.awt.Graphics2D g,
          java.awt.geom.AffineTransform affineTransform,
          Geometry geom,
          Feature f,
          Cancellable cancel,
          java.awt.Rectangle r)