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

Class PictureMarkerSymbol

java.lang.Object

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

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.impl.AbstractMarkerSymbol

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.impl.PictureMarkerSymbol

All Implemented Interfaces:

java.lang.Cloneable, CartographicSupport, IPrintable, ISymbol, ISymbol_v2, IMarkerSymbol, IPictureMarkerSymbol, Persistent

public class PictureMarkerSymbol
extends AbstractMarkerSymbol
implements IPictureMarkerSymbol

PictureMarkerSymbol allows to use an image file as a definition to be painted instead of a marker symbol.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

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

MARKER_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.marker.IMarkerSymbol

CIRCLE_STYLE, CROSS_STYLE, DIAMOND_STYLE, SQUARE_STYLE, STAR_STYLE, SYMBOL_NAME, TRIANGLE_STYLE, VERTICAL_LINE_STYLE, X_STYLE

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
PictureMarkerSymbol() Constructor method
PictureMarkerSymbol(java.net.URL imageURL, java.net.URL selImageURL) Constructor method

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 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(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.net.URL	getSelectedSource() Returns the URL of the image that is used as a marker symbol (when it is selected in the map)
java.net.URL	getSource() Returns the URL of the image that is used as a marker symbol
ISymbol	getSymbolForSelection() Returns the derived version of the symbol that will be used to draw the feature when it is selected.
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	setImage(java.net.URL imageUrl) Sets the file for the image to be used as a marker symbol
void	setSelImage(java.net.URL imageFileUrl) Sets the file for the image to be used as a marker symbol (when it is selected in the map)

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

getCartographicSize, getColor, getMask, getOffset, getOnePointRgb, getPixExtentPlus, getRotation, getSize, getSymbolType, isSuitableFor, print, setAlpha, setCartographicSize, setColor, setMask, setOffset, setRotation, setSize, toCartographicSize

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

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.marker.IMarkerSymbol

getColor, getMask, getOffset, getRotation, getSize, setAlpha, setColor, setMask, setOffset, setRotation, setSize

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

getDescription, getOnePointRgb, getPixExtentPlus, getSymbolType, isOneDotOrPixel, isShapeVisible, isSuitableFor, setDescription

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

print

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

getCartographicSize, getReferenceSystem, getUnit, setCartographicSize, setReferenceSystem, setUnit, toCartographicSize

Field Detail

PICTURE_MARKER_SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String PICTURE_MARKER_SYMBOL_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

PictureMarkerSymbol

public PictureMarkerSymbol()

Constructor method

PictureMarkerSymbol

public PictureMarkerSymbol(java.net.URL imageURL,
                   java.net.URL selImageURL)
                    throws java.io.IOException

Constructor method

Parameters:

imageURL - , URL of the normal image

selImageURL - , URL of the image when it is selected in the map

Throws:

java.io.IOException

Method Detail

setImage

public void setImage(java.net.URL imageUrl)
              throws java.io.IOException

Sets the file for the image to be used as a marker symbol

Specified by:

setImage in interface IPictureMarkerSymbol

Parameters:

imageFile - , File

Throws:

java.io.IOException

setSelImage

public void setSelImage(java.net.URL imageFileUrl)
                 throws java.io.IOException

Sets the file for the image to be used as a marker symbol (when it is selected in the map)

Specified by:

setSelImage in interface IPictureMarkerSymbol

Parameters:

imageFile - , File

Throws:

java.io.IOException

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

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

Overrides:

drawInsideRectangle in class AbstractMarkerSymbol

properties - TODO

Throws:

SymbolDrawingException - TODO

getClassName

public java.lang.String getClassName()

getSource

public java.net.URL getSource()

Returns the URL of the image that is used as a marker symbol

Specified by:

getSource in interface IPictureMarkerSymbol

Returns:

imagePath,URL

getSelectedSource

public java.net.URL getSelectedSource()

Returns the URL of the image that is used as a marker symbol (when it is selected in the map)

Specified by:

getSelectedSource in interface IPictureMarkerSymbol

Returns:

selimagePath,URL

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 AbstractMarkerSymbol

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 AbstractMarkerSymbol

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 AbstractMarkerSymbol

Throws:

PersistenceException