svn-gvsig-desktop / tags / v1_0_RELEASE / frameworks / _fwAndami / src / com / iver / andami / ui / mdiManager / MDIManager.java @ 9167
History | View | Annotate | Download (7.12 KB)
1 | 1104 | fjp | /* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana
|
---|---|---|---|
2 | *
|
||
3 | * Copyright (C) 2004 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 | 598 | fernando | package com.iver.andami.ui.mdiManager; |
42 | |||
43 | 8899 | cesar | import java.awt.Component; |
44 | 3249 | fjp | import java.beans.PropertyVetoException; |
45 | |||
46 | 598 | fernando | import com.iver.andami.ui.mdiFrame.MDIFrame; |
47 | |||
48 | |||
49 | /**
|
||
50 | * Las vistas que se a?aden al framework derivan de JPanel. ?Como pasamos de un
|
||
51 | * JPanel al control que vemos (habitualmente un JInternalFrame) Mediante la
|
||
52 | * clase skin que implementa esta interfaz. El framework invoca los m?todos
|
||
53 | * de la clase pasando como par?metros jPanel y la clase toma el JPanel, lo
|
||
54 | * trata (en la version por defecto lo mete en un JInternalFrame) y lo a?ade
|
||
55 | * al Frame principal. Para poner un ejemplo se podr?a implementar ua clase
|
||
56 | * que situara los jpanel en la forma que lo hace eclipse, o instalar un men?
|
||
57 | * por cada vista de forma que al seleccionar el men? desapareciera la vista
|
||
58 | * actual y se mostrara la que se ha seleccionado, ... Actualmente la
|
||
59 | * clase que implementa esta interfaz es Skin y se usa a pi??n fijo, pero en
|
||
60 | * un futuro se dejar? abierta la posibilidad de sustituir esta clase por una
|
||
61 | * que implemente el usuario.
|
||
62 | *
|
||
63 | * @author Fernando Gonz?lez Cort?s
|
||
64 | */
|
||
65 | public interface MDIManager { |
||
66 | 2553 | caballero | /**
|
67 | * Inicializaci?n de la clase, se le pasa la consola para mostrar mensajes
|
||
68 | * y el frame principal para actuar sobre ?l
|
||
69 | *
|
||
70 | * @param f DOCUMENT ME!
|
||
71 | */
|
||
72 | public void init(MDIFrame f); |
||
73 | 598 | fernando | |
74 | 2553 | caballero | /**
|
75 | * A?ade una nueva vista a la interfaz y lo visualiza. Dicho vista se
|
||
76 | * elimina completamente al cerrarse.
|
||
77 | *
|
||
78 | * @param p Panel con los controles de la vista
|
||
79 | *
|
||
80 | * @return Devuelve la vista a?adida o si es un singleton y ya estaba
|
||
81 | * a?adida devuelve la vista ya a?adida
|
||
82 | *
|
||
83 | * @throws SingletonDialogAlreadyShownException Si lo que se est? a?adiendo
|
||
84 | * es una vista modal singleton y ya est? a?adida
|
||
85 | */
|
||
86 | 6880 | cesar | public IWindow addWindow(IWindow p) throws SingletonDialogAlreadyShownException; |
87 | 598 | fernando | |
88 | 2553 | caballero | /**
|
89 | 6863 | ppiqueras | * @author Pablo Piqueras Bartolom?
|
90 | *
|
||
91 | * A?ade una nueva vista centrada a la interfaz y la visualiza. Dicha vista se
|
||
92 | * elimina completamente al cerrarse.
|
||
93 | *
|
||
94 | * @param p Panel con los controles de la vista
|
||
95 | *
|
||
96 | * @return Devuelve la vista a?adida o si es un singleton y ya estaba
|
||
97 | * a?adida devuelve la vista ya a?adida
|
||
98 | *
|
||
99 | * @throws SingletonDialogAlreadyShownException Si lo que se est? a?adiendo
|
||
100 | * es una vista modal singleton y ya est? a?adida
|
||
101 | */
|
||
102 | 6880 | cesar | public IWindow addCentredWindow(IWindow p) throws SingletonDialogAlreadyShownException; |
103 | 6863 | ppiqueras | |
104 | |||
105 | /**
|
||
106 | 2553 | caballero | * Obtiene una referencia al panel de la ultima vista no modal que se
|
107 | * activ? en la aplicaci?n.
|
||
108 | *
|
||
109 | * @return referencia al panel activo o null si no hay ninguna vista activa
|
||
110 | */
|
||
111 | 6880 | cesar | public IWindow getActiveWindow();
|
112 | 2553 | caballero | /**
|
113 | 4726 | caballero | * Obtiene una referencia al panel de la ?ltima vista, ya sea modal o no,que se
|
114 | * activ? en la aplicaci?n.
|
||
115 | *
|
||
116 | * @return referencia al panel activo o null si no hay ninguna vista activa
|
||
117 | */
|
||
118 | 6880 | cesar | public IWindow getFocusWindow();
|
119 | 4726 | caballero | /**
|
120 | 7430 | cesar | * Obtiene una referencia a los paneles de todas las ventanas no modales que
|
121 | * hay en la aplicaci?n.
|
||
122 | 2553 | caballero | *
|
123 | * @return Un vector con todos los paneles que contiene la aplicaci?n.
|
||
124 | */
|
||
125 | 6880 | cesar | public IWindow[] getAllWindows(); |
126 | 7430 | cesar | /**
|
127 | * Gets a reference to the panels of all the non modal windows present in
|
||
128 | * the application. The panels are provided in the same order that
|
||
129 | * they have in the application.
|
||
130 | *
|
||
131 | * @return An ordered array containing all the panels in the application.
|
||
132 | * The first element of the array is the topmost (foreground) window in the
|
||
133 | * application. The last element is the botton (background) window.
|
||
134 | */
|
||
135 | public IWindow[] getOrderedWindows(); |
||
136 | 598 | fernando | |
137 | 2553 | caballero | /**
|
138 | * Cierra la ventana SingletonView cuya clase se pasa como par?metro y cuyo
|
||
139 | * modelo se pasa como par?metro.
|
||
140 | *
|
||
141 | * @param viewClass Clase de la vista que se quiere cerrar
|
||
142 | * @param model Modelo de la vista que se quiere cerrar
|
||
143 | *
|
||
144 | * @return true si hay abierta una vista con la clase viewClass y con el
|
||
145 | * modelo que se pasa como par?metro. False si no hay ninguna
|
||
146 | * ventana de ese tipo.
|
||
147 | */
|
||
148 | 6880 | cesar | public boolean closeSingletonWindow(Class viewClass, Object model); |
149 | 598 | fernando | |
150 | 2553 | caballero | /**
|
151 | * Cierra todas las ventanas Singleton que tengan como modelo el que se
|
||
152 | * pasa como par?metro
|
||
153 | *
|
||
154 | * @param model Modelo de las ventanas que se quieren cerrar
|
||
155 | *
|
||
156 | * @return true si se cierra alguna ventana y false si no hay abierta
|
||
157 | * ninguna ventana singleton con ese modelo
|
||
158 | */
|
||
159 | 6880 | cesar | public boolean closeSingletonWindow(Object model); |
160 | 598 | fernando | |
161 | 2553 | caballero | /**
|
162 | * Cierra la vista correspondiente con el JPanel
|
||
163 | *
|
||
164 | * @param p vista que se quiere cerrar
|
||
165 | */
|
||
166 | 6880 | cesar | public void closeWindow(IWindow p); |
167 | 598 | fernando | |
168 | 2553 | caballero | /**
|
169 | * Cierra todas las vistas que actualmente est?n abiertas
|
||
170 | */
|
||
171 | 6880 | cesar | public void closeAllWindows(); |
172 | 1323 | fernando | |
173 | 2553 | caballero | /**
|
174 | * Obtiene la referencia al objeto que contiene la informaci?n de la vista
|
||
175 | * que se pasa como par?metro
|
||
176 | *
|
||
177 | * @param v vista cuya informaci?n se requiere
|
||
178 | *
|
||
179 | * @return ViewInfo
|
||
180 | */
|
||
181 | 6880 | cesar | public WindowInfo getWindowInfo(IWindow v);
|
182 | 1323 | fernando | |
183 | 2553 | caballero | /**
|
184 | * Pone como icono de rat?n el HourGlass y bloquea todos los eventos de la
|
||
185 | * interfaz que se producen hasta que se recibe una llamada a
|
||
186 | * restoreCursor
|
||
187 | */
|
||
188 | public void setWaitCursor(); |
||
189 | |||
190 | /**
|
||
191 | * Restaura al icono de rat?n que hab?a antes de realizar la operaci?n
|
||
192 | */
|
||
193 | public void restoreCursor(); |
||
194 | 4726 | caballero | |
195 | 3249 | fjp | /**
|
196 | * Maximiza o no la ventana que contiene la vista v
|
||
197 | * @param v
|
||
198 | * @param bMaximum
|
||
199 | * @throws PropertyVetoException
|
||
200 | */
|
||
201 | 6877 | cesar | public void setMaximum(IWindow v, boolean bMaximum) throws PropertyVetoException; |
202 | 4726 | caballero | /**
|
203 | * Cambia el ViewInfo de la vista por el que pasamos como par?metro, utilizado de
|
||
204 | * momento para cambiar la vista a palette
|
||
205 | * @param v
|
||
206 | * @param vi
|
||
207 | */
|
||
208 | 6880 | cesar | public void changeWindowInfo(IWindow v, WindowInfo vi); |
209 | 8899 | cesar | |
210 | public void refresh(IWindow win); |
||
211 | 598 | fernando | } |