cfa.vo.iris
Class AbstractMenuItem

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

All Implemented Interfaces:

IMenuItem

Direct Known Subclasses:

AbstractDesktopItem, AbstractPluginMenuItem

public abstract class AbstractMenuItem
extends Object
implements IMenuItem

Author:

olaurino

Constructor Summary

AbstractMenuItem()

AbstractMenuItem(String title, String description, boolean isOnDesktop, IButton button)

AbstractMenuItem(String title, String description, boolean isOnDesktop, Icon icon, Icon thumbnail)

AbstractMenuItem(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.
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	setButton(IButton button)
void	setDescription(String description)
void	setIsOnDesktop(boolean isOnDesktop)
void	setTitle(String title)

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

AbstractMenuItem

public AbstractMenuItem()

AbstractMenuItem

public AbstractMenuItem(String title,
                        String description,
                        boolean isOnDesktop,
                        Icon icon,
                        Icon thumbnail)

AbstractMenuItem

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

AbstractMenuItem

public AbstractMenuItem(String title,
                        String description,
                        boolean isOnDesktop,
                        IButton button)

Method Detail

getTitle

public 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

Returns:

The title of the menu item

getDescription

public 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

Returns:

The description of this item

isOnDesktop

public boolean isOnDesktop()

Description copied from interface: IMenuItem

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

Specified by:

isOnDesktop in interface IMenuItem

Returns:

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

getButton

public IButton getButton()

Description copied from interface: IMenuItem

Graphical representation of the item.

Specified by:

getButton in interface IMenuItem

Returns:

an IButton instance representing the item.

setButton

public void setButton(IButton button)

setDescription

public void setDescription(String description)

setIsOnDesktop

public void setIsOnDesktop(boolean isOnDesktop)

setTitle

public void setTitle(String title)

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