cfa.vo.iris
Interface IMenuItem

All Known Implementing Classes:

AbstractDesktopItem, AbstractMenuItem, AbstractPluginMenuItem

public interface IMenuItem

Interface describing the menu items contributed by a component.

Author:

olaurino

Method Summary

void	consolidate(File file) In some cases (e.g.
IButton	getButton() Graphical representation of the item.
String	getDescription() Tooltip text to be rendered on the menu bar or on the desktop for this menu item.
String	getTitle() String rendered on the menu bar or on the desktop for this menu item
boolean	isOnDesktop() The value returned by this method determines whether or not a desktop button is created for this item.
void	onClick() Callback that get invoked when the item is selected by the user.

Method Detail

getTitle

String getTitle()

String rendered on the menu bar or on the desktop for this menu item

Returns:

The title of the menu item

getDescription

String getDescription()

Tooltip text to be rendered on the menu bar or on the desktop for this menu item.

Returns:

The description of this item

onClick

void onClick()

Callback that get invoked when the item is selected by the user.

isOnDesktop

boolean isOnDesktop()

The value returned by this method determines whether or not a desktop button is created for this item.

Returns:

True if the item has to be rendered as a desktop button.

getButton

IButton getButton()

Graphical representation of the item.

Returns:

an IButton instance representing the item.

consolidate

void consolidate(File file)

In some cases (e.g. Plugins) the item has to be consolidated before it can be actually used