org.gvsig.symbology.fmap.mapcontext.rendering.symbol.fill.impl

Class AbstractFillSymbol

java.lang.Object

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractSymbol

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.fill.impl.AbstractFillSymbol

All Implemented Interfaces:

java.lang.Cloneable, CartographicSupport, IPrintable, ISymbol, ISymbol_v2, IFillSymbol, Persistent

Direct Known Subclasses:

MarkerFillSymbol, MultiLayerFillSymbol, PictureFillSymbol, SimpleFillSymbol

public abstract class AbstractFillSymbol
extends AbstractSymbol
implements IFillSymbol

Abstract class that any FILL SYMBOL should extend

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractFillSymbol.RegisterPersistence

Field Summary

Fields

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

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractSymbol

SYMBOL_PERSISTENCE_DEFINITION_NAME

Fields inherited from interface org.gvsig.symbology.fmap.mapcontext.rendering.symbol.fill.IFillSymbol

SYMBOL_NAME

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol

SELECTION_COLOR

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.CartographicSupport

PAPER, WORLD

Constructor Summary

Constructors

Constructor and Description
AbstractFillSymbol()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
double	getCartographicSize(ViewPort viewPort, double dpi, Geometry geom) Gets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).
java.awt.Color	getColor() Returns the Color to use to render the symbol.
int	getFillAlpha() Obtains the transparency of the fill symbol
java.awt.Color	getFillColor()
int	getOnePointRgb() Returns the rgb of the symbol when it is drawn like a point.
ILineSymbol	getOutline() Obtains the ILineSymbol interface of the outline
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.
boolean	hasFill()
boolean	hasOutline()
boolean	isSuitableFor(Geometry geom) True if this symbol is ok for the geometry.
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	setCartographicSize(double cartographicSize, Geometry geom) Sets the size of the cartographic element in pixels.
void	setColor(java.awt.Color color) Sets the Color to use to render the symbol.
void	setFillColor(java.awt.Color color) Sets the color that will be used to draw the filling pattern of this symbol.
void	setHasFill(boolean hasFill)
void	setHasOutline(boolean hasOutline)
void	setOutline(ILineSymbol outline) Sets the color of the outline.
void	setUnit(int unitIndex) Defines the unit used to express measures.
double	toCartographicSize(ViewPort viewPort, double dpi, Geometry geom) Computes and sets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl.AbstractSymbol

cloneForSelection, equals, getDescription, getID, getReferenceSystem, getUnit, isOneDotOrPixel, isShapeVisible, setDescription, setID, setIsShapeVisible, setReferenceSystem

Methods inherited from class java.lang.Object

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

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

draw, drawInsideRectangle, getDescription, getSymbolForSelection, getSymbolType, isOneDotOrPixel, isShapeVisible, setDescription

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

print

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

getReferenceSystem, getUnit, setReferenceSystem

Field Detail

FILL_SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String FILL_SYMBOL_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractFillSymbol

public AbstractFillSymbol()

Method Detail

isSuitableFor

public boolean isSuitableFor(Geometry geom)

Description copied from interface: ISymbol

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

Specified by:

isSuitableFor in interface ISymbol

Specified by:

isSuitableFor in interface IFillSymbol

Returns:

getOnePointRgb

public int getOnePointRgb()

Description copied from interface: ISymbol

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

Specified by:

getOnePointRgb in interface ISymbol

Specified by:

getOnePointRgb in interface IFillSymbol

Returns:

rgb of the symbol.

getPixExtentPlus

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

Description copied from interface: ISymbol

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.

Specified by:

getPixExtentPlus in interface ISymbol

setFillColor

public void setFillColor(java.awt.Color color)

Description copied from interface: IFillSymbol

Sets the color that will be used to draw the filling pattern of this symbol.

Specified by:

setFillColor in interface IFillSymbol

setOutline

public void setOutline(ILineSymbol outline)

Description copied from interface: IFillSymbol

Sets the color of the outline.

Specified by:

setOutline in interface IFillSymbol

getFillColor

public java.awt.Color getFillColor()

Specified by:

getFillColor in interface IFillSymbol

Returns:

Returns the color.

getOutline

public ILineSymbol getOutline()

Description copied from interface: IFillSymbol

Obtains the ILineSymbol interface of the outline

Specified by:

getOutline in interface IFillSymbol

Returns:

the outline,ILineSymbol.

getFillAlpha

public int getFillAlpha()

Description copied from interface: IFillSymbol

Obtains the transparency of the fill symbol

Specified by:

getFillAlpha in interface IFillSymbol

Returns:

the transparency of the fill symbol

setCartographicSize

public void setCartographicSize(double cartographicSize,
                       Geometry geom)

Description copied from interface: CartographicSupport

Sets the size of the cartographic element in pixels.

Specified by:

setCartographicSize in interface CartographicSupport

toCartographicSize

public double toCartographicSize(ViewPort viewPort,
                        double dpi,
                        Geometry geom)

Description copied from interface: CartographicSupport

Computes and sets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Specified by:

toCartographicSize in interface CartographicSupport

Returns:

a double containing the previous defined size

hasFill

public boolean hasFill()

Specified by:

hasFill in interface IFillSymbol

setHasFill

public void setHasFill(boolean hasFill)

Specified by:

setHasFill in interface IFillSymbol

hasOutline

public boolean hasOutline()

Specified by:

hasOutline in interface IFillSymbol

setHasOutline

public void setHasOutline(boolean hasOutline)

Specified by:

setHasOutline in interface IFillSymbol

getCartographicSize

public double getCartographicSize(ViewPort viewPort,
                         double dpi,
                         Geometry geom)

Description copied from interface: CartographicSupport

Gets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Specified by:

getCartographicSize in interface CartographicSupport

Returns:

double containing the size in [screen/printer] pixels for the current symbol

setUnit

public void setUnit(int unitIndex)

Description copied from interface: CartographicSupport

Defines the unit used to express measures. It is the position of the unit in the MapContext.NAMES array.

Specified by:

setUnit in interface CartographicSupport

Overrides:

setUnit in class AbstractSymbol

getColor

public java.awt.Color getColor()

Description copied from interface: ISymbol

Returns the Color to use to render the symbol.

Specified by:

getColor in interface ISymbol

Returns:

the Color to use to render the symbol

setColor

public void setColor(java.awt.Color color)

Description copied from interface: ISymbol

Sets the Color to use to render the symbol.

Specified by:

setColor in interface ISymbol

Parameters:

color - to render the symbol

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 AbstractSymbol

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()}.

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 AbstractSymbol

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 AbstractSymbol

Throws:

PersistenceException