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

Class MarkerFillSymbol

java.lang.Object

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

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

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

All Implemented Interfaces:

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

public class MarkerFillSymbol
extends AbstractFillSymbol
implements IMarkerFillSymbol

Allows to define a marker symbol of any type as a path image to be used for a filled of a polygon's padding

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MarkerFillSymbol.RegisterPersistence
static class	MarkerFillSymbol.RegisterSymbol

Field Summary

Fields

Modifier and Type	Field and Description
static int	DefaultFillStyle
static int	GRID_FILL
static java.lang.String	MARK_FILL_SYMBOL_PERSISTENCE_DEFINITION_NAME
static int	RANDOM_FILL
static int	SINGLE_CENTERED_SYMBOL

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

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
MarkerFillSymbol()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
void	draw(java.awt.Graphics2D g, java.awt.geom.AffineTransform affineTransform, Geometry geom, Feature feat, 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(java.awt.Graphics2D g, java.awt.geom.AffineTransform scaleInstance, java.awt.Rectangle r, PrintAttributes properties) Useful to render the symbol inside the TOC, or inside little rectangles.
java.lang.String	getClassName()
java.awt.Color	getFillColor()
IMarkerSymbol	getMarker()
IMarkerFillPropertiesStyle	getMarkerFillProperties() Returns the markerfillproperties that are used by the class
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.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	print(java.awt.Graphics2D g, java.awt.geom.AffineTransform at, Geometry geom, PrintAttributes properties)
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	setFillColor(java.awt.Color color) Sets the color that will be used to draw the filling pattern of this symbol.
void	setMarker(IMarkerSymbol marker)
void	setMarkerFillProperties(IMarkerFillPropertiesStyle markerFillStyle) Sets the markerfillproperties to be used by the class
void	setReferenceSystem(int system) Sets the Reference System that defines how this units have to be handled.
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.fill.impl.AbstractFillSymbol

getCartographicSize, getColor, getFillAlpha, getOnePointRgb, getOutline, getPixExtentPlus, hasFill, hasOutline, isSuitableFor, setColor, setHasFill, setHasOutline, setOutline

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

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

Methods inherited from class java.lang.Object

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

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

getFillAlpha, getOnePointRgb, getOutline, hasFill, hasOutline, isSuitableFor, setHasFill, setHasOutline, setOutline

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

getColor, getDescription, getPixExtentPlus, isOneDotOrPixel, isShapeVisible, setColor, setDescription

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

getCartographicSize, getReferenceSystem, getUnit

Field Detail

MARK_FILL_SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String MARK_FILL_SYMBOL_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

RANDOM_FILL

public static final int RANDOM_FILL

See Also:

Constant Field Values

GRID_FILL

public static final int GRID_FILL

See Also:

Constant Field Values

SINGLE_CENTERED_SYMBOL

public static final int SINGLE_CENTERED_SYMBOL

See Also:

Constant Field Values

DefaultFillStyle

public static int DefaultFillStyle

Constructor Detail

MarkerFillSymbol

public MarkerFillSymbol()

Method Detail

getSymbolForSelection

public ISymbol getSymbolForSelection()

Description copied from interface: ISymbol

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

Specified by:

getSymbolForSelection in interface ISymbol

Returns:

ISymbol applied to a feature when it has been selected.

draw

public void draw(java.awt.Graphics2D g,
        java.awt.geom.AffineTransform affineTransform,
        Geometry geom,
        Feature feat,
        Cancellable cancel)

Description copied from interface: ISymbol

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

Specified by:

draw in interface ISymbol

cancel - TODO

getSymbolType

public int getSymbolType()

Description copied from interface: ISymbol

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

Specified by:

getSymbolType in interface ISymbol

Returns:

FSymbol constants. I think it is better to use isSuitableFor

drawInsideRectangle

public void drawInsideRectangle(java.awt.Graphics2D g,
                       java.awt.geom.AffineTransform scaleInstance,
                       java.awt.Rectangle r,
                       PrintAttributes properties)
                         throws SymbolDrawingException

Description copied from interface: ISymbol

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.

Specified by:

drawInsideRectangle in interface ISymbol

properties - TODO

Throws:

SymbolDrawingException - TODO

getClassName

public java.lang.String getClassName()

setMarker

public void setMarker(IMarkerSymbol marker)

Specified by:

setMarker in interface IMarkerFillSymbol

getMarker

public IMarkerSymbol getMarker()

Specified by:

getMarker in interface IMarkerFillSymbol

getFillColor

public java.awt.Color getFillColor()

Specified by:

getFillColor in interface IFillSymbol

Overrides:

getFillColor in class AbstractFillSymbol

Returns:

Returns the color.

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

Overrides:

setFillColor in class AbstractFillSymbol

print

public void print(java.awt.Graphics2D g,
         java.awt.geom.AffineTransform at,
         Geometry geom,
         PrintAttributes properties)

Specified by:

print in interface IPrintable

setMarkerFillProperties

public void setMarkerFillProperties(IMarkerFillPropertiesStyle markerFillStyle)

Sets the markerfillproperties to be used by the class

Specified by:

setMarkerFillProperties in interface IMarkerFillSymbol

Parameters:

markerFillStyle,IMarkerFillPropertiesStyle -

getMarkerFillProperties

public IMarkerFillPropertiesStyle getMarkerFillProperties()

Returns the markerfillproperties that are used by the class

Specified by:

getMarkerFillProperties in interface IMarkerFillSymbol

Returns:

markerFillProperties,IMarkerFillPropertiesStyle

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 AbstractFillSymbol

setReferenceSystem

public void setReferenceSystem(int system)

Description copied from interface: CartographicSupport

Sets the Reference System that defines how this units have to be handled. Possible values are:

1. CartographySupport.WORLD: Defines that the unit values refer to distances in the world. So, the size of the element displayed depends directly on the scale and CRS used by the map. The size of the elements defined to use CartographicSupport.WORLD will match exactly to their actual size in the real world.
2. CartographySupport.PAPER: Defines that the unit values refer to the length that the element will have regardless where it appears. If ReferenceSystem is CartographySupport.PAPER, and the length is (e.g.) millimeters the element will be displayed with the same amount of millimeters of length whether in the screen or the printer (screen DPI and printer DPI must be correctly configured).

Specified by:

setReferenceSystem in interface CartographicSupport

Overrides:

setReferenceSystem in class AbstractSymbol

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

Overrides:

setCartographicSize in class AbstractFillSymbol

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

Overrides:

toCartographicSize in class AbstractFillSymbol

Returns:

a double containing the previous defined size

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 AbstractFillSymbol

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 AbstractFillSymbol

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 AbstractFillSymbol

Throws:

PersistenceException