PluginServices (org.gvsig.andami 2.0.487 API)

java.lang.Object
- org.gvsig.andami.PluginServices

```
public class PluginServices
extends java.lang.Object
```
Provides services to Plugins. Each plugin has an associated PluginServices object, which provides specific services. Main of them: translations, logging, access to plugin's resources, background tasks, clipboard access and data persistence.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`PluginServices.PluginLoadDataException`
`class`	`PluginServices.PluginPersistenceAddDefinitionException`
`class`	`PluginServices.PluginPersistenceNeedDefinitionException`
`class`	`PluginServices.PluginSaveDataException`

Constructor Summary

Constructors
Constructor and Description
`PluginServices(PluginClassLoader loader)` Creates a new PluginServices objetct.
`PluginServices(PluginClassLoader loader, java.lang.String[] alternativeNames)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDependencyWithPlugin(PluginServices otherPlugin)`
`static void`	`addLoaders(java.util.ArrayList classLoaders)`
`void`	`addPopupMenuListener(java.lang.String name, java.awt.Component c, java.awt.event.ActionListener listener)` Aï¿½ade un listener a un popup menu registrado en el config.xml de algï¿½n plugin
`static java.lang.Thread`	`backgroundExecution(java.lang.Runnable r)` Runs a background task.
`static void`	`cancelableBackgroundExecution(org.gvsig.utils.swing.threads.IMonitorableTask task)` Runs a backbround task.
`static void`	`closeApplication()` Closes the application.
`java.lang.String[]`	`getAlternativeNames()`
`static java.lang.String`	`getArgumentByName(java.lang.String name)` Returns the value of a command line named argument.
`static java.lang.String[]`	`getArguments()` Deprecated.
`PluginClassLoader`	`getClassLoader()` Gets the plugin's classloader.
`static ExtensionDecorator`	`getDecoratedExtension(java.lang.Class extensionClass)` Deprecated.
`static ExtensionDecorator[]`	`getDecoratedExtensions()` Deprecated.
`static DlgPreferences`	`getDlgPreferences()` Deprecated.
`static ExclusiveUIExtension`	`getExclusiveUIExtension()` Deprecated.
`static IExtension`	`getExtension(java.lang.Class extensionClass)` Deprecated.
`static java.util.Iterator`	`getExtensions()` Deprecated.
`static java.lang.String`	`getFromClipboard()` Deprecated.
`static org.gvsig.tools.swing.icontheme.IconTheme`	`getIconTheme()`
`static org.gvsig.tools.swing.icontheme.IconThemeManager`	`getIconThemeManager()`
`static org.slf4j.Logger`	`getLogger()` Deprecated.
`static MainFrame`	`getMainFrame()` Deprecated.
`PluginsManager`	`getManager()` Deprecated.
`static MDIManager`	`getMDIManager()` Deprecated.
`org.gvsig.utils.XMLEntity`	`getPersistentXML()` Deprecated.
`java.io.File`	`getPluginDirectory()` Gets the plugin's root directory.
`java.io.File`	`getPluginHomeFolder()` Returns the folder where the plugin stores its resources.
`java.lang.String`	`getPluginName()` Gets the plugin's name
`org.gvsig.tools.dynobject.DynObject`	`getPluginProperties()`
`static PluginServices`	`getPluginServices(java.lang.Object pluginClassInstance)` Deprecated.
`static PluginServices`	`getPluginServices(java.lang.String pluginName)` Deprecated.
`static java.lang.String`	`getText(java.lang.Object pluginObject, java.lang.String key)` Returns the message in the current's locale language corresponding to the provided translation key.
`java.lang.String`	`getText(java.lang.String key)` Returns the message in the current's locale language corresponding to the provided translation key.
`static void`	`putInClipboard(java.lang.String data)` Stores the provided text data on the clipboard.
`static void`	`registerKeyStroke(javax.swing.KeyStroke key, java.awt.KeyEventDispatcher a)`
`static boolean`	`runningInDevelopment()` Try to detect if the application is running in a development environment.
`void`	`savePluginProperties()`
`static void`	`setArguments(java.lang.String[] arguments)` Deprecated.
`static void`	`setExclusiveUIExtension(ExclusiveUIExtension extension)` Deprecated.
`void`	`setPersistentXML(org.gvsig.utils.XMLEntity entity)` Sets the XML data which should be saved on disk for this plugin.
`java.lang.String`	`toString()`
`static void`	`unRegisterKeyStroke(javax.swing.KeyStroke key)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PluginServices
```
public PluginServices(PluginClassLoader loader)
```
    Creates a new PluginServices objetct.
    
    Parameters:
    
    loader - The Plugin's ClassLoader.
  - PluginServices
```
public PluginServices(PluginClassLoader loader,
                      java.lang.String[] alternativeNames)
