svn-gvsig-desktop / tags / Root_v061 / applications / appgvSIG / src / com / iver / cit / gvsig / gui / layout / fframes / IFFrame.java @ 4812
History | View | Annotate | Download (9.02 KB)
1 |
/*
|
---|---|
2 |
* Created on 20-feb-2004
|
3 |
*
|
4 |
*/
|
5 |
/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana
|
6 |
*
|
7 |
* Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.
|
8 |
*
|
9 |
* This program is free software; you can redistribute it and/or
|
10 |
* modify it under the terms of the GNU General Public License
|
11 |
* as published by the Free Software Foundation; either version 2
|
12 |
* of the License, or (at your option) any later version.
|
13 |
*
|
14 |
* This program is distributed in the hope that it will be useful,
|
15 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
16 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
17 |
* GNU General Public License for more details.
|
18 |
*
|
19 |
* You should have received a copy of the GNU General Public License
|
20 |
* along with this program; if not, write to the Free Software
|
21 |
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,USA.
|
22 |
*
|
23 |
* For more information, contact:
|
24 |
*
|
25 |
* Generalitat Valenciana
|
26 |
* Conselleria d'Infraestructures i Transport
|
27 |
* Av. Blasco Ib??ez, 50
|
28 |
* 46010 VALENCIA
|
29 |
* SPAIN
|
30 |
*
|
31 |
* +34 963862235
|
32 |
* gvsig@gva.es
|
33 |
* www.gvsig.gva.es
|
34 |
*
|
35 |
* or
|
36 |
*
|
37 |
* IVER T.I. S.A
|
38 |
* Salamanca 50
|
39 |
* 46005 Valencia
|
40 |
* Spain
|
41 |
*
|
42 |
* +34 963163400
|
43 |
* dac@iver.es
|
44 |
*/
|
45 |
package com.iver.cit.gvsig.gui.layout.fframes; |
46 |
|
47 |
import com.iver.cit.gvsig.fmap.DriverException; |
48 |
import com.iver.cit.gvsig.fmap.layers.XMLException; |
49 |
import com.iver.cit.gvsig.gui.layout.Layout; |
50 |
import com.iver.cit.gvsig.gui.project.SaveException; |
51 |
|
52 |
import com.iver.utiles.XMLEntity; |
53 |
|
54 |
import java.awt.Cursor; |
55 |
import java.awt.Graphics2D; |
56 |
import java.awt.geom.AffineTransform; |
57 |
import java.awt.geom.Point2D; |
58 |
import java.awt.geom.Rectangle2D; |
59 |
import java.awt.image.BufferedImage; |
60 |
|
61 |
|
62 |
/**
|
63 |
* Interface que implementa FFrame.
|
64 |
*
|
65 |
* @author Vicente Caballero Navarro
|
66 |
*/
|
67 |
public interface IFFrame { |
68 |
/** FFrame no selecccionado. */
|
69 |
public static final int NOSELECT = 0; |
70 |
|
71 |
/**
|
72 |
* Devuelve el boundingBox del fframe en funci?n de la transformada af?n
|
73 |
* que se pasa como par?metro. Si se pasa como par?metro null, devuelve el
|
74 |
* ?ltimo boundingbox que se calcul?.
|
75 |
*
|
76 |
* @param at Transformada af?n
|
77 |
*
|
78 |
* @return Rect?ngulo que representa el BoundingBox del fframe.
|
79 |
*/
|
80 |
public Rectangle2D.Double getBoundingBox(AffineTransform at); |
81 |
|
82 |
/**
|
83 |
* Devuelve el rect?ngulo que representa el fframe en cent?metros.
|
84 |
*
|
85 |
* @return Rect?ngulo en centimetros.
|
86 |
*/
|
87 |
public Rectangle2D.Double getBoundBox(); |
88 |
|
89 |
/**
|
90 |
* Rellena con el rect?ngulo que se pasa como par?metro el boundBox(en
|
91 |
* cent?metros) del fframe del cual con una transformaci?n se podr?
|
92 |
* calcular el BoundingBox (en pixels).
|
93 |
*
|
94 |
* @param rect Rect?ngulo en cent?metros.
|
95 |
*/
|
96 |
public void setBoundBox(Rectangle2D rect); |
97 |
|
98 |
/**
|
99 |
* Este m?todo se implementa en cada una de las fframe, ya que cada una se
|
100 |
* dibuja de una forma diferente sobre el graphics. M?todo que dibuja
|
101 |
* sobre el graphics que se le pasa como par?metro, seg?n la transformada
|
102 |
* afin que se debe de aplicar y el rect?ngulo que se debe de dibujar.
|
103 |
*
|
104 |
* @param g Graphics
|
105 |
* @param at Transformada afin.
|
106 |
* @param r rect?ngulo sobre el que hacer un clip.
|
107 |
* @param imgBase Imagen para acelerar el dibujado.
|
108 |
*
|
109 |
* @throws DriverException
|
110 |
*/
|
111 |
public void draw(Graphics2D g, AffineTransform at, Rectangle2D r, |
112 |
BufferedImage imgBase) throws DriverException; |
113 |
|
114 |
/**
|
115 |
* Implementado para imprimir.
|
116 |
*
|
117 |
* @param g Graphics2D de la impresora sobre el que dibujar.
|
118 |
* @param at DOCUMENT ME!
|
119 |
*
|
120 |
* @throws DriverException
|
121 |
*/
|
122 |
public void print(Graphics2D g, AffineTransform at) |
123 |
throws DriverException;
|
124 |
|
125 |
/**
|
126 |
* Devuelve el nombre que representa al fframe.
|
127 |
*
|
128 |
* @return String nombre del FFrame.
|
129 |
*/
|
130 |
public String getName(); |
131 |
|
132 |
/**
|
133 |
* Rellena el String que representa al nombre del fframe.
|
134 |
*
|
135 |
* @param n nombre del fframe.
|
136 |
*/
|
137 |
public void setName(String n); |
138 |
|
139 |
/**
|
140 |
* Devuelve true, si el punto que se pasa como par?metro esta contenido
|
141 |
* dentro del boundingbox del fframe.
|
142 |
*
|
143 |
* @param p punto a comprobar.
|
144 |
*
|
145 |
* @return true si el punto esta dentro del boundingbox.
|
146 |
*/
|
147 |
public boolean contains(Point2D.Double p); |
148 |
|
149 |
/**
|
150 |
* Dibuja los handlers sobre el boundingBox en el graphics que se pasa como
|
151 |
* par?metro.
|
152 |
*
|
153 |
* @param g Graphics sobre el que dibujar.
|
154 |
*/
|
155 |
public void drawHandlers(Graphics2D g); |
156 |
|
157 |
/**
|
158 |
* Pasando como par?metro true, se toma como que est? seleccionado el
|
159 |
* fframe y si es false como que esta sin seleccionar, de esta forma se
|
160 |
* selecciona un fframe directamente sin comprobar si un punto est?
|
161 |
* contenido en ?l.
|
162 |
*
|
163 |
* @param b true si se quiere seleccionar y false si se quiere
|
164 |
* deseleccionar.
|
165 |
*/
|
166 |
public void setSelected(Point2D.Double b); |
167 |
|
168 |
/**
|
169 |
* Establece que tipo de selecci?n se realiza sobre el fframe.
|
170 |
*
|
171 |
* @param b punto sobre el que se debe de establecer si se selecciona o no
|
172 |
* el fframe.
|
173 |
*/
|
174 |
public void setSelected(boolean b); |
175 |
|
176 |
/**
|
177 |
* Devuelve un entero que representa el tipo de selecci?n que se ha
|
178 |
* realizado sobre el fframe.
|
179 |
*
|
180 |
* @return tipo de selecci?n que se ha realizado.
|
181 |
*/
|
182 |
public int getSelected(); |
183 |
|
184 |
/**
|
185 |
* Devuelve un entero que representa donde esta contenido el punto que se
|
186 |
* pasa como par?metro.
|
187 |
*
|
188 |
* @param p punto a comparar.
|
189 |
*
|
190 |
* @return entero que representa como esta contenido el punto.
|
191 |
*/
|
192 |
public int getContains(Point2D.Double p); |
193 |
|
194 |
/**
|
195 |
* Devuelve el Cursor adecuado seg?n como est? contenido el punto, si es
|
196 |
* para desplazamiento, o cambio de tama?o.
|
197 |
*
|
198 |
* @param p punto a comprobar.
|
199 |
*
|
200 |
* @return Cursor adecuado a la posici?n.
|
201 |
*/
|
202 |
public Cursor getMapCursor(Point2D.Double p); |
203 |
|
204 |
/**
|
205 |
* Devuelve el rect?ngulo a partir del desplazamiento en el eje x y el
|
206 |
* desplazamiento en el eje y.
|
207 |
*
|
208 |
* @param difx desplazamiento sobre el eje x.
|
209 |
* @param dify desplazamiento sobre el eje y.
|
210 |
*
|
211 |
* @return rect?ngulo modificado en funci?n del desplazamiento realizado.
|
212 |
*/
|
213 |
public Rectangle2D getMovieRect(int difx, int dify); |
214 |
|
215 |
/**
|
216 |
* Devuelve un Objeto XMLEntity con la informaci?n los atributos necesarios
|
217 |
* para poder despu?s volver a crear el objeto original.
|
218 |
*
|
219 |
* @return XMLEntity.
|
220 |
*
|
221 |
* @throws XMLException
|
222 |
*/
|
223 |
public XMLEntity getXMLEntity() throws SaveException; |
224 |
|
225 |
/**
|
226 |
* Dibuja un rect?ngulo de color gris, con el nombre en el centro y
|
227 |
* escalado en forma de borrador.
|
228 |
*
|
229 |
* @param g Graphics sobre el que se dibuja.
|
230 |
*/
|
231 |
public void drawDraft(Graphics2D g); |
232 |
|
233 |
/**
|
234 |
* Actualiza el BoundBox del FFrame a partir de su rect?ngulo en pixels y
|
235 |
* la matriz de transformaci?n.
|
236 |
*
|
237 |
* @param r Rect?ngulo.
|
238 |
* @param at Matriz de transformaci?n.
|
239 |
*/
|
240 |
public void updateRect(Rectangle2D r, AffineTransform at); |
241 |
|
242 |
/**
|
243 |
* Devuelve true si el rect?ngulo primero es null o si es distinto de null
|
244 |
* e intersecta.
|
245 |
*
|
246 |
* @param rv Rect?ngulo
|
247 |
* @param r Rect?ngulo
|
248 |
*
|
249 |
* @return True si intersecta o es null.
|
250 |
*/
|
251 |
public boolean intersects(Rectangle2D rv, Rectangle2D r); |
252 |
|
253 |
/**
|
254 |
* Introduce el n?mero de FFrame en el que de que se trata.
|
255 |
*
|
256 |
* @param i n?mero de FFrame
|
257 |
*/
|
258 |
public void setNum(int i); |
259 |
|
260 |
/**
|
261 |
* A partir del xml y de Project inicia el objeto.
|
262 |
*
|
263 |
* @param xml XMLEntity
|
264 |
*/
|
265 |
public void setXMLEntity(XMLEntity xml); |
266 |
|
267 |
/**
|
268 |
* A partir del xml y de Project inicia el objeto.
|
269 |
*
|
270 |
* @param xml XMLEntity
|
271 |
* @param l Project
|
272 |
*/
|
273 |
public void setXMLEntity03(XMLEntity xml, Layout l); |
274 |
|
275 |
/**
|
276 |
* Devuelve el nombre que representa al tipo de FFrame.
|
277 |
*
|
278 |
* @return nombre del elemento.
|
279 |
*/
|
280 |
public String getNameFFrame(); |
281 |
|
282 |
/**
|
283 |
* Abre la ventana para modificar el tag.
|
284 |
*/
|
285 |
public void openTag(); |
286 |
|
287 |
/**
|
288 |
* Rellena el tag.
|
289 |
*
|
290 |
* @param s valor del tag.
|
291 |
*/
|
292 |
public void setTag(String s); |
293 |
|
294 |
/**
|
295 |
* Devuelve el valor del tag.
|
296 |
*
|
297 |
* @return String del valor del tag.
|
298 |
*/
|
299 |
public String getTag(); |
300 |
|
301 |
/**
|
302 |
* Dibuja el s?mbolo que indica que el FFrame contiene un tag.
|
303 |
*
|
304 |
* @param g Graphics sobre el que dibujar.
|
305 |
*/
|
306 |
public void drawSymbolTag(Graphics2D g); |
307 |
|
308 |
/**
|
309 |
* Rellena la rotaci?n del BoundingBox.
|
310 |
*
|
311 |
* @param rotation rotaci?n que se quiere aplicar.
|
312 |
*/
|
313 |
public void setRotation(double rotation); |
314 |
|
315 |
/**
|
316 |
* Devuelve la rotaci?n del BoundingBox.
|
317 |
*
|
318 |
* @return Rotaci?n del BoundingBox.
|
319 |
*/
|
320 |
public double getRotation(); |
321 |
|
322 |
/**
|
323 |
* Devuelve el nivel al que se encuentra el FFrame en el Layout.
|
324 |
*
|
325 |
* @return nivel.
|
326 |
*/
|
327 |
public int getLevel(); |
328 |
|
329 |
/**
|
330 |
* Inserta el nivel de dibujado del FFrame respecto del resto de fframes
|
331 |
* del Layout.
|
332 |
*
|
333 |
* @param l nivel.
|
334 |
*/
|
335 |
public void setLevel(int l); |
336 |
|
337 |
} |