|
Oxygen XML Editor, Version ${standalone-version-number} | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectro.sync.exml.plugin.PluginDescriptor
public class PluginDescriptor
Descriptor of the plugin.
A plugin is characterised by:
- name The plugin name as it will appear in the oXygen menus.
- description A short description of what the plugin does.
- vendor The name of the vendor.
- version The current version.
- baseDir The base dir used for file crreation.
- extensions A set of extensions.
Field Summary | |
---|---|
static String |
COMPONENTS_VALIDATOR_EXTENSION
The startup extension. |
static String |
DOCUMENT_PROCESSOR
Document processor extension type. |
static String |
GENERAL_EXTENSION
General extension type. |
static String |
OPEN_REDIRECTOR
Open redirector plugin type. |
static String |
SELECTION_PROCESSOR
Selection processor extension type. |
static String |
URL_CHOOSER
URL stream handler extension type. |
static String |
URL_CHOOSER_TOOLBAR
URL stream handler extension type. |
static String |
URL_HANDLER
URL stream handler extension type. |
static String |
URL_STREAM_HANDLER
Deprecated. |
static String |
WORKSPACE_ACCESS
Workspace access plugin type. |
Constructor Summary | |
---|---|
PluginDescriptor()
|
Method Summary | |
---|---|
File |
getBaseDir()
Get the base directory of the plugin. |
String |
getDescription()
Get the description of the plugin. |
PluginExtension |
getExtension(String key)
Get the extension corresponding to the specified key. |
String |
getExtensionShortcut(String key)
Get the extension corresponding to the specified key. |
String |
getName()
Gets the name of the plugin. |
String |
getVendor()
Get the vendor of the plugin. |
String |
getVersion()
Get the version of the plugin. |
void |
putExtension(String key,
PluginExtension extension)
Put an extension corresponding to the specified key. |
void |
putExtensionShortcut(String key,
String shortcutKey)
Put an extension corresponding to the specified key. |
void |
setBaseDir(File baseDir)
Set the base dir of the plugin. |
void |
setDescription(String description)
Set the description of the plugin. |
void |
setName(String name)
Set the name of the plugin. |
void |
setVendor(String vendor)
Set the vendor of the plugin. |
void |
setVersion(String version)
Set the version of the plugin. |
String |
toString()
The string representation of the plugin descriptor. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String SELECTION_PROCESSOR
public static final String GENERAL_EXTENSION
public static final String DOCUMENT_PROCESSOR
@Deprecated public static final String URL_STREAM_HANDLER
public static final String URL_HANDLER
public static final String URL_CHOOSER
public static final String URL_CHOOSER_TOOLBAR
public static final String COMPONENTS_VALIDATOR_EXTENSION
public static final String OPEN_REDIRECTOR
public static final String WORKSPACE_ACCESS
Constructor Detail |
---|
public PluginDescriptor()
Method Detail |
---|
public PluginExtension getExtension(String key)
Available extensions for the moment are: SELECTION_PROCESSOR & GENERAL_EXTENSION.
key
- The extension key.
public String getExtensionShortcut(String key)
Available extensions for the moment are: SELECTION_PROCESSOR & GENERAL_EXTENSION.
key
- The extension key.
public void putExtension(String key, PluginExtension extension)
key
- The extension key.extension
- The extension corresponding to the specified key.public void putExtensionShortcut(String key, String shortcutKey)
key
- The extension key.shortcutKey
- The shortcut key corresponding to the specified key.public String getDescription()
public void setDescription(String description)
description
- The description of the plugin.public String getName()
public void setName(String name)
name
- The name of the plugin.public String getVendor()
public void setVendor(String vendor)
vendor
- The vendor of the plugin.public String getVersion()
public void setVersion(String version)
version
- The version of the plugin.public File getBaseDir()
public void setBaseDir(File baseDir)
baseDir
- The base dir of the plugin.public String toString()
toString
in class Object
|
Oxygen XML Editor, Version ${standalone-version-number} | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |