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

Class MultiLayerFillSymbol

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

All Implemented Interfaces:

Cloneable, CartographicSupport, IMultiLayerSymbol, IPrintable, ISymbol, ISymbol_v2, IFillSymbol, IMultiLayerFillSymbol, Persistent

public class MultiLayerFillSymbol
extends AbstractFillSymbol
implements IFillSymbol, IMultiLayerSymbol, IMultiLayerFillSymbol

MultiLayerFillSymbol is a symbol which allows to group several kind of fill symbols (xxxFillSymbol implementing IFillSymbol)in one and treats it like single symbol.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

PAPER, WORLD

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

SELECTION_COLOR

Constructor Summary

Constructors

Constructor and Description
MultiLayerFillSymbol()

Method Summary

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.
Object	clone() Creates a copy of the object.
void	draw(Graphics2D g, 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(Graphics2D g, AffineTransform scaleInstance, Rectangle r, PrintAttributes properties) Useful to render the symbol inside the TOC, or inside little rectangles.
int	getFillAlpha() Returns the transparency of the multi layer fill symbol created
Color	getFillColor()
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
int	getOnePointRgb() Returns the rgb of the symbol when it is drawn like a point.
ILineSymbol	getOutline() Obtains the ILineSymbol interface of the outline
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.
int	getSymbolType() The use of this method -and its mechanism- is being valorated.
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(Graphics2D g, 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	setFillColor(Color color) Sets the color that will be used to draw the filling pattern of this symbol.
void	setLayer(int index, ISymbol layer) Establishes a concret symbol for a layer
void	setOutline(ILineSymbol outline) Sets the color of the outline.
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
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, hasFill, hasOutline, setCartographicSize, setColor, setHasFill, setHasOutline

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

hasFill, hasOutline, setHasFill, setHasOutline

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

getCartographicSize, getReferenceSystem, getUnit, setCartographicSize

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

getColor, getDescription, isOneDotOrPixel, isShapeVisible, setColor, setDescription

Field Detail

MULTILAYER_FILL_SYMBOL_PERSISTENCE_DEFINITION_NAME

public static final String MULTILAYER_FILL_SYMBOL_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

MultiLayerFillSymbol

public MultiLayerFillSymbol()

Method Detail

getFillColor

public Color getFillColor()

Specified by:

getFillColor in interface IFillSymbol

Overrides:

getFillColor in class AbstractFillSymbol

Returns:

Returns the color.

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

Specified by:

getOnePointRgb in interface IFillSymbol

Overrides:

getOnePointRgb in class AbstractFillSymbol

Returns:

rgb of the symbol.

getOutline

public ILineSymbol getOutline()

Description copied from interface: IFillSymbol

Obtains the ILineSymbol interface of the outline

Specified by:

getOutline in interface IFillSymbol

Overrides:

getOutline in class AbstractFillSymbol

Returns:

the outline,ILineSymbol.

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

Specified by:

isSuitableFor in interface IFillSymbol

Overrides:

isSuitableFor in class AbstractFillSymbol

Returns:

setFillColor

public void setFillColor(Color color)

Description copied from interface: IFillSymbol

Sets the color that will be used to draw the filling pattern of this symbol.

Specified by:

setFillColor in interface IFillSymbol

Overrides:

setFillColor in class AbstractFillSymbol

setOutline

public void setOutline(ILineSymbol outline)

Description copied from interface: IFillSymbol

Sets the color of the outline.

Specified by:

setOutline in interface IFillSymbol

Overrides:

setOutline in class AbstractFillSymbol

draw

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

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 AbstractFillSymbol

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

print

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

Specified by:

print in interface IPrintable

setLayer

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

Description copied from interface: IMultiLayerSymbol

Establishes a concret symbol for a layer

Specified by:

setLayer in interface IMultiLayerSymbol

Throws:

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 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:

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

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 AbstractFillSymbol

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

getFillAlpha

public int getFillAlpha()

Returns the transparency of the multi layer fill symbol created

Specified by:

getFillAlpha in interface IFillSymbol

Overrides:

getFillAlpha in class AbstractFillSymbol

Returns:

the transparency of the fill symbol

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

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