cfa.vo.iris.sdk
Class AbstractPluginMenuItem

java.lang.Object
  cfa.vo.iris.AbstractMenuItem
      cfa.vo.iris.sdk.AbstractPluginMenuItem

All Implemented Interfaces:

IMenuItem

public abstract class AbstractPluginMenuItem
extends AbstractMenuItem

Author:

olaurino

Constructor Summary

AbstractPluginMenuItem()

AbstractPluginMenuItem(String title, String description, boolean isOnDesktop, String iconPath, String thumbnailPath)

Method Summary

void	consolidate(File file) In some cases (e.g.
IButton	getButton() Graphical representation of the item.
abstract String	getDescription() Tooltip text to be rendered on the menu bar or on the desktop for this menu item.
IrisPlugin	getPlugin()
abstract String	getTitle() String rendered on the menu bar or on the desktop for this menu item
void	setIconPath(String iconPath)
void	setPlugin(IrisPlugin plugin)
void	setThumbnailPath(String thumbnailPath)

Methods inherited from class cfa.vo.iris.AbstractMenuItem

isOnDesktop, setButton, setDescription, setIsOnDesktop, setTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface cfa.vo.iris.IMenuItem

onClick

Constructor Detail

AbstractPluginMenuItem

public AbstractPluginMenuItem()

AbstractPluginMenuItem

public AbstractPluginMenuItem(String title,
                              String description,
                              boolean isOnDesktop,
                              String iconPath,
                              String thumbnailPath)

Method Detail

getTitle

public abstract String getTitle()

Description copied from interface: IMenuItem

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

Specified by:

getTitle in interface IMenuItem

Overrides:

getTitle in class AbstractMenuItem

Returns:

The title of the menu item

getDescription

public abstract String getDescription()

Description copied from interface: IMenuItem

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

Specified by:

getDescription in interface IMenuItem

Overrides:

getDescription in class AbstractMenuItem

Returns:

The description of this item

setIconPath

public final void setIconPath(String iconPath)

setThumbnailPath

public final void setThumbnailPath(String thumbnailPath)

setPlugin

public void setPlugin(IrisPlugin plugin)

getPlugin

public IrisPlugin getPlugin()

getButton

public IButton getButton()

Description copied from interface: IMenuItem

Graphical representation of the item.

Specified by:

getButton in interface IMenuItem

Overrides:

getButton in class AbstractMenuItem

Returns:

an IButton instance representing the item.

consolidate

public void consolidate(File file)

Description copied from interface: IMenuItem

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

Specified by:

consolidate in interface IMenuItem

Overrides:

consolidate in class AbstractMenuItem