org.gvsig.fmap.mapcontext.rendering.symbols.styles

Interface IStyle

All Superinterfaces:

java.lang.Cloneable, Persistent

All Known Subinterfaces:

IArrowDecoratorStyle, IBackgroundFileStyle, ILabelStyle, ILineStyle, IMarkerFillPropertiesStyle, IMask, ISimpleLineStyle

All Known Implementing Classes:

AbstractStyle, ArrowDecoratorStyle, BackgroundFileStyle, DefaultMask, ImageStyle, PointLabelPositioner, RemoteFileStyle, SimpleLabelStyle, SimpleLineStyle, SimpleMarkerFillPropertiesStyle, SVGStyle

public interface IStyle
extends Persistent, Cloneable

Used by Objects that have to define an style for them.This interface has methods to stablish a description and get it,to specify if an object that implements this interface is suitable for a kind of symbol and other methods to draw symbols.

Method Summary

Modifier and Type	Method and Description
void	drawInsideRectangle(java.awt.Graphics2D g, java.awt.Rectangle r) Useful to render the symbol inside the TOC, or inside little rectangles.
void	drawOutline(java.awt.Graphics2D g, java.awt.Rectangle r) Used to show an outline of the style to graphically show its properties.
java.lang.String	getDescription() Returns the description of a symbol
boolean	isSuitableFor(ISymbol symbol) True if this symbol is ok for the style or class.
void	setDescription(java.lang.String desc) Defines the description of a symbol.It will be specified with an string.

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

loadFromState, saveToState

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

clone, cloneQuietly, cloneQuietly

Method Detail

setDescription

void setDescription(java.lang.String desc)

Defines the description of a symbol.It will be specified with an string.

Parameters:

desc,String -

getDescription

java.lang.String getDescription()

Returns the description of a symbol

Returns:

Description of a symbol

drawInsideRectangle

void drawInsideRectangle(java.awt.Graphics2D g,
                         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 may also preffer to render a prepared image, etc.

Parameters:

g - Graphics2D

r - Rectangle

Throws:

SymbolDrawingException

isSuitableFor

boolean isSuitableFor(ISymbol symbol)

True if this symbol is ok for the style or class.

Parameters:

symbol - ISymbol

drawOutline

void drawOutline(java.awt.Graphics2D g,
                 java.awt.Rectangle r)
          throws SymbolDrawingException

Used to show an outline of the style to graphically show its properties.

Parameters:

g, - the Graphics2D where to draw

r, - the bounds of the style inside such Graphics2D

Throws:

SymbolDrawingException