root / trunk / applications / appgvSIG / src / com / iver / cit / gvsig / gui / styling / AbstractTypeSymbolEditorPanel.java @ 12908
History | View | Annotate | Download (6.6 KB)
1 | 9745 | jaume | /* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana
|
---|---|---|---|
2 | *
|
||
3 | * Copyright (C) 2005 IVER T.I. and Generalitat Valenciana.
|
||
4 | *
|
||
5 | * This program is free software; you can redistribute it and/or
|
||
6 | * modify it under the terms of the GNU General Public License
|
||
7 | * as published by the Free Software Foundation; either version 2
|
||
8 | * of the License, or (at your option) any later version.
|
||
9 | *
|
||
10 | * This program is distributed in the hope that it will be useful,
|
||
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
13 | * GNU General Public License for more details.
|
||
14 | *
|
||
15 | * You should have received a copy of the GNU General Public License
|
||
16 | * along with this program; if not, write to the Free Software
|
||
17 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,USA.
|
||
18 | *
|
||
19 | * For more information, contact:
|
||
20 | *
|
||
21 | * Generalitat Valenciana
|
||
22 | * Conselleria d'Infraestructures i Transport
|
||
23 | * Av. Blasco Ib??ez, 50
|
||
24 | * 46010 VALENCIA
|
||
25 | * SPAIN
|
||
26 | *
|
||
27 | * +34 963862235
|
||
28 | * gvsig@gva.es
|
||
29 | * www.gvsig.gva.es
|
||
30 | *
|
||
31 | * or
|
||
32 | *
|
||
33 | * IVER T.I. S.A
|
||
34 | * Salamanca 50
|
||
35 | * 46005 Valencia
|
||
36 | * Spain
|
||
37 | *
|
||
38 | * +34 963163400
|
||
39 | * dac@iver.es
|
||
40 | */
|
||
41 | |||
42 | /* CVS MESSAGES:
|
||
43 | *
|
||
44 | * $Id$
|
||
45 | * $Log$
|
||
46 | 12908 | jaume | * Revision 1.11 2007-08-03 09:07:01 jaume
|
47 | 12906 | jaume | * javadoc
|
48 | *
|
||
49 | 12908 | jaume | * Revision 1.10 2007/08/03 07:34:15 jaume
|
50 | * javadoc
|
||
51 | *
|
||
52 | 12906 | jaume | * Revision 1.9 2007/07/30 12:56:04 jaume
|
53 | 12826 | jaume | * organize imports, java 5 code downgraded to 1.4 and added PictureFillSymbol
|
54 | *
|
||
55 | * Revision 1.8 2007/07/18 06:56:03 jaume
|
||
56 | 12657 | jaume | * continuing with cartographic support
|
57 | *
|
||
58 | * Revision 1.7 2007/07/12 10:43:55 jaume
|
||
59 | 12561 | jaume | * *** empty log message ***
|
60 | *
|
||
61 | * Revision 1.6 2007/06/29 13:07:33 jaume
|
||
62 | 12427 | jaume | * +PictureLineSymbol
|
63 | *
|
||
64 | * Revision 1.5 2007/05/08 15:44:07 jaume
|
||
65 | 11297 | jaume | * *** empty log message ***
|
66 | *
|
||
67 | 11503 | jaume | * Revision 1.4 2007/04/20 07:54:38 jaume
|
68 | * *** empty log message ***
|
||
69 | *
|
||
70 | 11297 | jaume | * Revision 1.3 2007/04/05 16:08:34 jaume
|
71 | 11073 | jaume | * Styled labeling stuff
|
72 | *
|
||
73 | * Revision 1.2 2007/03/09 11:25:00 jaume
|
||
74 | 10679 | jaume | * Advanced symbology (start committing)
|
75 | *
|
||
76 | * Revision 1.1.2.3 2007/02/21 07:35:14 jaume
|
||
77 | 9745 | jaume | * *** empty log message ***
|
78 | *
|
||
79 | 10679 | jaume | * Revision 1.1.2.2 2007/02/08 15:42:13 jaume
|
80 | * *** empty log message ***
|
||
81 | *
|
||
82 | * Revision 1.1.2.1 2007/01/26 13:49:03 jaume
|
||
83 | * *** empty log message ***
|
||
84 | *
|
||
85 | * Revision 1.1 2007/01/16 11:52:11 jaume
|
||
86 | * *** empty log message ***
|
||
87 | *
|
||
88 | 9745 | jaume | * Revision 1.6 2006/11/13 09:15:23 jaume
|
89 | * javadoc and some clean-up
|
||
90 | *
|
||
91 | * Revision 1.5 2006/11/06 16:06:52 jaume
|
||
92 | * *** empty log message ***
|
||
93 | *
|
||
94 | * Revision 1.4 2006/10/31 16:16:34 jaume
|
||
95 | * *** empty log message ***
|
||
96 | *
|
||
97 | * Revision 1.3 2006/10/30 19:30:35 jaume
|
||
98 | * *** empty log message ***
|
||
99 | *
|
||
100 | * Revision 1.2 2006/10/29 23:53:49 jaume
|
||
101 | * *** empty log message ***
|
||
102 | *
|
||
103 | * Revision 1.1 2006/10/27 12:41:09 jaume
|
||
104 | * GUI
|
||
105 | *
|
||
106 | *
|
||
107 | */
|
||
108 | package com.iver.cit.gvsig.gui.styling; |
||
109 | |||
110 | import javax.swing.JPanel; |
||
111 | |||
112 | 12657 | jaume | import com.iver.cit.gvsig.fmap.core.CartographicSupport; |
113 | 10679 | jaume | import com.iver.cit.gvsig.fmap.core.symbols.ISymbol; |
114 | 9745 | jaume | /**
|
115 | 12906 | jaume | * <p>
|
116 | 9745 | jaume | * Abstract class that all the Symbol settings interface must extend.
|
117 | 12906 | jaume | * </p>
|
118 | * <p>
|
||
119 | * The components contained by this panel are automatically placed in
|
||
120 | 12908 | jaume | * the <b>SymbolEditor</b>'s symbol options area. In case other panel of this
|
121 | 12906 | jaume | * was already placed, then the old one is replaced by this.
|
122 | * </p>
|
||
123 | * <p>
|
||
124 | 12908 | jaume | * In order to the <b>SymbolEditor</b> owner to decide which
|
125 | * <b>AbstractTypeSymbolEditorPanel</b> will be placed each symbol editor
|
||
126 | * panel must define the type of the symbol it is able to configure.
|
||
127 | * To do this, <b>AbstractTypeSymbolEditorPanel</b> includes the abstract
|
||
128 | * method <b>getSymbolClass()</b> which will return the <b>Class</b> of
|
||
129 | * the corresponding symbol. The symbol class must define an implementation
|
||
130 | * of ISymbol in general, and one of IMarkerSymbol, ILineSymbol or
|
||
131 | * IFillSymbol in particular, depending of the context of the symbology
|
||
132 | * being edited.
|
||
133 | 12906 | jaume | * </p>
|
134 | 9745 | jaume | * @author jaume dominguez faus - jaume.dominguez@iver.es
|
135 | */
|
||
136 | public abstract class AbstractTypeSymbolEditorPanel { |
||
137 | protected SymbolEditor owner;
|
||
138 | 12427 | jaume | private boolean applying = false; |
139 | 9745 | jaume | |
140 | /**
|
||
141 | 10679 | jaume | * Produces and returns the ISymbol according with the user settings.
|
142 | *
|
||
143 | 9745 | jaume | * @return XMLEntity defining the ISymbol.
|
144 | * @see getSymbolClass() method
|
||
145 | */
|
||
146 | 10679 | jaume | public abstract ISymbol getLayer(); |
147 | 9745 | jaume | |
148 | /**
|
||
149 | * Creates a new instance of this type symbol editor panel associated to
|
||
150 | 12906 | jaume | * its SymbolEditor parent which will be notified of the changes in
|
151 | 9745 | jaume | * order to keep the symbol preview in sync with the user settings.
|
152 | * @param owner, the SymbolEditor which created this.
|
||
153 | */
|
||
154 | public AbstractTypeSymbolEditorPanel(SymbolEditor owner) {
|
||
155 | this.owner = owner;
|
||
156 | } |
||
157 | |||
158 | /**
|
||
159 | 12906 | jaume | * <p>
|
160 | * Returns the name of the config tabs that will be shown in the selector combo box.
|
||
161 | 9745 | jaume | * This is typically a human-readable (and also translatable) name for the symbol that
|
162 | * this TypeEditorPanel deals with, but maybe you prefer to use any other one.<br>
|
||
163 | * </p>
|
||
164 | * <p>
|
||
165 | * The order of the entries in the combo is alphabetically-based. So you can force a
|
||
166 | * position by defining a name that suits your needs.
|
||
167 | * </p>
|
||
168 | * @return A human-readable text naming this panel
|
||
169 | */
|
||
170 | public abstract String getName(); |
||
171 | |||
172 | /**
|
||
173 | 12906 | jaume | * <p>
|
174 | * Due to the complexity that many symbols settings can reach, the SymbolEditorPanel is
|
||
175 | 9745 | jaume | * designed in a tabbed-based fashion. So, you can use as many of pages you want to put
|
176 | * your components. This pages are regular JPanels that will be automatically added to
|
||
177 | * the SymbolEditor dialog.<br>
|
||
178 | * </p>
|
||
179 | * <p>
|
||
180 | * In case you need only one page, just return a JPanel array with a length of 1.
|
||
181 | * </p>
|
||
182 | * @return An array of JPanel containing the setting's interface.
|
||
183 | */
|
||
184 | public abstract JPanel[] getTabs(); |
||
185 | |||
186 | /**
|
||
187 | * Invoked when the user selects or adds a new layer. This method fills up
|
||
188 | * the components on the right according on the layer properties
|
||
189 | 10679 | jaume | * @param <b>ISymbol</b> layer, the symbol
|
190 | 9745 | jaume | */
|
191 | 10679 | jaume | public abstract void refreshControls(ISymbol layer); |
192 | 9745 | jaume | |
193 | 12908 | jaume | /**
|
194 | * This overrided method returns the text shown at the SymbolEditorPanel
|
||
195 | * select combobox.
|
||
196 | */
|
||
197 | 9745 | jaume | public final String toString() { |
198 | return getName();
|
||
199 | } |
||
200 | |||
201 | protected final void fireSymbolChangedEvent() { |
||
202 | 12427 | jaume | if (!applying) { // avoid unnecessary events |
203 | applying = true;
|
||
204 | 12657 | jaume | ISymbol sym = getLayer(); |
205 | |||
206 | if (sym instanceof CartographicSupport) { |
||
207 | CartographicSupport cs = (CartographicSupport) sym; |
||
208 | cs.setReferenceSystem(owner.getUnitsReferenceSystem()); |
||
209 | cs.setUnit(owner.getUnit()); |
||
210 | |||
211 | } |
||
212 | 12427 | jaume | owner.setLayerToSymbol(getLayer()); |
213 | owner.refresh(); |
||
214 | applying = false;
|
||
215 | } |
||
216 | 9745 | jaume | } |
217 | |||
218 | /**
|
||
219 | * Returns the symbol class that is handled by this configuration panel.
|
||
220 | * @return <b>Class</b> (of the concrete ISymbol that this configuration panel deals with)
|
||
221 | */
|
||
222 | public abstract Class getSymbolClass(); |
||
223 | 11073 | jaume | |
224 | public abstract EditorTool getEditorTool(); |
||
225 | |||
226 | |||
227 | 9745 | jaume | } |