org.carewebframework.shell.plugins

Class PluginController

java.lang.Object

org.carewebframework.ui.controller.FrameworkController

org.carewebframework.shell.plugins.PluginController

All Implemented Interfaces:

IPluginController, IPluginEvent, org.fujion.ancillary.IAutoWired

public class PluginController
extends FrameworkController
implements IPluginController, IPluginEvent

Base controller for plugins. Offers convenience methods for determining activation state, accessing the plugin plugin, and managing background threads.

Field Summary

Fields inherited from class org.carewebframework.ui.controller.FrameworkController

root

Constructor Summary

Constructors

Constructor and Description
PluginController()

Method Summary

Modifier and Type	Method and Description
void	afterInitialized(org.fujion.component.BaseComponent comp) Wire controller from toolbar components first, then from plugin.
void	attachController(org.fujion.component.BaseComponent comp, org.fujion.ancillary.IAutoWired controller) Attaches a controller to the specified component and registers any recognized listeners to the plugin.
ElementPlugin	getPlugin()
boolean	isActive()
void	onActivate() Fired when the plugin is activated in the UI
void	onInactivate() Fired when the plugin is inactivated in the UI
void	onLoad(ElementPlugin plugin) Fired when the plugin is first loaded
void	onUnload() Fired when the plugin is unloaded
protected org.carewebframework.api.thread.IAbortable	removeThread(org.carewebframework.api.thread.IAbortable thread) Remove a thread from the active list.
void	showBusy(String message) Displays/clears a busy message.

Methods inherited from class org.carewebframework.ui.controller.FrameworkController

abortBackgroundThread, abortBackgroundThreads, addThread, cleanup, getAppContext, getAppFramework, getController, getController, getController, getEventManager, hasActiveThreads, initialize, onRefresh, refresh, startBackgroundThread, threadAborted, threadFinished

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginController

public PluginController()

Method Detail

afterInitialized

public void afterInitialized(org.fujion.component.BaseComponent comp)

Wire controller from toolbar components first, then from plugin.

Specified by:

afterInitialized in interface org.fujion.ancillary.IAutoWired

Overrides:

afterInitialized in class FrameworkController

showBusy

public void showBusy(String message)

Displays/clears a busy message.

Parameters:

message - The message.

onLoad

public void onLoad(ElementPlugin plugin)

Description copied from interface: IPluginEvent

Fired when the plugin is first loaded

Specified by:

onLoad in interface IPluginEvent

Parameters:

plugin - The plugin.

onActivate

public void onActivate()

Description copied from interface: IPluginEvent

Fired when the plugin is activated in the UI

Specified by:

onActivate in interface IPluginEvent

onInactivate

public void onInactivate()

Description copied from interface: IPluginEvent

Fired when the plugin is inactivated in the UI

Specified by:

onInactivate in interface IPluginEvent

onUnload

public void onUnload()

Description copied from interface: IPluginEvent

Fired when the plugin is unloaded

Specified by:

onUnload in interface IPluginEvent

isActive

public boolean isActive()

attachController

public void attachController(org.fujion.component.BaseComponent comp,
                             org.fujion.ancillary.IAutoWired controller)

Attaches a controller to the specified component and registers any recognized listeners to the plugin.

Parameters:

comp - Target component.

controller - Controller to attach.

getPlugin

public ElementPlugin getPlugin()

removeThread

protected org.carewebframework.api.thread.IAbortable removeThread(org.carewebframework.api.thread.IAbortable thread)

Remove a thread from the active list. Clears the busy state if this was the last active thread.

Overrides:

removeThread in class FrameworkController

Parameters:

thread - Thread to remove.

Returns:

The thread that was removed.