metadone.client.plugin.AbstractMetadonePlugin Class Reference

Inheritance diagram for metadone.client.plugin.AbstractMetadonePlugin:

Collaboration diagram for metadone.client.plugin.AbstractMetadonePlugin:

List of all members.

Public Member Functions
String	getName ()
JMenu	createMenu ()
final MetadoneEvents	getEventManager ()
final Workspace	getWorkspace ()
void	startUp (MetadoneEvents eventManager)
void	startUp (MetadoneEvents eventManager, Workspace workspace)
void	dispose ()
void	trigger (WorkspaceChanged event)
Private Attributes
MetadoneEvents	eTower
Workspace	workspace
final Subscription < WorkspaceChanged, AbstractMetadonePlugin >	workspaceSubscription = new Subscription<WorkspaceChanged, AbstractMetadonePlugin>(this, WorkspaceChanged.class, null)

---

Detailed Description

An abstract implementation of a plugin.

The name of the plugin is the name of the class. Moreover this class keeps track of the current workspace and MetadoneEvents.

Author:

kma

---

Member Function Documentation

JMenu metadone.client.plugin.AbstractMetadonePlugin.createMenu

(

)

Creates a menu to show in the main window.

This method should be called from the swing thread.

Returns:

A new menu for this instance of the plugin or null

Implements metadone.client.plugin.MetadonePlugin.

Reimplemented in metadone.plugin.grasyla.generator.GrasylaGenerator, and metadone.plugin.helloworld.HelloPlugin.

References metadone.client.plugin.AbstractMetadonePlugin.getName().

void metadone.client.plugin.AbstractMetadonePlugin.dispose

(

)

Cleans up all the injections. This method should be called just before unloading the plugin.

Implements metadone.client.plugin.MetadonePlugin.

Reimplemented in metadone.plugin.helloworld.HelloPlugin.

References metadone.client.plugin.AbstractMetadonePlugin.eTower, metadone.client.plugin.AbstractMetadonePlugin.getWorkspace(), metadone.client.plugin.AbstractMetadonePlugin.trigger(), and metadone.client.plugin.AbstractMetadonePlugin.workspaceSubscription.

final MetadoneEvents metadone.client.plugin.AbstractMetadonePlugin.getEventManager

(

)

Returns an event tower associated with this plugin.

Returns:

An event tower

Implements metadone.client.plugin.MetadonePlugin.

References metadone.client.plugin.AbstractMetadonePlugin.eTower.

Referenced by metadone.plugin.helloworld.HelloPlugin.createMenu(), metadone.plugin.grasyla.generator.GrasylaGenerator.createMenu(), and metadone.plugin.helloworld.HelloPlugin.getActionFor().

String metadone.client.plugin.AbstractMetadonePlugin.getName

(

)

Gets the name of this plugin.

Returns:

The name of the plugin

Implements metadone.client.plugin.MetadonePlugin.

Referenced by metadone.plugin.helloworld.HelloPlugin.createMenu(), and metadone.client.plugin.AbstractMetadonePlugin.createMenu().

final Workspace metadone.client.plugin.AbstractMetadonePlugin.getWorkspace

(

)

Gets the known workspace.

Returns:

The workspace or null

References metadone.client.plugin.AbstractMetadonePlugin.workspace.

Referenced by metadone.client.plugin.AbstractMetadonePlugin.dispose().

void metadone.client.plugin.AbstractMetadonePlugin.startUp

(

MetadoneEvents

eventManager

)

Starts with just the event manager.

Parameters:

eventManager

The event manager

Reimplemented in metadone.plugin.helloworld.HelloPlugin.

References metadone.client.plugin.AbstractMetadonePlugin.eTower, and metadone.client.plugin.AbstractMetadonePlugin.workspaceSubscription.

Referenced by metadone.client.plugin.AbstractMetadonePlugin.startUp().

void metadone.client.plugin.AbstractMetadonePlugin.startUp	(	MetadoneEvents	eventManager,
		Workspace	workspace
	)

Called just before the plugin is used.

Parameters:

eventManager	The event manager
workspace	The current workspace or null

Implements metadone.client.plugin.MetadonePlugin.

References metadone.client.plugin.AbstractMetadonePlugin.startUp(), and metadone.client.plugin.AbstractMetadonePlugin.trigger().

void metadone.client.plugin.AbstractMetadonePlugin.trigger

(

WorkspaceChanged

event

)

Reimplemented in metadone.plugin.urn.URN.

References metadone.metabusiness.events.WorkspaceChanged.type, metadone.metabusiness.events.WorkspaceChanged.workspace, and metadone.client.plugin.AbstractMetadonePlugin.workspace.

Referenced by metadone.client.plugin.AbstractMetadonePlugin.dispose(), and metadone.client.plugin.AbstractMetadonePlugin.startUp().

---

Member Data Documentation

MetadoneEvents metadone.client.plugin.AbstractMetadonePlugin.eTower [private]

Referenced by metadone.client.plugin.AbstractMetadonePlugin.dispose(), metadone.client.plugin.AbstractMetadonePlugin.getEventManager(), and metadone.client.plugin.AbstractMetadonePlugin.startUp().

Workspace metadone.client.plugin.AbstractMetadonePlugin.workspace [private]

Referenced by metadone.client.plugin.AbstractMetadonePlugin.getWorkspace(), and metadone.client.plugin.AbstractMetadonePlugin.trigger().

final Subscription<WorkspaceChanged, AbstractMetadonePlugin> metadone.client.plugin.AbstractMetadonePlugin.workspaceSubscription = new Subscription<WorkspaceChanged, AbstractMetadonePlugin>(this, WorkspaceChanged.class, null) [private]

Referenced by metadone.client.plugin.AbstractMetadonePlugin.dispose(), and metadone.client.plugin.AbstractMetadonePlugin.startUp().

---

The documentation for this class was generated from the following file:

• metadone_bundle_client/src/metadone/client/plugin/AbstractMetadonePlugin.java