com.sun.rave.designtime
Interface DisplayItem

All Known Subinterfaces:

BeanCreateInfo, BeanCreateInfoSet, CheckedDisplayAction, Customizer2, DesignContext, DisplayAction, DisplayActionSet, FacesDesignContext, IdeProject, MarkupDesignContext, MarkupMouseRegion

All Known Implementing Classes:

BasicBeanCreateInfo, BasicBeanCreateInfoSet, BasicCheckedDisplayAction, BasicCustomizer2, BasicDisplayAction, BasicDisplayActionSet, BasicMarkupMouseRegion, ResultMessage

public interface DisplayItem

The DisplayItem interface describes the basic information needed to display an action in a menu or a button. Several interfaces in Creator Design-Time API extend this one to provide a basic name, description, icon, etc.

IMPLEMENTED BY THE COMPONENT AUTHOR - This interface is designed to be implemented by the component (bean) author. There are several Basic* classes that implement this interface for you.

Version:

1.0

Author:

Joe Nuxoll

Method Summary

java.lang.String	getDescription() Returns a description for this item.
java.lang.String	getDisplayName() Returns a display name for this item.
java.lang.String	getHelpKey() Returns the help key for this item.
java.awt.Image	getLargeIcon() Returns a large image icon for this item.
java.awt.Image	getSmallIcon() Returns a small image icon for this item.

Method Detail

getDescription

public java.lang.String getDescription()

Returns a description for this item. This will be used as a tooltip in a menu or on a button, depending on the subinterface.

Returns:

A String representing the description for this item.

getDisplayName

public java.lang.String getDisplayName()

Returns a display name for this item. This will be used to show in a menu or as a button label, depending on the subinterface.

Returns:

A String representing the display name for this item.

getHelpKey

public java.lang.String getHelpKey()

Returns the help key for this item. This is usually a key used to look up a help context item in an online help facility.

Returns:

A String representing the help key for this item.

getLargeIcon

public java.awt.Image getLargeIcon()

Returns a large image icon for this item. Generally "large" means 32x32 pixels.

Returns:

An Image representing the large icon for this item.

getSmallIcon

public java.awt.Image getSmallIcon()

Returns a small image icon for this item. Generally "small" means 16x16 pixels.

Returns:

An Image representing the large icon for this item.