cfa.vo.iris
Interface IrisComponent

All Known Subinterfaces:

IrisActionGuiComponent, IrisFrameGuiComponent, IrisGuiComponent

All Known Implementing Classes:

AbstractIrisComponent, PluginManager

public interface IrisComponent

Interface implemented by Iris components. By implementing this interface the components allow the framework to retrieve the information needed to run and initialize them.

Author:

olaurino

Method Summary

ICommandLineInterface	getCli() Get a command line interface object for this component.
String	getDescription() Get e description for this component.
List<IMenuItem>	getMenus() The component can contribute menu items and desktop buttons to the enclosing GUI applications by providing a list of MenuItems.
String	getName() Return the name of this component.
List<org.astrogrid.samp.client.MessageHandler>	getSampHandlers() The component can register any number of SAMP message listeners by providing a list of them.
void	init(IrisApplication app, IWorkspace workspace) This method is invoked to initialize the component.
void	initCli(IrisApplication app) Initialize the Command Line Application interface
void	shutdown() Callback invoked when the component is shutdown

Method Detail

init

void init(IrisApplication app,
          IWorkspace workspace)

This method is invoked to initialize the component. If the component has to launch windows, frames or background services, this is the right method to do so. Otherwise the component will be called only if a callback is invoked.

Parameters:

app - A reference to the running application

workspace - A reference to the application's workspace

getName

String getName()

Return the name of this component. This name might be listed in a widget along with the other registered components.

Returns:

The component's name as a String.

getDescription

String getDescription()

Get e description for this component. The description might be listed in a widget along with the other registered components.

Returns:

The component's description as a String.

getCli

ICommandLineInterface getCli()

Get a command line interface object for this component.

Returns:

A CLI object

initCli

void initCli(IrisApplication app)

Initialize the Command Line Application interface

Parameters:

app - Reference to the enclosing application

getMenus

List<IMenuItem> getMenus()

The component can contribute menu items and desktop buttons to the enclosing GUI applications by providing a list of MenuItems.

Returns:

A list of the menu items this component will contribute to the application.

getSampHandlers

List<org.astrogrid.samp.client.MessageHandler> getSampHandlers()

The component can register any number of SAMP message listeners by providing a list of them.

Returns:

A list of the SAMP message listeners that have to be registered to the SAMP hub.

shutdown

void shutdown()

Callback invoked when the component is shutdown