ro.sync.exml.plugin
Class PluginDescriptor

java.lang.Object
  ro.sync.exml.plugin.PluginDescriptor

public class PluginDescriptor
extends java.lang.Object

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 java.lang.String	COMPONENTS_VALIDATOR_EXTENSION The startup extension.
static java.lang.String	DOCUMENT_PROCESSOR Document processor extension type.
static java.lang.String	GENERAL_EXTENSION General extension type.
static java.lang.String	GENERAL_STYLES_FILTER CSS Styles filter plugin type.
static java.lang.String	LOCK_HANDLER_FACTORY A lock handler factory.
static java.lang.String	OPEN_REDIRECTOR Open redirector plugin type.
static java.lang.String	SELECTION_PROCESSOR Selection processor extension type.
static java.lang.String	TARGETED_URL_HANDLER Targeted URL stream handler extension type.
static java.lang.String	URL_CHOOSER URL stream handler extension type.
static java.lang.String	URL_CHOOSER_TOOLBAR URL stream handler extension type.
static java.lang.String	URL_HANDLER URL stream handler extension type.
static java.lang.String	URL_STREAM_HANDLER Deprecated.
static java.lang.String	WORKSPACE_ACCESS Workspace access plugin type.

Constructor Summary

PluginDescriptor()

Method Summary

void	addPluginContributedToolbar(PluginContributedToolbar toolbarInfo) Add a toolbar.
void	addPluginContributedView(PluginContributedView viewInfo) Add a contributed view
java.io.File	getBaseDir() Get the base directory of the plugin.
java.util.List<PluginContributedToolbar>	getContributedToolbars() Gets the toolbars contributed by this plugin.
java.util.List<PluginContributedView>	getContributedViews()
java.lang.String	getDescription() Get the description of the plugin.
PluginExtension	getExtension(java.lang.String key) Get the extension corresponding to the specified key.
java.lang.String	getExtensionShortcut(java.lang.String key) Get the extension corresponding to the specified key.
java.lang.String	getID()
java.lang.String	getName() Gets the name of the plugin.
java.lang.String	getVendor() Get the vendor of the plugin.
java.lang.String	getVersion() Get the version of the plugin.
void	putExtension(java.lang.String key, PluginExtension extension) Put an extension corresponding to the specified key.
void	putExtensionShortcut(java.lang.String key, java.lang.String shortcutKey) Put an extension corresponding to the specified key.
void	setBaseDir(java.io.File baseDir) Set the base dir of the plugin.
void	setDescription(java.lang.String description) Set the description of the plugin.
void	setID(java.lang.String id) Sets the ID of the plugin.
void	setName(java.lang.String name) Set the name of the plugin.
void	setVendor(java.lang.String vendor) Set the vendor of the plugin.
void	setVersion(java.lang.String version) Set the version of the plugin.
java.lang.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

SELECTION_PROCESSOR

public static final java.lang.String SELECTION_PROCESSOR

Selection processor extension type.

See Also:

Constant Field Values

GENERAL_EXTENSION

public static final java.lang.String GENERAL_EXTENSION

General extension type.

See Also:

Constant Field Values

DOCUMENT_PROCESSOR

public static final java.lang.String DOCUMENT_PROCESSOR

Document processor extension type.

See Also:

Constant Field Values

URL_STREAM_HANDLER

@Deprecated
public static final java.lang.String URL_STREAM_HANDLER

Deprecated.

URL stream handler extension type.

See Also:

Constant Field Values

URL_HANDLER

public static final java.lang.String URL_HANDLER

URL stream handler extension type.

See Also:

Constant Field Values

TARGETED_URL_HANDLER

public static final java.lang.String TARGETED_URL_HANDLER

Targeted URL stream handler extension type.

See Also:

Constant Field Values

URL_CHOOSER

public static final java.lang.String URL_CHOOSER

URL stream handler extension type.

See Also:

Constant Field Values

URL_CHOOSER_TOOLBAR

public static final java.lang.String URL_CHOOSER_TOOLBAR

URL stream handler extension type.

See Also:

Constant Field Values

COMPONENTS_VALIDATOR_EXTENSION

public static final java.lang.String COMPONENTS_VALIDATOR_EXTENSION

The startup extension.

See Also:

Constant Field Values

OPEN_REDIRECTOR

