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

Class SimpleLineSymbol

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

All Implemented Interfaces:

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

public class SimpleLineSymbol
extends AbstractLineSymbol
implements ISimpleLineSymbol

SimpleLineSymbol is the most basic symbol for the representation of line objects. Allows to define the width of the line, the color and the drawn pattern.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SIMPLE_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
SimpleLineSymbol()

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 feature, 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.
double	getLineWidth() Returns the width of the line symbol
int	getOnePointRgb() Returns the rgb of the symbol when it is drawn like a point.
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	setLineWidth(double width) Sets the width of the line symbol.

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

getAlpha, getCartographicSize, getColor, getLineStyle, getPixExtentPlus, getSymbolType, isSuitableFor, offsetFShape, print, setAlpha, setCartographicSize, setColor, setLineColor, setLineStyle, 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.line.ILineSymbol

getAlpha, getColor, getLineStyle, setAlpha, setLineColor, setLineStyle

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

getDescription, getPixExtentPlus, getSymbolType, isOneDotOrPixel, isShapeVisible, isSuitableFor, setColor, 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

SIMPLE_LINE_SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String SIMPLE_LINE_SYMBOL_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

SimpleLineSymbol

public SimpleLineSymbol()

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

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

Overrides:

getOnePointRgb in class AbstractLineSymbol

Returns:

rgb of the symbol.

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 AbstractLineSymbol

properties - TODO

Throws:

SymbolDrawingException - TODO

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:

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