Statistics
| Revision:

svn-gvsig-desktop / trunk / applications / appgvSIG / src / com / iver / cit / gvsig / project / documents / layout / fframes / IFFrame.java @ 28368

History | View | Annotate | Download (9.97 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.project.documents.layout.fframes;
46

    
47
import java.awt.Cursor;
48
import java.awt.Graphics2D;
49
import java.awt.Image;
50
import java.awt.event.MouseEvent;
51
import java.awt.geom.AffineTransform;
52
import java.awt.geom.Point2D;
53
import java.awt.geom.Rectangle2D;
54
import java.awt.image.BufferedImage;
55

    
56
import com.iver.cit.gvsig.fmap.core.IPrintable;
57
import com.iver.cit.gvsig.fmap.layers.XMLException;
58
import com.iver.cit.gvsig.project.documents.exceptions.SaveException;
59
import com.iver.cit.gvsig.project.documents.layout.fframes.gui.dialogs.IFFrameDialog;
60
import com.iver.cit.gvsig.project.documents.layout.gui.Layout;
61
import com.iver.utiles.XMLEntity;
62

    
63

    
64
/**
65
 * Interface que implementa FFrame.
66
 *
67
 * @author Vicente Caballero Navarro
68
 */
69
public interface IFFrame extends IPrintable{
70
        public static final int N = 1;
71
    public static final int NE = 2;
72
    public static final int E = 3;
73
    public static final int SE = 4;
74
    public static final int S = 5;
75
    public static final int SO = 6;
76
    public static final int O = 7;
77
    public static final int NO = 8;
78
    public static final int RECT = 9;
79
    /** FFrame no selecccionado. */
80
    public static final int NOSELECT = 0;
81

    
82
    /**
83
     * Devuelve el boundingBox del fframe en funci?n de la transformada af?n
84
     * que se pasa como par?metro. Si se pasa como par?metro null, devuelve el
85
     * ?ltimo boundingbox que se calcul?.
86
     *
87
     * @param at Transformada af?n
88
     *
89
     * @return Rect?ngulo que representa el BoundingBox del fframe.
90
     */
91
    public Rectangle2D.Double getBoundingBox(AffineTransform at);
92

    
93
    /**
94
     * Devuelve el rect?ngulo que representa el fframe en cent?metros.
95
     *
96
     * @return Rect?ngulo en centimetros.
97
     */
98
    public Rectangle2D.Double getBoundBox();
99

    
100
    /**
101
     * Rellena con el rect?ngulo que se pasa como par?metro el boundBox(en
102
     * cent?metros) del fframe del cual con una transformaci?n se podr?
103
     * calcular el BoundingBox (en pixels).
104
     *
105
     * @param rect Rect?ngulo en cent?metros.
106
     */
107
    public void setBoundBox(Rectangle2D rect);
108

    
109
    /**
110
     * Este m?todo se implementa en cada una de las fframe, ya que cada una se
111
     * dibuja de una forma diferente sobre el graphics. M?todo que dibuja
112
     * sobre el graphics que se le pasa como par?metro, seg?n la transformada
113
     * afin que se debe de aplicar y el rect?ngulo que se debe de dibujar.
114
     *
115
     * @param g Graphics
116
     * @param at Transformada afin.
117
     * @param r rect?ngulo sobre el que hacer un clip.
118
     * @param imgBase Imagen para acelerar el dibujado.
119
     */
120
    public void draw(Graphics2D g, AffineTransform at, Rectangle2D r,
121
        BufferedImage imgBase);
122

    
123
//    /**
124
//     * Implementado para imprimir.
125
//     *
126
//     * @param g Graphics2D de la impresora sobre el que dibujar.
127
//     * @param at DOCUMENT ME!
128
//     */
129
//    public void print(Graphics2D g, AffineTransform at, FShape shape)
130
//        throws ReadDriverException;
131

    
132
    /**
133
     * Devuelve el nombre que representa al fframe.
134
     *
135
     * @return String nombre del FFrame.
136
     */
137
    public String getName();
138

    
139
    /**
140
     * Rellena el String que representa al nombre del fframe.
141
     *
142
     * @param n nombre del fframe.
143
     */
144
    public void setName(String n);
145

    
146
    /**
147
     * Devuelve true, si el punto que se pasa como par?metro esta contenido
148
     * dentro del boundingbox del fframe.
149
     *
150
     * @param p punto a comprobar.
151
     *
152
     * @return true si el punto esta dentro del boundingbox.
153
     */
154
    public boolean contains(Point2D p);
155

    
156
    /**
157
     * Dibuja los handlers sobre el boundingBox en el graphics que se pasa como
158
     * par?metro.
159
     *
160
     * @param g Graphics sobre el que dibujar.
161
     */
162
    public void drawHandlers(Graphics2D g);
163

    
164
    /**
165
     * Pasando como par?metro true,  se toma como que est? seleccionado el
166
     * fframe  y si es false como que esta sin seleccionar, de esta forma se
167
     * selecciona un fframe directamente sin comprobar si un punto est?
168
     * contenido en ?l.
169
     *
170
     * @param b true si se quiere seleccionar y false si se quiere
171
     *        deseleccionar.
172
     */
173
    public void setSelected(Point2D b, MouseEvent e);
174

    
175
    /**
176
     * Establece que tipo de selecci?n se realiza sobre el fframe.
177
     *
178
     * @param b punto sobre el que se debe de establecer si se selecciona o no
179
     *        el fframe.
180
     */
181
    public void setSelected(boolean b);
182

    
183
    /**
184
     * Devuelve un entero que representa el tipo de selecci?n que se ha
185
     * realizado sobre el fframe.
186
     *
187
     * @return tipo de selecci?n que se ha realizado.
188
     */
189
    public int getSelected();
190

    
191
    /**
192
     * Devuelve un entero que representa donde esta contenido el punto que se
193
     * pasa como par?metro.
194
     *
195
     * @param p punto a comparar.
196
     *
197
     * @return entero que representa como esta contenido el punto.
198
     */
199
    public int getContains(Point2D p);
200

    
201
    /**
202
     * Devuelve el Cursor adecuado seg?n como est? contenido el punto, si es
203
     * para desplazamiento, o cambio de tama?o.
204
     *
205
     * @param p punto a comprobar.
206
     *
207
     * @return Cursor adecuado a la posici?n.
208
     */
209
    public Cursor getMapCursor(Point2D p);
210

    
211
    /**
212
     * Devuelve el rect?ngulo a partir del desplazamiento en el eje x y el
213
     * desplazamiento en el eje y.
214
     *
215
     * @param difx desplazamiento sobre el eje x.
216
     * @param dify desplazamiento sobre el eje y.
217
     *
218
     * @return rect?ngulo modificado en funci?n del desplazamiento realizado.
219
     */
220
    public Rectangle2D getMovieRect(int difx, int dify);
221

    
222
    /**
223
     * Devuelve un Objeto XMLEntity con la informaci?n los atributos necesarios
224
     * para poder despu?s volver a crear el objeto original.
225
     *
226
     * @return XMLEntity.
227
     *
228
     * @throws XMLException
229
     */
230
    public XMLEntity getXMLEntity() throws SaveException;
231

    
232
    /**
233
     * Dibuja un rect?ngulo de color gris,  con el nombre en el centro y
234
     * escalado en forma de borrador.
235
     *
236
     * @param g Graphics sobre el que se dibuja.
237
     */
238
    public void drawDraft(Graphics2D g);
239

    
240
    /**
241
     * Actualiza el BoundBox del FFrame a partir de su rect?ngulo en pixels y
242
     * la matriz de transformaci?n.
243
     *
244
     * @param r Rect?ngulo.
245
     * @param at Matriz de transformaci?n.
246
     */
247
    public void updateRect(Rectangle2D r, AffineTransform at);
248

    
249
    /**
250
     * Devuelve true si el rect?ngulo primero es null o si es distinto de null
251
     * e intersecta.
252
     *
253
     * @param rv Rect?ngulo
254
     * @param r Rect?ngulo
255
     *
256
     * @return True si intersecta o es null.
257
     */
258
    public boolean intersects(Rectangle2D rv, Rectangle2D r);
259

    
260
    /**
261
     * Introduce el n?mero de FFrame en el que de que se trata.
262
     *
263
     * @param i n?mero de FFrame
264
     */
265
    public void setNum(int i);
266

    
267
    /**
268
     * A partir del xml y de Project inicia el objeto.
269
     *
270
     * @param xml XMLEntity
271
     */
272
    public void setXMLEntity(XMLEntity xml);
273

    
274
    /**
275
     * A partir del xml y de Project inicia el objeto.
276
     *
277
     * @param xml XMLEntity
278
     * @param l Project
279
     */
280
    public void setXMLEntity03(XMLEntity xml, Layout l);
281

    
282
    /**
283
     * Devuelve el nombre que representa al tipo de FFrame.
284
     *
285
     * @return nombre del elemento.
286
     */
287
    public String getNameFFrame();
288

    
289
    /**
290
     * Abre la ventana para modificar el tag.
291
     */
292
    public void openTag();
293

    
294
    /**
295
     * Rellena el tag.
296
     *
297
     * @param s valor del tag.
298
     */
299
    public void setTag(String s);
300

    
301
    /**
302
     * Devuelve el valor del tag.
303
     *
304
     * @return String del valor del tag.
305
     */
306
    public String getTag();
307

    
308
    /**
309
     * Dibuja el s?mbolo que indica que el FFrame contiene un tag.
310
     *
311
     * @param g Graphics sobre el que dibujar.
312
     */
313
    public void drawSymbolTag(Graphics2D g);
314

    
315
    /**
316
     * Rellena la rotaci?n del BoundingBox.
317
     *
318
     * @param rotation rotaci?n que se quiere aplicar.
319
     */
320
    public void setRotation(double rotation);
321

    
322
    /**
323
     * Devuelve la rotaci?n del BoundingBox.
324
     *
325
     * @return Rotaci?n del BoundingBox.
326
     */
327
    public double getRotation();
328

    
329
    /**
330
     * Devuelve el nivel al que se encuentra el FFrame en el Layout.
331
     *
332
     * @return nivel.
333
     */
334
    public int getLevel();
335

    
336
    /**
337
     * Inserta el nivel de dibujado del FFrame respecto del resto de fframes
338
     * del Layout.
339
     *
340
     * @param l nivel.
341
     */
342
    public void setLevel(int l);
343
    public IFFrame cloneFFrame(Layout layout);
344
        public Rectangle2D getLastMoveRect();
345
         /**
346
     * Operaciones necesarias para finalizar correctamente el clonado de un frame, por ejemplo los listeners.
347
     *
348
     * @param frame IFFrame del cual copiar los listeners.
349
     */
350
        public void cloneActions(IFFrame frame);
351
        public IFFrameDialog getPropertyDialog();
352
        public void setLayout(Layout layout);
353
        public Layout getLayout();
354

    
355
        public void setFrameLayoutFactory(FrameFactory flf);
356
        public FrameFactory getFrameLayoutFactory();
357
}