com.sun.rave.designtime
Class BasicBeanCreateInfo

java.lang.Object

  com.sun.rave.designtime.BasicBeanCreateInfo

All Implemented Interfaces:

BeanCreateInfo, DisplayItem

Direct Known Subclasses:

BasicBeanCreateInfoSet

public class BasicBeanCreateInfo

extends java.lang.Object

implements BeanCreateInfo

A basic implementation of BeanCreateInfo to use for convenience.

Version:

1.0

Author:

Joe Nuxoll

See Also:

BeanCreateInfo

Field Summary

protected java.lang.String	beanClassName
protected java.lang.String	description
protected java.lang.String	displayName
protected java.awt.Image	largeIcon
protected java.awt.Image	smallIcon

Constructor Summary

BasicBeanCreateInfo()

BasicBeanCreateInfo(java.lang.String beanClassName)

BasicBeanCreateInfo(java.lang.String beanClassName, java.awt.Image smallIcon)

BasicBeanCreateInfo(java.lang.String beanClassName, java.lang.String displayName)

BasicBeanCreateInfo(java.lang.String beanClassName, java.lang.String displayName, java.awt.Image smallIcon)

BasicBeanCreateInfo(java.lang.String beanClassName, java.lang.String displayName, java.lang.String description)

Method Summary

Result	beanCreatedSetup(DesignBean designBean) A hook that gets called after this JavaBean gets created initially.
java.lang.String	getBeanClassName() Returns the class name of the new JavaBean to create when this BeanCreateInfo is invoked in a visual designer.
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.
void	setBeanClassName(java.lang.String beanClassName)
void	setDescription(java.lang.String description)
void	setDisplayName(java.lang.String displayName)
void	setLargeIcon(java.awt.Image largeIcon)
void	setSmallIcon(java.awt.Image smallIcon)

Methods inherited from class java.lang.Object

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

Field Detail

beanClassName

protected java.lang.String beanClassName

description

protected java.lang.String description

displayName

protected java.lang.String displayName

largeIcon

protected java.awt.Image largeIcon

smallIcon

protected java.awt.Image smallIcon

Constructor Detail

BasicBeanCreateInfo

public BasicBeanCreateInfo()

BasicBeanCreateInfo

public BasicBeanCreateInfo(java.lang.String beanClassName)

BasicBeanCreateInfo

public BasicBeanCreateInfo(java.lang.String beanClassName,
                           java.awt.Image smallIcon)

BasicBeanCreateInfo

public BasicBeanCreateInfo(java.lang.String beanClassName,
                           java.lang.String displayName)

BasicBeanCreateInfo

public BasicBeanCreateInfo(java.lang.String beanClassName,
                           java.lang.String displayName,
                           java.awt.Image smallIcon)

BasicBeanCreateInfo

public BasicBeanCreateInfo(java.lang.String beanClassName,
                           java.lang.String displayName,
                           java.lang.String description)

Method Detail

beanCreatedSetup

public Result beanCreatedSetup(DesignBean designBean)

Description copied from interface: BeanCreateInfo

A hook that gets called after this JavaBean gets created initially. This is useful for a component author to setup an initial state for their JavaBean when it is first created. Note that this method is only called one time after the JavaBeans are initially created from the palette. This is *not* a hook that is called each time the project is reopened.

NOTE: If the specified bean has an associated DesignInfo class - it will have "first crack" at modifying the initial state of the bean. This method will be called after the DesignInfo one is called.

Specified by:

beanCreatedSetup in interface BeanCreateInfo

Returns:

A standard Result object, indicating success or failure - and optionally including messages for the user.

getBeanClassName

public java.lang.String getBeanClassName()

Description copied from interface: BeanCreateInfo

Returns the class name of the new JavaBean to create when this BeanCreateInfo is invoked in a visual designer.

Specified by:

getBeanClassName in interface BeanCreateInfo

Returns:

The String fully qualified class name for the JavaBean to create.

getDescription

public java.lang.String getDescription()

Description copied from interface: DisplayItem

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

Specified by:

getDescription in interface DisplayItem

Returns:

A String representing the description for this item.

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: DisplayItem

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.

Specified by:

getDisplayName in interface DisplayItem

Returns:

A String representing the display name for this item.

getHelpKey

public java.lang.String getHelpKey()

Description copied from interface: DisplayItem

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.

Specified by:

getHelpKey in interface DisplayItem

Returns:

A String representing the help key for this item.

getLargeIcon

public java.awt.Image getLargeIcon()

Description copied from interface: DisplayItem

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

Specified by:

getLargeIcon in interface DisplayItem

Returns:

An Image representing the large icon for this item.

getSmallIcon

public java.awt.Image getSmallIcon()

Description copied from interface: DisplayItem

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

Specified by:

getSmallIcon in interface DisplayItem

Returns:

An Image representing the large icon for this item.

setBeanClassName

public void setBeanClassName(java.lang.String beanClassName)

setDescription

public void setDescription(java.lang.String description)

setDisplayName

public void setDisplayName(java.lang.String displayName)

setLargeIcon

public void setLargeIcon(java.awt.Image largeIcon)

setSmallIcon

public void setSmallIcon(java.awt.Image smallIcon)