```
- Method Detail
  - addDependencyWithPlugin
```
public void addDependencyWithPlugin(PluginServices otherPlugin)
```
  - addLoaders
```
public static void addLoaders(java.util.ArrayList classLoaders)
```
  - addPopupMenuListener
```
public void addPopupMenuListener(java.lang.String name,
                                 java.awt.Component c,
                                 java.awt.event.ActionListener listener)
```
    Aï¿½ade un listener a un popup menu registrado en el config.xml de algï¿½n plugin
    
    Parameters:
    
    name - Nombre del menï¿½ contextual
    
    c - Componente que desplegarï¿½ el menï¿½ cuando se haga click con el botï¿½n derecho
    
    listener - Listener que se ejecutarï¿½ cuando se seleccione cualquier entrada del menï¿½
    
    Throws:
    
    java.lang.RuntimeException - Si la interfaz no estï¿½ preparada todavï¿½a. Sï¿½lo puede darse durante el arranque
  - backgroundExecution
```
public static java.lang.Thread backgroundExecution(java.lang.Runnable r)
```
    Runs a background task. The events produced on the main frame will be inhibited.
    
    Parameters:
    
    r - The task to run.
    
    Returns:
    
    The Thread on which the task is executed.
  - cancelableBackgroundExecution
```
public static void cancelableBackgroundExecution(org.gvsig.utils.swing.threads.IMonitorableTask task)
```
    Runs a backbround task. This task may be monitored and canceled, and does not inhibit any event.
    
    Parameters:
    
    task - The task to run.
  - closeApplication
```
public static void closeApplication()
```
    Closes the application. Cleanly exits from the application: terminates all the extensions, then exits.
  - getAlternativeNames
```
public java.lang.String[] getAlternativeNames()
```
  - getArgumentByName
```
public static java.lang.String getArgumentByName(java.lang.String name)
```
    Returns the value of a command line named argument.
    
    The argument format is:
    -{argumentName}={argumentValue}
    
    example:
    ' -language=en '
    
    Returns:
    
    String The value of the argument
  - getArguments
```
@Deprecated
public static java.lang.String[] getArguments()
```
    Deprecated.
    
    Gets an array containing the application's startup arguments.
    
    Usually: appName plugins-directory [locale] [other args]
    
    Returns:
    
    the original arguments that Andami received. (app-name plugins-directory, locale, etc)
  - getClassLoader
```
public PluginClassLoader getClassLoader()
```
    Gets the plugin's classloader.
    
    Returns:
    
    Returns the loader.
  - getDecoratedExtension
```
@Deprecated
public static ExtensionDecorator getDecoratedExtension(java.lang.Class extensionClass)
```
    Deprecated.
    
    Gets a reference to the Extension Decorator which adds some extra options to the basic extension interface.
    
    Parameters:
    
    extensionClass - The class of the extension whose decorator is to be returned
    
    Returns:
    
    The ExtensionDecorator associated with the provided extension, or null if the extension does not exist.
  - getDecoratedExtensions
```
@Deprecated
public static ExtensionDecorator[] getDecoratedExtensions()
```
    Deprecated.
    
    Returns an array containing references to all the loaded extensions.
    
    Returns:
    
    ExtensionDecorator[] An array of ExtensionDecorators (each Decorator contains one extension).
  - getDlgPreferences
```
@Deprecated
public static DlgPreferences getDlgPreferences()
```
    Deprecated.
  - getExclusiveUIExtension
```
@Deprecated
public static ExclusiveUIExtension getExclusiveUIExtension()
```
    Deprecated.
    
    Gets the ExclusiveUIExtension, an special extension which will take control over the UI and will decide which extensions may be enable/disabled or visible/hidden.
    
    Returns:
    
    If an ExclusiveUIExtension was set, return this extension. Otherwise, return null.
    
    See Also:
    
    Launcher.initializeExclusiveUIExtension(), org.gvsig.andami.plugins.IExtension#isEnabled(IExtension extension), org.gvsig.andami.plugins.IExtension#isVisible(IExtension extension)
  - getExtension
```
@Deprecated
public static IExtension getExtension(java.lang.Class extensionClass)
```
    Deprecated.
    
    Gets the instance of the extension whose class is provided.
    
    Parameters:
    
    extensionClass - Class of the extension whose instance is to be returned
    
    Returns:
    
    The instance of the extension, or null if the instance does not exist.Instancia de la extensiï¿½n o null en caso de que no haya una
  - getExtensions
```
@Deprecated
public static java.util.Iterator getExtensions()
```
    Deprecated.
    
    Gets an iterator with all the loaded Extensions.
    
    Returns:
    
    Iterator over the decorated extensions (each member of the iterator is an ExtensionDecorator, which in turn contains one IExtension object).
  - getFromClipboard
```
@Deprecated
public static java.lang.String getFromClipboard()
```
    Deprecated.
    
    Gets text data from the Clipboard, if available.
    
    Returns:
    
    An String containing the clipboard's data, or null if the data was not available.
  - getIconTheme
```
public static org.gvsig.tools.swing.icontheme.IconTheme getIconTheme()
```
  - getIconThemeManager
```
public static org.gvsig.tools.swing.icontheme.IconThemeManager getIconThemeManager()
```
  - getLogger
```
@Deprecated
public static org.slf4j.Logger getLogger()
```
    Deprecated.
    
    Gets the logger. The logger is used to register important events (errors, etc), which are stored on a file which can be checked later.
    
    Returns:
    
    A Logger object.
    
    See Also:
    
    object from the Log4j library.
  - getMainFrame
```
@Deprecated
public static MainFrame getMainFrame()
```
    Deprecated.
    
    Gets the application's main frame.
    
    Returns:
    
    A reference to the application's main window
  - getManager
```
@Deprecated
public PluginsManager getManager()
```
    Deprecated.
  - getMDIManager
```
@Deprecated
public static MDIManager getMDIManager()
```
    Deprecated.
    
    Gets the window manager (MDIManager).
    
    Returns:
    
    A reference to the window manager (MDIManager).
  - getPersistentXML
```
@Deprecated
public org.gvsig.utils.XMLEntity getPersistentXML()
```
    Deprecated.
    
    Gets the XML data which was saved on previous sessions for this plugins.
    
    Returns:
    
    An XMLEntity object containing the persisted data
  - getPluginDirectory
```
public java.io.File getPluginDirectory()
```
    Gets the plugin's root directory.
    
    Returns:
    
    A File pointing to the plugin's root directory.
  - getPluginHomeFolder
```
public java.io.File getPluginHomeFolder()
```
    Returns the folder where the plugin stores its resources. That folder will be usually a subfolder into the application folder in the user home folder.
    
    Returns:
    
    the folder where the plugin stores its resources
  - getPluginName
```
public java.lang.String getPluginName()
```
    Gets the plugin's name
    
    Returns:
    
    The plugin's name
  - getPluginProperties
```
public org.gvsig.tools.dynobject.DynObject getPluginProperties()
```
  - getPluginServices
```
@Deprecated
public static PluginServices getPluginServices(java.lang.Object pluginClassInstance)
```
    Deprecated.
    
    Gets a reference to the PluginServices object associated with the plugin containing the provided class. Obtienen una referencia al PluginServices del plugin cuyo nombre se pasa como parï¿½metro
    
    Parameters:
    
    pluginClassInstance - An instance of a class. This class is contained in a plugin, whose services are to be obtained
    
    Returns:
    
    The PluginServices object associated to the containing plugin
    
    Throws:
    
    java.lang.RuntimeException - If the parameter was not loaded from a plugin
  - getPluginServices
```
@Deprecated
public static PluginServices getPluginServices(java.lang.String pluginName)
```
    Deprecated.
    
    Gets a reference to the PluginServices object associated with the provided plugin.
    
    Parameters:
    
    pluginName - Plugin's name whose services are going to be used
    
    Returns:
    
    The PluginServices object associated with the provided plugin.
  - getText
```
public static java.lang.String getText(java.lang.Object pluginObject,
                                       java.lang.String key)
