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

Class MultiLayerLineSymbol

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

All Implemented Interfaces:

java.lang.Cloneable, CartographicSupport, IMultiLayerSymbol, IPrintable, ISymbol, ISymbol_v2, ILineSymbol, IMultiLayerLineSymbol, Persistent

public class MultiLayerLineSymbol
extends AbstractLineSymbol
implements ILineSymbol, IMultiLayerSymbol, IMultiLayerLineSymbol

MultiLayerLineSymbol allows to create new symbols using a composition of several lineal symbols (xxxLineSymbol implementing ILineSymbol)and be treated as an only one symbol.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MULTILAYER_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.CartographicSupport

PAPER, WORLD

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

SELECTION_COLOR

Constructor Summary

Constructors

Constructor and Description
MultiLayerLineSymbol()

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayer(ISymbol newLayer) Stacks a new symbol to the symbol list.
void	addLayer(ISymbol newLayer, int layerIndex) Stacks a new symbol to the symbol list.
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.
int	getAlpha() Obtains the transparency of the line symbol
java.awt.Color	getColor() Returns the color of the line symbol
ISymbol	getLayer(int layerIndex) Obtains the symbol that "contains" a layer whose index is the argument of the method.
int	getLayerCount() Returns the number of layers
ILineStyle	getLineStyle() Obtains the style of the line symbol.
double	getLineWidth() Returns the width of the line symbol
int	getOnePointRgb() Returns the rgb of the symbol when it is drawn like a point.
void	getPixExtentPlus(Geometry geom, float[] distances, ViewPort viewPort, int dpi) Returns the distance between the shape's bounding box and the symbol-that-represents-this-shape's bounding box in a two-length-float array passed as parameter.
ISymbol	getSymbolForSelection() Returns the derived version of the symbol that will be used to draw the feature when it is selected.
boolean	isSuitableFor(Geometry geom) True if this symbol is ok for the geometry.
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)
boolean	removeLayer(ISymbol layer) TODO maybe push it up to ISymbol
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setAlpha(int outlineAlpha) Defines the transparency of a line symbol.
void	setCartographicSize(double cartographicSize, Geometry geom) Sets the size of the cartographic element in pixels.
void	setLayer(int index, ISymbol layer) Establishes a concret symbol for a layer
void	setLineColor(java.awt.Color color) Sets the color for a line symbol
void	setLineStyle(ILineStyle lineStyle) Defines the style of the line symbol to be used.
void	setLineWidth(double width) Sets the width of the line symbol.
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.
void	swapLayers(int index1, int index2) Changes the position of two layers in a multilayersymbol

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

getCartographicSize, getSymbolType, offsetFShape, setColor, 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

Methods inherited from class java.lang.Object

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

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

getCartographicSize, getReferenceSystem, getUnit, toCartographicSize

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

getDescription, getSymbolType, isOneDotOrPixel, isShapeVisible, setColor, setDescription

Field Detail

MULTILAYER_LINE_SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String MULTILAYER_LINE_SYMBOL_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

MultiLayerLineSymbol

public MultiLayerLineSymbol()

Method Detail

getColor

public java.awt.Color getColor()

Description copied from interface: ILineSymbol

Returns the color of the line symbol

Specified by:

getColor in interface ISymbol

Specified by:

getColor in interface ILineSymbol

Overrides:

getColor in class AbstractLineSymbol

Returns:

Color

getLineStyle

public ILineStyle getLineStyle()

Description copied from interface: ILineSymbol

Obtains the style of the line symbol.

Specified by:

getLineStyle in interface ILineSymbol

Overrides:

getLineStyle in class AbstractLineSymbol

Returns:

ILineStyle, the style of the line symbol

getLineWidth

public double getLineWidth()

Description copied from interface: ILineSymbol

Returns the width of the line symbol

Specified by:

getLineWidth in interface ILineSymbol

Returns:

setLineWidth

public void setLineWidth(double width)

Description copied from interface: ILineSymbol

Sets the width of the line symbol.

Specified by:

setLineWidth in interface ILineSymbol

setLineColor

public void setLineColor(java.awt.Color color)

Description copied from interface: ILineSymbol

Sets the color for a line symbol

Specified by:

setLineColor in interface ILineSymbol

Overrides:

setLineColor in class AbstractLineSymbol

setLineStyle

public void setLineStyle(ILineStyle lineStyle)

Description copied from interface: ILineSymbol

Defines the style of the line symbol to be used.

Specified by:

setLineStyle in interface ILineSymbol

Overrides:

setLineStyle in class AbstractLineSymbol

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

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

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.

getPixExtentPlus

public void getPixExtentPlus(Geometry geom,
                    float[] distances,
                    ViewPort viewPort,
                    int dpi)

Description copied from interface: ISymbol

Returns the distance between the shape's bounding box and the symbol-that-represents-this-shape's bounding box in a two-length-float array passed as parameter.

After this method returns, the float array passed will contain two values representing the amount of pixels separating each of the X (first element) and Y (second element) axes.

This distance maybe dependent on:

1. The ViewPort: if the symbol is an instance of CartographicSupport the units it uses are not pixels and the reference system is CarthographicSupport.WORLD.
2. The target rendering context's dpi (dots-per-inch): if the symbol is an instance of CartographicSupport the units it uses are not pixels and CarthographicSupport.PAPER.

And in any other case, if the unit of the symbol is pixels or the symbol is not even an instance of CartographicSupport, the returning values are only defined by the symbol and are not calculated.

Specified by:

getPixExtentPlus in interface ISymbol

Overrides:

getPixExtentPlus in class AbstractLineSymbol

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.

isSuitableFor

public boolean isSuitableFor(Geometry geom)

Description copied from interface: ISymbol

True if this symbol is ok for the geometry. For example, a FillSymbol will be suitable for a Polygon.

Specified by:

isSuitableFor in interface ISymbol

Overrides:

isSuitableFor in class AbstractLineSymbol

Returns:

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

setLayer

public void setLayer(int index,
            ISymbol layer)
              throws java.lang.IndexOutOfBoundsException

Description copied from interface: IMultiLayerSymbol

Establishes a concret symbol for a layer

Specified by:

setLayer in interface IMultiLayerSymbol

Throws:

java.lang.IndexOutOfBoundsException

swapLayers

public void swapLayers(int index1,
              int index2)

Description copied from interface: IMultiLayerSymbol

Changes the position of two layers in a multilayersymbol

Specified by:

swapLayers in interface IMultiLayerSymbol

getLayer

public ISymbol getLayer(int layerIndex)

Description copied from interface: IMultiLayerSymbol

Obtains the symbol that "contains" a layer whose index is the argument of the method.

Specified by:

getLayer in interface IMultiLayerSymbol

Returns:

getLayerCount

public int getLayerCount()

Description copied from interface: IMultiLayerSymbol

Returns the number of layers

Specified by:

getLayerCount in interface IMultiLayerSymbol

Returns:

int

addLayer

public void addLayer(ISymbol newLayer)

Description copied from interface: IMultiLayerSymbol

Stacks a new symbol to the symbol list. The symbol is appended to the list and, in terms of use, it will be the last symbol to be processed.

Specified by:

addLayer in interface IMultiLayerSymbol

addLayer

public void addLayer(ISymbol newLayer,
            int layerIndex)
              throws java.lang.IndexOutOfBoundsException

Description copied from interface: IMultiLayerSymbol

Stacks a new symbol to the symbol list. The symbol is appended to the list in the specified position.

Specified by:

addLayer in interface IMultiLayerSymbol

Throws:

java.lang.IndexOutOfBoundsException

removeLayer

public boolean removeLayer(ISymbol layer)

Description copied from interface: IMultiLayerSymbol

TODO maybe push it up to ISymbol

Specified by:

removeLayer in interface IMultiLayerSymbol

Returns:

true if this symbol contains the removed one

getAlpha

public int getAlpha()

Description copied from interface: ILineSymbol

Obtains the transparency of the line symbol

Specified by:

getAlpha in interface ILineSymbol

Overrides:

getAlpha in class AbstractLineSymbol

Returns:

setAlpha

public void setAlpha(int outlineAlpha)

Description copied from interface: ILineSymbol

Defines the transparency of a line symbol.

Specified by:

setAlpha in interface ILineSymbol

Overrides:

setAlpha in class AbstractLineSymbol

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 AbstractSymbol

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 AbstractLineSymbol

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