Package org.gvsig.fmap.mapcontext.rendering.symbols

Interface IMultiLayerSymbol

All Superinterfaces:

Cloneable, org.gvsig.tools.lang.Cloneable, IPrintable, ISymbol, org.gvsig.tools.persistence.Persistent

public interface IMultiLayerSymbol
extends ISymbol

Allows to create multi layer symbols using the composition of several symbols of the same type.Depending on the type of the symbols that are used to compose the final symbol, the user will have MultiLayerMarkerSymbol, MultiLayerLineSymbol,...

Field Summary

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

SELECTION_COLOR

Method Summary

Modifier and Type	Method	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.
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
boolean	removeLayer(ISymbol layer)	TODO maybe push it up to ISymbol
void	setLayer(int index, ISymbol layer)	Establishes a concret symbol for a layer
void	swapLayers(int index1, int index2)	Changes the position of two layers in a multilayersymbol

Methods inherited from interface org.gvsig.tools.lang.Cloneable

clone

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

print

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

draw, draw, drawInsideRectangle, getColor, getDescription, getFeature, getID, getSymbolForSelection, getSymbolForSelection, getSymbolType, isShapeVisible, isSuitableFor, setColor, setDescription, setFeature, setID

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

Method Details

setLayer

void setLayer(int index,
 ISymbol layer)
       throws IndexOutOfBoundsException

Establishes a concret symbol for a layer

Parameters:

index - , index of the layer

layer - , symbol to be "applied" to the layer

Throws:

IndexOutOfBoundsException

swapLayers

void swapLayers(int index1,
 int index2)

Changes the position of two layers in a multilayersymbol

Parameters:

index1 - , index of the layer

index2 - , index of the layer

getLayer

ISymbol getLayer(int layerIndex)

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

Parameters:

layerIndex -

Returns:

getLayerCount

int getLayerCount()

Returns the number of layers

Returns:

int

addLayer

void addLayer(ISymbol newLayer)

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.

Parameters:

ISymbol - newLayer

addLayer

void addLayer(ISymbol newLayer,
 int layerIndex)
       throws IndexOutOfBoundsException

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

Parameters:

ISymbol - newLayer

Throws:

IndexOutOfBoundsException

removeLayer

boolean removeLayer(ISymbol layer)

TODO maybe push it up to ISymbol

Parameters:

layer -

Returns:

true if this symbol contains the removed one