```
    Returns the message in the current's locale language corresponding to the provided translation key. The key-message pairs are obtained from the plugin's translation files (text_xx.properties files).
    
    Parameters:
    
    pluginObject - Any object which was loaded from a plugin
    
    key - Translation key whose associated message is to be obtained
    
    Returns:
    
    The message associated with the provided key, in one of the current locale languages, or the key if the translation is not found.
  - getText
```
public java.lang.String getText(java.lang.String key)
```
    Returns the message in the current's locale language corresponding to the provided translation key. The key-message pairs are obtained from the plugin's translation files (text_xx.properties files).
    
    Parameters:
    
    key - Translation key whose associated message is to be obtained
    
    Returns:
    
    The message associated with the provided key, in one of the current locale languages, or the key if the translation is not found.
  - putInClipboard
```
public static void putInClipboard(java.lang.String data)
```
    Stores the provided text data on the clipboard.
    
    Parameters:
    
    data - An String containing the data to be stored on the clipboard.
  - registerKeyStroke
```
public static void registerKeyStroke(javax.swing.KeyStroke key,
                                     java.awt.KeyEventDispatcher a)
```
  - runningInDevelopment
```
public static boolean runningInDevelopment()
```
    Try to detect if the application is running in a development environment.
    This look for .project and .classpath files in the starts path of the application.
    
    Returns:
    
    true if .project and .classpath are in the development path
  - savePluginProperties
```
public void savePluginProperties()
```
  - setArguments
```
@Deprecated
public static void setArguments(java.lang.String[] arguments)
```
    Deprecated.
    
    Replaces the original Andami arguments with the provided arguments.
    
    Parameters:
    
    arguments - An array of String, each element of the array represents one argument.
  - setExclusiveUIExtension
```
@Deprecated
public static void setExclusiveUIExtension(ExclusiveUIExtension extension)
```
    Deprecated.
    
    Sets the ExclusiveUIExtension, an special extension which will take control over the UI and will decide which extensions may be enable/disabled or visible/hidden.
    
    The ExclusiveUIExtension is normally set by the following Andami startup argument:
    
    ExclusiveUIExtension=ExtensionName
    
    See Also:
    
    Launcher.initializeExclusiveUIExtension(), org.gvsig.andami.plugins.IExtension#isEnabled(IExtension extension), org.gvsig.andami.plugins.IExtension#isVisible(IExtension extension)
  - setPersistentXML
```
public void setPersistentXML(org.gvsig.utils.XMLEntity entity)
```
    Sets the XML data which should be saved on disk for this plugin. This data can be retrieved on following sessions.
    
    Parameters:
    
    The - XMLEntity object containing the data to be persisted.
    
    See Also:
    
    PluginServices.getPersistentXML(), XMLEntity
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - unRegisterKeyStroke
```
public static void unRegisterKeyStroke(javax.swing.KeyStroke key)
```

Class PluginServices

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PluginServices

PluginServices

Method Detail

addDependencyWithPlugin

addLoaders

addPopupMenuListener

backgroundExecution

cancelableBackgroundExecution

closeApplication

getAlternativeNames

getArgumentByName

getArguments

getClassLoader

getDecoratedExtension

getDecoratedExtensions

getDlgPreferences

getExclusiveUIExtension

getExtension

getExtensions

getFromClipboard

getIconTheme

getIconThemeManager

getLogger

getMainFrame

getManager

getMDIManager

getPersistentXML

getPluginDirectory

getPluginHomeFolder

getPluginName

getPluginProperties

getPluginServices

getPluginServices

getText

getText

putInClipboard

registerKeyStroke

runningInDevelopment

savePluginProperties

setArguments

setExclusiveUIExtension

setPersistentXML

toString

unRegisterKeyStroke