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

Class PictureFillSymbol

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.PictureFillSymbol

All Implemented Interfaces:

Cloneable, CartographicSupport, IPrintable, ISymbol, ISymbol_v2, IFillSymbol, IPictureFillSymbol, Persistent

public class PictureFillSymbol
extends AbstractFillSymbol
implements IPictureFillSymbol

PictureFillSymbol allows to use an image file suported by gvSIG as a padding for the polygons.This image can be modified using methods to scale or rotate it.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PICTURE_FILL_SYMBOL_PERSISTENCE_DEFINITION_NAME

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
PictureFillSymbol() Constructor method
PictureFillSymbol(URL imageURL, URL selImageURL) Constructor method

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates a copy of the object.
void	draw(Graphics2D g, 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(Graphics2D g, AffineTransform scaleInstance, Rectangle r, PrintAttributes properties) Useful to render the symbol inside the TOC, or inside little rectangles.
double	getAngle() Defines the angle for the rotation of the image when it is added to create the padding
IBackgroundFileStyle	getBackgroundFileStyle() Returns the style associated to the image used in this symbol
String	getClassName()
IMarkerFillPropertiesStyle	getMarkerFillProperties() Returns the IMarkerFillProperties that allows this class to treat the picture as a marker in order to scale it, rotate it and so on.
IBackgroundFileStyle	getSelectedBackgroundFileStyle() Returns the style associated to the image used in this symbol when the feature is selected
URL	getSelectedSource() Returns the URL of the image used when the polygon is selected
URL	getSource() Returns the URL of the image that is used to create the padding to fill the polygon
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.
double	getXScale() Defines the scale for the x axis of the image when it is added to create the padding
double	getYScale() Defines the scale for the y axis of the image when it is added to create the padding
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	print(Graphics2D g, AffineTransform at, Geometry geom, PrintAttributes properties)
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setAngle(double angle) Sets the angle for the rotation of the image when it is added to create the padding
void	setImage(URL imageUrl) Defines the URL from where the picture to fill the polygon is taken.
void	setMarkerFillProperties(IMarkerFillPropertiesStyle prop) Sets the MarkerFillProperties in order to allow the user to modify the picture as a marker (it is possible to scale it, rotate it and so on)
void	setSelImage(URL selImageUrl) Sets the URL for the image to be used as a picture fill symbol (when it is selected in the map)
void	setXScale(double xScale) Returns the scale for the x axis of the image when it is added to create the padding
void	setYScale(double yScale) Returns the scale for the y axis of the image when it is added to create the padding
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, getFillColor, getOnePointRgb, getOutline, getPixExtentPlus, hasFill, hasOutline, isSuitableFor, setCartographicSize, setColor, setFillColor, setHasFill, setHasOutline, setOutline, setUnit

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.symbology.fmap.mapcontext.rendering.symbol.fill.IFillSymbol

getFillAlpha, getFillColor, getOnePointRgb, getOutline, hasFill, hasOutline, isSuitableFor, setFillColor, 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, setCartographicSize, setReferenceSystem, setUnit

Field Detail

PICTURE_FILL_SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final String PICTURE_FILL_SYMBOL_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

PictureFillSymbol

public PictureFillSymbol()

Constructor method

PictureFillSymbol

public PictureFillSymbol(URL imageURL,
                         URL selImageURL)
                  throws IOException

Constructor method

Parameters:

imageURL, - URL of the normal image

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

Throws:

IOException

Method Detail

setSelImage

public void setSelImage(URL selImageUrl)
                 throws IOException

Sets the URL for the image to be used as a picture fill symbol (when it is selected in the map)

Specified by:

setSelImage in interface IPictureFillSymbol

Parameters:

imageFile, - File

Throws:

IOException

setImage

public void setImage(URL imageUrl)
              throws IOException

Defines the URL from where the picture to fill the polygon is taken.

Specified by:

setImage in interface IPictureFillSymbol

Parameters:

imageFile -

Throws:

IOException

drawInsideRectangle

public void drawInsideRectangle(Graphics2D g,
                                AffineTransform scaleInstance,
                                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

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.

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

getClassName

public String getClassName()

print

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

Specified by:

print in interface IPrintable

getMarkerFillProperties

public IMarkerFillPropertiesStyle getMarkerFillProperties()

Returns the IMarkerFillProperties that allows this class to treat the picture as a marker in order to scale it, rotate it and so on.

Specified by:

getMarkerFillProperties in interface IPictureFillSymbol

Returns:

markerFillProperties,IMarkerFillPropertiesStyle

setMarkerFillProperties

public void setMarkerFillProperties(IMarkerFillPropertiesStyle prop)

Sets the MarkerFillProperties in order to allow the user to modify the picture as a marker (it is possible to scale it, rotate it and so on)

Specified by:

setMarkerFillProperties in interface IPictureFillSymbol

Parameters:

prop -

getAngle

public double getAngle()

Defines the angle for the rotation of the image when it is added to create the padding

Specified by:

getAngle in interface IPictureFillSymbol

Returns:

angle

setAngle

public void setAngle(double angle)

Sets the angle for the rotation of the image when it is added to create the padding

Specified by:

setAngle in interface IPictureFillSymbol

Parameters:

angle -

getXScale

public double getXScale()

Defines the scale for the x axis of the image when it is added to create the padding

Specified by:

getXScale in interface IPictureFillSymbol

Returns:

xScale

setXScale

public void setXScale(double xScale)

Returns the scale for the x axis of the image when it is added to create the padding

Specified by:

setXScale in interface IPictureFillSymbol

Parameters:

xScale -

getYScale

public double getYScale()

Defines the scale for the y axis of the image when it is added to create the padding

Specified by:

getYScale in interface IPictureFillSymbol

Returns:

yScale

setYScale

public void setYScale(double yScale)

Returns the scale for the y axis of the image when it is added to create the padding

Specified by:

setYScale in interface IPictureFillSymbol

Parameters:

yScale -

getSource

public URL getSource()

Returns the URL of the image that is used to create the padding to fill the polygon

Specified by:

getSource in interface IPictureFillSymbol

Returns:

imagePath

getSelectedSource

public URL getSelectedSource()

Returns the URL of the image used when the polygon is selected

Specified by:

getSelectedSource in interface IPictureFillSymbol

Returns:

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

draw

public void draw(Graphics2D g,
                 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

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class AbstractFillSymbol

Returns:

a copy of the object

Throws:

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

getBackgroundFileStyle

public IBackgroundFileStyle getBackgroundFileStyle()

Description copied from interface: IPictureFillSymbol

Returns the style associated to the image used in this symbol

Specified by:

getBackgroundFileStyle in interface IPictureFillSymbol

Returns:

getSelectedBackgroundFileStyle

public IBackgroundFileStyle getSelectedBackgroundFileStyle()

Description copied from interface: IPictureFillSymbol

Returns the style associated to the image used in this symbol when the feature is selected

Specified by:

getSelectedBackgroundFileStyle in interface IPictureFillSymbol

Returns: