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

Class PictureLineSymbol

java.lang.Object

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

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.line.impl.AbstractLineSymbol

org.gvsig.symbology.fmap.mapcontext.rendering.symbol.line.impl.PictureLineSymbol

All Implemented Interfaces:

java.lang.Cloneable, CartographicSupport, IPrintable, ISymbol, ISymbol_v2, ILineSymbol, IPictureLineSymbol, Persistent

public class PictureLineSymbol
extends AbstractLineSymbol
implements IPictureLineSymbol

PictureLineSymbol allows to use any symbol defined as an image (by an image file) supported by gvSIG.This symbol will be used as an initial object.The line will be painted as a succession of puntual symbols through the path defined by it(the line).

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

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

LINE_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.line.ILineSymbol

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
PictureLineSymbol() Constructor method
PictureLineSymbol(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.
java.lang.String	getClassName()
double	getLineWidth() Returns the width of the line symbol
java.net.URL	getSelectedSource() Returns the URL of the image that is used as a picture line symbol (when it is selected in the map)
java.net.URL	getSource() Returns the URL of the image that is used as a picture line symbol
ISymbol	getSymbolForSelection() Returns the derived version of the symbol that will be used to draw the feature when it is selected.
double	getXScale() Returns the xscale for the picture line symbol
double	getYScale() Returns the yscale for the picture line symbol
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	setImage(java.net.URL imageUrl) Sets the URL for the image to be used as a picture line symbol
void	setLineWidth(double width) Sets the width of the line symbol.
void	setSelImage(java.net.URL selImageUrl) Sets the URL for the image to be used as a picture line symbol (when it is selected in the map)
void	setXScale(double xScale) Sets the xscale for the picture line symbol
void	setYScale(double yScale) Sets the yscale for the picture line symbol
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.line.impl.AbstractLineSymbol

drawInsideRectangle, getAlpha, getCartographicSize, getColor, getLineStyle, getOnePointRgb, getPixExtentPlus, getSymbolType, isSuitableFor, offsetFShape, setAlpha, setColor, setLineColor, setLineStyle

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.line.ILineSymbol

getAlpha, getColor, getLineStyle, setAlpha, setLineColor, setLineStyle

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

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

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

getCartographicSize, getReferenceSystem, getUnit, setReferenceSystem, setUnit

Field Detail

PICTURE_LINE_SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String PICTURE_LINE_SYMBOL_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

PictureLineSymbol

public PictureLineSymbol()

Constructor method

PictureLineSymbol

public PictureLineSymbol(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 URL for the image to be used as a picture line symbol

Specified by:

setImage in interface IPictureLineSymbol

Parameters:

imageFile, - File

Throws:

java.io.IOException

setSelImage

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

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

Specified by:

setSelImage in interface IPictureLineSymbol

Parameters:

imageFile, - File

Throws:

java.io.IOException

setLineWidth

public void setLineWidth(double width)

Description copied from interface: ILineSymbol

Sets the width of the line symbol.

Specified by:

setLineWidth in interface ILineSymbol

getLineWidth

public double getLineWidth()

Description copied from interface: ILineSymbol

Returns the width of the line symbol

Specified by:

getLineWidth in interface ILineSymbol

Returns:

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

setYScale

public void setYScale(double yScale)

Sets the yscale for the picture line symbol

Specified by:

setYScale in interface IPictureLineSymbol

Parameters:

yScale -

setXScale

public void setXScale(double xScale)

Sets the xscale for the picture line symbol

Specified by:

setXScale in interface IPictureLineSymbol

Parameters:

xScale -

getClassName

public java.lang.String getClassName()

print

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

Specified by:

print in interface IPrintable

Overrides:

print in class AbstractLineSymbol

getSelectedSource

public java.net.URL getSelectedSource()

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

Specified by:

getSelectedSource in interface IPictureLineSymbol

Returns:

selimagePath,URL

getSource

public java.net.URL getSource()

Returns the URL of the image that is used as a picture line symbol

Specified by:

getSource in interface IPictureLineSymbol

Returns:

imagePath,URL

getXScale

public double getXScale()

Returns the xscale for the picture line symbol

Specified by:

getXScale in interface IPictureLineSymbol

Parameters:

xScale -

getYScale

public double getYScale()

Returns the yscale for the picture line symbol

Specified by:

getYScale in interface IPictureLineSymbol

Parameters:

yScale -

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 AbstractLineSymbol

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 AbstractLineSymbol

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 AbstractLineSymbol

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 AbstractLineSymbol

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 AbstractLineSymbol

Throws:

PersistenceException