public static final java.lang.String OPEN_REDIRECTOR

Open redirector plugin type.

See Also:

Constant Field Values

WORKSPACE_ACCESS

public static final java.lang.String WORKSPACE_ACCESS

Workspace access plugin type.

See Also:

Constant Field Values

GENERAL_STYLES_FILTER

public static final java.lang.String GENERAL_STYLES_FILTER

CSS Styles filter plugin type. This filter will be used to filter CSS styles for any document presented in author mode.

See Also:

Constant Field Values

LOCK_HANDLER_FACTORY

public static final java.lang.String LOCK_HANDLER_FACTORY

A lock handler factory.

See Also:

Constant Field Values

Constructor Detail

PluginDescriptor

public PluginDescriptor()

Method Detail

getExtension

public PluginExtension getExtension(java.lang.String key)

Get the extension corresponding to the specified key.

Available extensions for the moment are: SELECTION_PROCESSOR & GENERAL_EXTENSION.

Parameters:

key - The extension key.

Returns:

The extension corresponding to the specified key.

getExtensionShortcut

public java.lang.String getExtensionShortcut(java.lang.String key)

Get the extension corresponding to the specified key.

Available extensions for the moment are: SELECTION_PROCESSOR & GENERAL_EXTENSION.

Parameters:

key - The extension key.

Returns:

The shortcut key corresponding to the specified extension type key.

putExtension

public void putExtension(java.lang.String key,
                         PluginExtension extension)

Put an extension corresponding to the specified key. Avaible extensions for the moment are: SELECTION_PROCESSOR & GENERAL_EXTENSION.

Parameters:

key - The extension key.

extension - The extension corresponding to the specified key.

putExtensionShortcut

public void putExtensionShortcut(java.lang.String key,
                                 java.lang.String shortcutKey)

Put an extension corresponding to the specified key. Avaible extensions for the moment are: SELECTION_PROCESSOR & GENERAL_EXTENSION.

Parameters:

key - The extension key.

shortcutKey - The shortcut key corresponding to the specified key.

getDescription

public java.lang.String getDescription()

Get the description of the plugin.

Returns:

The description of the plugin.

setDescription

public void setDescription(java.lang.String description)

Set the description of the plugin.

Parameters:

description - The description of the plugin.

getName

public java.lang.String getName()

Gets the name of the plugin.

Returns:

The name of the plugin.

setName

public void setName(java.lang.String name)

Set the name of the plugin.

Parameters:

name - The name of the plugin.

setID

public void setID(java.lang.String id)

Sets the ID of the plugin. Empty string is treated as no ID.

Parameters:

id - ID of the plugin.

getID

public java.lang.String getID()

Returns:

Returns the id of the plugin or null if the plugin doesn't have an ID.

getVendor

public java.lang.String getVendor()

Get the vendor of the plugin.

Returns:

The vendor name.

setVendor

public void setVendor(java.lang.String vendor)

Set the vendor of the plugin.

Parameters:

vendor - The vendor of the plugin.

getVersion

public java.lang.String getVersion()

Get the version of the plugin.

Returns:

The plugin version.

setVersion

public void setVersion(java.lang.String version)

Set the version of the plugin.

Parameters:

version - The version of the plugin.

getBaseDir

public java.io.File getBaseDir()

Get the base directory of the plugin.

Returns:

The plugin base directory.

setBaseDir

public void setBaseDir(java.io.File baseDir)

Set the base dir of the plugin.

Parameters:

baseDir - The base dir of the plugin.

addPluginContributedView

public void addPluginContributedView(PluginContributedView viewInfo)

Add a contributed view

Parameters:

viewInfo - Information about the view

getContributedViews

public java.util.List<PluginContributedView> getContributedViews()

Returns:

Returns the contributedViews.

addPluginContributedToolbar

public void addPluginContributedToolbar(PluginContributedToolbar toolbarInfo)

Add a toolbar.

Parameters:

toolbarInfo - Information about the new toolbar.

getContributedToolbars

public java.util.List<PluginContributedToolbar> getContributedToolbars()

Gets the toolbars contributed by this plugin.

Returns:

The list of contributed toolbars.

toString

public java.lang.String toString()

The string representation of the plugin descriptor.

Overrides:

toString in class java.lang.Object

Returns:

The string representation.