Revision 5800 trunk/frameworks/_fwAndami/src/com/iver/andami/PluginServices.java

View differences:

PluginServices.java
62 62
import com.iver.andami.plugins.ExtensionDecorator;
63 63
import com.iver.andami.plugins.IExtension;
64 64
import com.iver.andami.plugins.PluginClassLoader;
65
import com.iver.andami.preferences.DlgPreferences;
65 66
import com.iver.andami.ui.mdiFrame.MDIFrame;
66 67
import com.iver.andami.ui.mdiFrame.MainFrame;
67 68
import com.iver.andami.ui.mdiManager.MDIManager;
......
73 74

  
74 75
/**
75 76
 * Clase que proporciona servicios a los plugins.
76
 * 
77
 *
77 78
 * @author Fernando Gonz?lez Cort?s
78 79
 */
79 80
public class PluginServices {
......
92 93

  
93 94
	/**
94 95
	 * Crea un nuevo PluginServices
95
	 * 
96
	 *
96 97
	 * @param loader
97 98
	 *            ClassLoader del plugin
98 99
	 */
......
103 104
	/**
104 105
	 * Devuelve el mensaje en el idioma del locale actual del texto
105 106
	 * correspondiente a la clave que se pasa como par?metro
106
	 * 
107
	 *
107 108
	 * @param key
108 109
	 *            Clave del texto que se quiere obtener
109
	 * 
110
	 *
110 111
	 * @return Texto en el idioma que toca o la propia clave si no se encuentra
111 112
	 *         en el fichero
112 113
	 */
......
124 125

  
125 126
	/**
126 127
	 * Obtiene el classloader del plugin
127
	 * 
128
	 *
128 129
	 * @return Returns the loader.
129 130
	 */
130 131
	public PluginClassLoader getClassLoader() {
......
133 134

  
134 135
	/**
135 136
	 * Obtiene el nombre del plugin
136
	 * 
137
	 *
137 138
	 * @return String
138 139
	 */
139 140
	String getPluginName() {
......
143 144
	/**
144 145
	 * Establece el paquete de traducciones del objeto pluginservices asociado a
145 146
	 * un plugin
146
	 * 
147
	 *
147 148
	 * @param name
148 149
	 *            nombre del paquete
149 150
	 * @param locale
......
162 163
	/**
163 164
	 * Obtienen una referencia al PluginServices del plugin cuyo nombre se pasa
164 165
	 * como par?metro
165
	 * 
166
	 *
166 167
	 * @param pluginClassInstance
167 168
	 *            Instancia de una clase propia del plugin a cuyos servicios se
168 169
	 *            quiere acceder
169
	 * 
170
	 *
170 171
	 * @return Objeto PluginServices asociado al plugin
171
	 * 
172
	 *
172 173
	 * @throws RuntimeException
173 174
	 *             Si el par?metro no es un objeto cargado desde un plugin
174 175
	 */
......
190 191
	/**
191 192
	 * Obtienen una referencia al PluginServices del plugin cuyo nombre se pasa
192 193
	 * como par?metro
193
	 * 
194
	 *
194 195
	 * @param pluginName
195 196
	 *            Instancia de una clase propia del plugin a cuyos servicios se
196 197
	 *            quiere acceder
197
	 * 
198
	 *
198 199
	 * @return Objeto PluginServices asociado al plugin
199 200
	 */
200 201
	public static PluginServices getPluginServices(String pluginName) {
......
203 204

  
204 205
	/**
205 206
	 * Obtiene una referencia al gestor de ventanas
206
	 * 
207
	 *
207 208
	 * @return MDIManager
208 209
	 */
209 210
	public static MDIManager getMDIManager() {
......
212 213

  
213 214
	/**
214 215
	 * Obtiene una referencia al marco principal de la aplicaci?n
215
	 * 
216
	 *
216 217
	 * @return MainFrame
217 218
	 */
218 219
	public static MainFrame getMainFrame() {
......
222 223
	/**
223 224
	 * Obtiene una referencia a la instancia de la extensi?n cuya clase se pasa
224 225
	 * como par?metro
225
	 * 
226
	 *
226 227
	 * @param extensionClass
227 228
	 *            Clase de la extensi?n cuya instancia se quiere obtener
228
	 * 
229
	 *
229 230
	 * @return Instancia de la extensi?n o null en caso de que no haya una
230 231
	 *         extensi?n con esa clase
231 232
	 */
......
241 242
	/**
242 243
	 * Gets a reference to the Extension Decorator with support for several more
243 244
	 * options
244
	 * 
245
	 *
245 246
	 * @param extensionClass
246 247
	 * @return
247 248
	 */
......
252 253

  
253 254
	/**
254 255
	 * Obtiene un iterador sobre las extensiones
255
	 * 
256
	 *
256 257
	 * @return Iterator
257 258
	 */
258 259
	public static Iterator getExtensions() {
......
261 262

  
262 263
	/**
263 264
	 * Obtiene una traducci?n de un plugin
264
	 * 
265
	 *
265 266
	 * @param pluginObject
266 267
	 *            Objeto cargado desde un plugin
267 268
	 * @param key
268 269
	 *            Nombre de la clave cuyo valor se quiere obtener
269
	 * 
270
	 *
270 271
	 * @return El valor, si existe. La clave si no existe. Si el objeto que se
271 272
	 *         pasa como par?metro no ha sido cargado desde un plugin se
272 273
	 *         devuelve la clave.
......
286 287
	/**
287 288
	 * Establece los datos del plugin que deber?n persistir entre ejecuciones en
288 289
	 * formato xml
289
	 * 
290
	 *
290 291
	 * @param entity
291 292
	 *            DOCUMENT ME!
292 293
	 */
......
297 298
	/**
298 299
	 * Obtiene un objeto que representa la persistencia del plugin en formato
299 300
	 * xml.
300
	 * 
301
	 *
301 302
	 * @return Devuelve null hasta que se invoca el m?todo setPersistentXML
302 303
	 */
303 304
	public XMLEntity getPersistentXML() {
......
310 311
	/**
311 312
	 * A?ade un listener a un popup menu registrado en el config.xml de alg?n
312 313
	 * plugin
313
	 * 
314
	 *
314 315
	 * @param name
315 316
	 *            Nombre del men? contextual
316 317
	 * @param c
......
319 320
	 * @param listener
320 321
	 *            Listener que se ejecutar? cuando se seleccione cualquier
321 322
	 *            entrada del men?
322
	 * 
323
	 *
323 324
	 * @throws RuntimeException
324 325
	 *             Si la interfaz no est? preparada todav?a. S?lo puede darse
325 326
	 *             durante el arranque
......
337 338

  
338 339
	/**
339 340
	 * Obtiene una referencia al directorio del plugin
340
	 * 
341
	 *
341 342
	 * @return File
342 343
	 */
343 344
	public File getPluginDirectory() {
......
348 349
	/**
349 350
	 * Ejecuta una tarea en segundo plano, dejando a la interfaz responder pero
350 351
	 * inhibiendo los eventos
351
	 * 
352
	 *
352 353
	 * @param r
353 354
	 *            Tarea a ejecutar
354
	 * 
355
	 *
355 356
	 * @return Thread en el que se ejecuta la tarea
356 357
	 */
357 358
	public static Thread backgroundExecution(Runnable r) {
......
364 365
	/**
365 366
	 * Runs a task in background. This task could be monitored and canceled, and
366 367
	 * doesnt inhibed any event.
367
	 * 
368
	 *
368 369
	 * @param task
369 370
	 *            IMonitorableTask
370 371
	 */
......
410 411

  
411 412
	/**
412 413
	 * DOCUMENT ME!
413
	 * 
414
	 *
414 415
	 * @author Fernando Gonz?lez Cort?s
415 416
	 */
416 417
	private static class RunnableDecorator implements Runnable {
......
418 419

  
419 420
		/**
420 421
		 * Crea un nuevo RunnableDecorator.
421
		 * 
422
		 *
422 423
		 * @param r
423 424
		 *            DOCUMENT ME!
424 425
		 */
......
488 489

  
489 490
	/**
490 491
	 * Usually appName plugins-directory [locale] [other args]
491
	 * 
492
	 *
492 493
	 * @return the original arguments that Andami received. (app-name
493 494
	 *         plugins-directory, locale, etc)
494 495
	 */
......
511 512
	public static void setAuthentication(IAuthentication authen) {
512 513
		authentication = authen;
513 514
	}
515
	public static DlgPreferences getDlgPreferences() {
516
		return DlgPreferences.getInstance();
517
	}
514 518
}

Also available in: Unified diff