svn-gvsig-desktop / trunk / org.gvsig.desktop / org.gvsig.desktop.compat.cdc / org.gvsig.fmap.mapcontext / org.gvsig.fmap.mapcontext.api / src / main / java / org / gvsig / fmap / mapcontext / rendering / symbols / IMultiLayerSymbol.java @ 40559
History | View | Annotate | Download (3.3 KB)
1 | 40559 | jjdelcerro | /**
|
---|---|---|---|
2 | * gvSIG. Desktop Geographic Information System.
|
||
3 | 40435 | jjdelcerro | *
|
4 | 40559 | jjdelcerro | * Copyright (C) 2007-2013 gvSIG Association.
|
5 | 40435 | jjdelcerro | *
|
6 | * This program is free software; you can redistribute it and/or
|
||
7 | * modify it under the terms of the GNU General Public License
|
||
8 | 40559 | jjdelcerro | * as published by the Free Software Foundation; either version 3
|
9 | 40435 | jjdelcerro | * of the License, or (at your option) any later version.
|
10 | *
|
||
11 | * This program is distributed in the hope that it will be useful,
|
||
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
14 | * GNU General Public License for more details.
|
||
15 | *
|
||
16 | * You should have received a copy of the GNU General Public License
|
||
17 | * along with this program; if not, write to the Free Software
|
||
18 | 40559 | jjdelcerro | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
19 | * MA 02110-1301, USA.
|
||
20 | 40435 | jjdelcerro | *
|
21 | 40559 | jjdelcerro | * For any additional information, do not hesitate to contact us
|
22 | * at info AT gvsig.com, or visit our website www.gvsig.com.
|
||
23 | 40435 | jjdelcerro | */
|
24 | /* CVS MESSAGES:
|
||
25 | *
|
||
26 | * $Id: IMultiLayerSymbol.java 20989 2008-05-28 11:05:57Z jmvivo $
|
||
27 | * $Log$
|
||
28 | * Revision 1.5 2007-08-16 06:55:19 jvidal
|
||
29 | * javadoc updated
|
||
30 | *
|
||
31 | * Revision 1.4 2007/08/09 08:04:36 jvidal
|
||
32 | * javadoc
|
||
33 | *
|
||
34 | * Revision 1.3 2007/08/09 07:57:42 jvidal
|
||
35 | * javadoc
|
||
36 | *
|
||
37 | * Revision 1.2 2007/03/09 11:20:56 jaume
|
||
38 | * Advanced symbology (start committing)
|
||
39 | *
|
||
40 | * Revision 1.1.2.1 2007/02/16 10:54:12 jaume
|
||
41 | * multilayer splitted to multilayerline, multilayermarker,and multilayerfill
|
||
42 | *
|
||
43 | *
|
||
44 | */
|
||
45 | package org.gvsig.fmap.mapcontext.rendering.symbols; |
||
46 | |||
47 | |||
48 | /**
|
||
49 | * Allows to create multi layer symbols using the composition of
|
||
50 | * several symbols of the same type.Depending on the type of the symbols that are
|
||
51 | * used to compose the final symbol, the user will have MultiLayerMarkerSymbol,
|
||
52 | * MultiLayerLineSymbol,...
|
||
53 | *
|
||
54 | */
|
||
55 | |||
56 | public interface IMultiLayerSymbol extends ISymbol { |
||
57 | |||
58 | /**
|
||
59 | * Establishes a concret symbol for a layer
|
||
60 | *
|
||
61 | * @param index, index of the layer
|
||
62 | * @param layer, symbol to be "applied" to the layer
|
||
63 | * @throws IndexOutOfBoundsException
|
||
64 | */
|
||
65 | public abstract void setLayer(int index, ISymbol layer) |
||
66 | throws IndexOutOfBoundsException; |
||
67 | /**
|
||
68 | * Changes the position of two layers in a multilayersymbol
|
||
69 | * @param index1, index of the layer
|
||
70 | * @param index2, index of the layer
|
||
71 | */
|
||
72 | public abstract void swapLayers(int index1, int index2); |
||
73 | /**
|
||
74 | * Obtains the symbol that "contains" a layer whose index is the argument of the method.
|
||
75 | * @param layerIndex
|
||
76 | * @return
|
||
77 | */
|
||
78 | public abstract ISymbol getLayer(int layerIndex); |
||
79 | /**
|
||
80 | * Returns the number of layers
|
||
81 | * @return int
|
||
82 | */
|
||
83 | public abstract int getLayerCount(); |
||
84 | |||
85 | /**
|
||
86 | * Stacks a new symbol to the symbol list. The symbol is appended to the
|
||
87 | * list and, in terms of use, it will be the last symbol to be processed.
|
||
88 | * @param ISymbol newLayer
|
||
89 | */
|
||
90 | public abstract void addLayer(ISymbol newLayer); |
||
91 | /**
|
||
92 | * Stacks a new symbol to the symbol list. The symbol is appended to the
|
||
93 | * list in the specified position.
|
||
94 | * @param ISymbol newLayer
|
||
95 | */
|
||
96 | public abstract void addLayer(ISymbol newLayer, int layerIndex) |
||
97 | throws IndexOutOfBoundsException; |
||
98 | |||
99 | /**
|
||
100 | * TODO maybe push it up to ISymbol
|
||
101 | * @param layer
|
||
102 | * @return true if this symbol contains the removed one
|
||
103 | */
|
||
104 | public abstract boolean removeLayer(ISymbol layer); |
||
105 | |||
106 | } |