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