Package com.install4j.api.beaninfo

Class Install4JBeanInfo

java.lang.Object

java.beans.SimpleBeanInfo

com.install4j.api.beaninfo.Install4JBeanInfo

All Implemented Interfaces:

BeanInfo

Direct Known Subclasses:

ActionBeanInfo, FormComponentBeanInfo, ScreenBeanInfo

public abstract class Install4JBeanInfo
extends SimpleBeanInfo

Base class for bean infos. It is recommended to derive your bean info from one of the derived classes which are specific to screens, actions and form components.

Using this class is not strictly required. In principle, you could also set values for the ATTRIBUTE_* constants in the bean descriptor of an unrelated bean info class.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_BEAN_CATEGORY
static final String	ATTRIBUTE_BEAN_INITIALIZER
static final String	ATTRIBUTE_BEAN_VALIDATOR
static final String	ATTRIBUTE_CATEGORY_SORT_ORDER
static final String	ATTRIBUTE_COLLAPSED_PROPERTY_CATEGORIES
static final String	ATTRIBUTE_CUSTOMIZER_ICON
static final String	ATTRIBUTE_CUSTOMIZER_PLACEMENT
static final String	ATTRIBUTE_DEFAULT_CONDITION_EXPRESSION
static final String	ATTRIBUTE_DEFAULT_ROLLBACK_BARRIER
static final String	ATTRIBUTE_DEFAULT_ROLLBACK_BARRIER_EXIT_CODE
static final String	ATTRIBUTE_ENUMERATION_MAPPERS
static final String	ATTRIBUTE_ICON_16x16
static final String	ATTRIBUTE_ICON_24x24
static final String	ATTRIBUTE_INSTALLED_FILES_REQUIRED
static final String	ATTRIBUTE_MINIMUM_JAVA_VERSION
static final String	ATTRIBUTE_MULTIPLE_INSTANCES_SUPPORTED
static final String	ATTRIBUTE_NOTICE_PANEL
static final String	ATTRIBUTE_PERSISTENCE_DELEGATE_MAP
static final String	ATTRIBUTE_PROPERTY_CONVERTERS
static final String	ATTRIBUTE_SEQUENCE_VALIDATOR
static final String	ATTRIBUTE_SORT_KEY

Fields inherited from interface java.beans.BeanInfo

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Install4JBeanInfo(String displayName, String shortDescription, String category, boolean multipleInstancesSupported, boolean installedFilesRequired, Integer sortKey, Class<? extends Bean> beanClass)	Same as Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class) with a customizer class of null.
protected	Install4JBeanInfo(String displayName, String shortDescription, String category, boolean multipleInstancesSupported, boolean installedFilesRequired, Integer sortKey, Class<? extends Bean> beanClass, Class<?> customizerClass)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addPropertyDescriptor(Install4JPropertyDescriptor propertyDescriptor)	Add a property descriptor to be returned by getPropertyDescriptors.
void	checkNotEmpty(String propertyName, Bean bean)	Convenience method for bean validators to assert that a property is not empty.
void	checkNotEmpty(String propertyName, String errorMessage, Bean bean)	Convenience method for bean validators to assert that a property is not empty.
PropertyDescriptor	findPropertyDescriptor(String propertyName)	Convenience method for bean validators to find the property descriptor for a named property.
Class<?>	getBeanClass()	Convenience method to retrieve the bean class specified in the constructor.
BeanDescriptor	getBeanDescriptor()
PropertyDescriptor[]	getPropertyDescriptors()
Object	getPropertyValue(PropertyDescriptor propertyDescriptor, Bean bean)	Convenience method for bean validators to get the property value for a property descriptor.
Object	getPropertyValue(String propertyName, Bean bean)	Convenience method for bean validators to get the property value for a named property.
boolean	isEmpty(String propertyName, Bean bean)	Convenience method for bean validators to check if a property is empty.
void	setBeanInitializer(BeanInitializer beanInitializer)	Configures a bean initializer.
void	setBeanValidator(BeanValidator beanValidator)	Configures a bean validator.
void	setCategorySortOrder(String... categories)	Sets a sort order for property categories of this bean.
void	setCollapsedPropertyCategories(String[] collapsedCategories)	Specifies property categories that should be collapsed by default.
void	setCustomizerIcon(Icon customizerIcon)	Configures the icon of the customizer tab.
void	setCustomizerPlacement(CustomizerPlacement customizerPlacement)	Configures the placement of the customizer.
void	setDefaultConditionExpression(String defaultConditionExpression)	Configures the default value for the "Condition expression" property of the bean.
void	setDefaultRollbackBarrier(boolean defaultRollbackBarrier)	Configures if the action is a rollback barrier by default.
void	setDefaultRollbackBarrierExitCode(int defaultRollbackBarrierExitCode)	Configures the default rollback barrier exit code.
void	setEnumerationMappers(EnumerationMapper[] enumerationMappers)	Specifies enumeration mappers for properties of this bean.
void	setIcons(Icon icon16x16, Icon icon24x24)	Configures custom icons for the bean.
void	setMinimumJavaVersion(String minimumJavaVersion)	Sets the minimum Java version that this bean will work with.
void	setNoticePanel(JComponent noticePanel)	Sets a panel that is displayed a notice at the top of the configuration panel.
void	setPersistenceDelegateMap(Map<? extends Class,? extends PersistenceDelegate> persistenceDelegates)	Specifies persistence delegates for this bean.
void	setPropertyConverters(PropertyConverter[] propertyConverters)	Specifies property converters for properties of this bean.
void	setSequenceValidator(SequenceValidator sequenceValidator)	Configures a sequence validator.

Methods inherited from class java.beans.SimpleBeanInfo

getAdditionalBeanInfo, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getIcon, getMethodDescriptors, loadImage

Methods inherited from class java.lang.Object

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

Field Details

ATTRIBUTE_MINIMUM_JAVA_VERSION

public static final String ATTRIBUTE_MINIMUM_JAVA_VERSION

See Also:

• setMinimumJavaVersion(String)
• Constant Field Values

ATTRIBUTE_MULTIPLE_INSTANCES_SUPPORTED

public static final String ATTRIBUTE_MULTIPLE_INSTANCES_SUPPORTED

See Also:

• Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class)
• Constant Field Values

ATTRIBUTE_INSTALLED_FILES_REQUIRED

public static final String ATTRIBUTE_INSTALLED_FILES_REQUIRED

See Also:

• Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class)
• Constant Field Values

ATTRIBUTE_BEAN_CATEGORY

public static final String ATTRIBUTE_BEAN_CATEGORY

See Also:

• Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class)
• Constant Field Values

ATTRIBUTE_COLLAPSED_PROPERTY_CATEGORIES

public static final String ATTRIBUTE_COLLAPSED_PROPERTY_CATEGORIES

See Also:

• setCollapsedPropertyCategories(String[])
• Constant Field Values

ATTRIBUTE_ENUMERATION_MAPPERS

public static final String ATTRIBUTE_ENUMERATION_MAPPERS

See Also:

• setEnumerationMappers(EnumerationMapper[])
• Constant Field Values

ATTRIBUTE_PROPERTY_CONVERTERS

public static final String ATTRIBUTE_PROPERTY_CONVERTERS

See Also:

• setPropertyConverters(PropertyConverter[])
• Constant Field Values

ATTRIBUTE_PERSISTENCE_DELEGATE_MAP

public static final String ATTRIBUTE_PERSISTENCE_DELEGATE_MAP

See Also:

• setPersistenceDelegateMap(Map)
• Constant Field Values

ATTRIBUTE_CUSTOMIZER_PLACEMENT

public static final String ATTRIBUTE_CUSTOMIZER_PLACEMENT

See Also:

• setCustomizerPlacement(CustomizerPlacement)
• Constant Field Values

ATTRIBUTE_CUSTOMIZER_ICON

public static final String ATTRIBUTE_CUSTOMIZER_ICON

See Also:

• setCustomizerIcon(Icon)
• Constant Field Values

ATTRIBUTE_BEAN_VALIDATOR

public static final String ATTRIBUTE_BEAN_VALIDATOR

See Also:

• setBeanValidator(BeanValidator)
• Constant Field Values

ATTRIBUTE_BEAN_INITIALIZER

public static final String ATTRIBUTE_BEAN_INITIALIZER

See Also:

• setBeanInitializer(BeanInitializer)
• Constant Field Values

ATTRIBUTE_SORT_KEY

public static final String ATTRIBUTE_SORT_KEY

See Also:

• Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class)
• Constant Field Values

ATTRIBUTE_SEQUENCE_VALIDATOR

public static final String ATTRIBUTE_SEQUENCE_VALIDATOR

See Also:

• setSequenceValidator(SequenceValidator)
• Constant Field Values

ATTRIBUTE_DEFAULT_ROLLBACK_BARRIER

public static final String ATTRIBUTE_DEFAULT_ROLLBACK_BARRIER

See Also:

• setDefaultRollbackBarrier(boolean)
• Constant Field Values

ATTRIBUTE_DEFAULT_ROLLBACK_BARRIER_EXIT_CODE

public static final String ATTRIBUTE_DEFAULT_ROLLBACK_BARRIER_EXIT_CODE

See Also:

• setDefaultRollbackBarrierExitCode(int)
• Constant Field Values

ATTRIBUTE_DEFAULT_CONDITION_EXPRESSION

public static final String ATTRIBUTE_DEFAULT_CONDITION_EXPRESSION

See Also:

• setDefaultConditionExpression(String)
• Constant Field Values

ATTRIBUTE_ICON_16x16

public static final String ATTRIBUTE_ICON_16x16

See Also:

• setIcons(Icon, Icon)
• Constant Field Values

ATTRIBUTE_ICON_24x24

public static final String ATTRIBUTE_ICON_24x24

See Also:

• setIcons(Icon, Icon)
• Constant Field Values

ATTRIBUTE_NOTICE_PANEL

public static final String ATTRIBUTE_NOTICE_PANEL

See Also:

• setNoticePanel(JComponent)
• Constant Field Values

ATTRIBUTE_CATEGORY_SORT_ORDER

public static final String ATTRIBUTE_CATEGORY_SORT_ORDER

See Also:

• setCategorySortOrder(String[])
• Constant Field Values

Constructor Details

Install4JBeanInfo

protected Install4JBeanInfo(String displayName,
 String shortDescription,
 String category,
 boolean multipleInstancesSupported,
 boolean installedFilesRequired,
 Integer sortKey,
 Class<? extends Bean> beanClass,
 Class<?> customizerClass)

Constructor.

Customizers must descend from javax.swing.JComponent. Their name property (settable with JComponent#setName(String)) will be displayed as the tab name next to the default "Properties" tab. You can add multiple tabs if your customizer descends from javax.swing.JTabbedPane. In that case, all its tabs are extracted and added next to the default "Properties" tab and any icons that are set for the single tabs will be also be used in the install4j IDE. If you have properties whose values are exclusively used by the customizer, you can give them an empty display name so that they will not show up in the default "Properties" tab. Additional services for the customizer are available with a CustomizerCallback, the default placement of the customizer can be controlled with setCustomizerPlacement(CustomizerPlacement).

Parameters:

displayName - the display name for the bean. This name will be displayed in the list of configured beans as well as in the bean registry dialog.

shortDescription - a short description that will be displayed in the bean registry dialog in HTML format. You do not have to start the description with <html>, it will be prepended automatically.

category - the bean category. This determines the node in the bean registry dialog where the bean will be added. If null the bean will be added at the top level.

multipleInstancesSupported - if multiple instances of this bean are supported

installedFilesRequired - if this bean requires installed files or not. In the installer, this means that this bean must be placed after the "Install files" action, in the uninstaller this means that this bean must be placed before the "Uninstall files" action.

sortKey - a string that will be use for determining the sort order in the bean registry dialog and the default insertion point in the list of configured beans.

beanClass - the class name of the bean

customizerClass - the customizer class or null if no customizer is available.

See Also:

• ATTRIBUTE_BEAN_CATEGORY
• ATTRIBUTE_MULTIPLE_INSTANCES_SUPPORTED
• ATTRIBUTE_INSTALLED_FILES_REQUIRED
• ATTRIBUTE_SORT_KEY
• CustomizerCallback

Install4JBeanInfo

protected Install4JBeanInfo(String displayName,
 String shortDescription,
 String category,
 boolean multipleInstancesSupported,
 boolean installedFilesRequired,
 Integer sortKey,
 Class<? extends Bean> beanClass)

Same as Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class) with a customizer class of null.

Method Details

addPropertyDescriptor

public void addPropertyDescriptor(Install4JPropertyDescriptor propertyDescriptor)

Add a property descriptor to be returned by getPropertyDescriptors.

Parameters:

propertyDescriptor - the property descriptor

getPropertyDescriptors

public PropertyDescriptor[] getPropertyDescriptors()

Specified by:

getPropertyDescriptors in interface BeanInfo

Overrides:

getPropertyDescriptors in class SimpleBeanInfo

getBeanDescriptor

public BeanDescriptor getBeanDescriptor()

Specified by:

getBeanDescriptor in interface BeanInfo

Overrides:

getBeanDescriptor in class SimpleBeanInfo

setIcons

public void setIcons(Icon icon16x16,
 Icon icon24x24)

Configures custom icons for the bean. The 16x16 icon will be displayed in the bean registry dialog, the 24x24 icon will be displayed in the list of configured beans.

Parameters:

icon16x16 - the 16x16 icon

icon24x24 - the 32x32 icon

See Also:

• ATTRIBUTE_ICON_16x16
• ATTRIBUTE_ICON_24x24

setMinimumJavaVersion

public void setMinimumJavaVersion(String minimumJavaVersion)

Sets the minimum Java version that this bean will work with. If the minimum Java version for the project is less that this version, the bean cannot be added and an error message is displayed.

Parameters:

minimumJavaVersion - the minimum Java version

See Also:

• ATTRIBUTE_MINIMUM_JAVA_VERSION

setCollapsedPropertyCategories

public void setCollapsedPropertyCategories(String[] collapsedCategories)

Specifies property categories that should be collapsed by default.

Parameters:

collapsedCategories - an array with the collapsed categories

See Also:

• Install4JPropertyDescriptor.setPropertyCategory(String)
• ATTRIBUTE_COLLAPSED_PROPERTY_CATEGORIES

setEnumerationMappers

public void setEnumerationMappers(EnumerationMapper[] enumerationMappers)

Specifies enumeration mappers for properties of this bean.

Parameters:

enumerationMappers - an array with the enumeration mappers

See Also:

• EnumerationMapper
• ATTRIBUTE_ENUMERATION_MAPPERS

setPropertyConverters

public void setPropertyConverters(PropertyConverter[] propertyConverters)

Specifies property converters for properties of this bean.

Parameters:

propertyConverters - an array with the property converters

See Also:

• PropertyConverter
• ATTRIBUTE_PROPERTY_CONVERTERS

setPersistenceDelegateMap

public void setPersistenceDelegateMap(Map<? extends Class,? extends PersistenceDelegate> persistenceDelegates)

Specifies persistence delegates for this bean. The keys must be of class java.lang.Class and the values of class java.beans.PersistenceDelegate. See http://java.sun.com/products/jfc/tsc/articles/persistence4/ for more information on persistence delegates.

Parameters:

persistenceDelegates - the java.lang.Class -> java.beans.PersistenceDelegate map

See Also:

• ATTRIBUTE_PERSISTENCE_DELEGATE_MAP

setCustomizerPlacement

public void setCustomizerPlacement(CustomizerPlacement customizerPlacement)

Configures the placement of the customizer.

Parameters:

customizerPlacement - the customizer placement

See Also:

• Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class)
• ATTRIBUTE_CUSTOMIZER_PLACEMENT

setCustomizerIcon

public void setCustomizerIcon(Icon customizerIcon)

Configures the icon of the customizer tab.

Parameters:

customizerIcon - the icon for the customizer tab

See Also:

• ATTRIBUTE_CUSTOMIZER_ICON

setBeanValidator

public void setBeanValidator(BeanValidator beanValidator)

Configures a bean validator.

Parameters:

beanValidator - the bean validator

See Also:

• BeanValidator
• ATTRIBUTE_BEAN_VALIDATOR

setBeanInitializer

public void setBeanInitializer(BeanInitializer beanInitializer)

Configures a bean initializer.

Parameters:

beanInitializer - the bean initializer.

See Also:

• BeanInitializer
• ATTRIBUTE_BEAN_INITIALIZER

setSequenceValidator

public void setSequenceValidator(SequenceValidator sequenceValidator)

Configures a sequence validator.

Parameters:

sequenceValidator - the sequence validator.

See Also:

• SequenceValidator
• ATTRIBUTE_SEQUENCE_VALIDATOR

setDefaultRollbackBarrier

public void setDefaultRollbackBarrier(boolean defaultRollbackBarrier)

Configures if the action is a rollback barrier by default.

Parameters:

defaultRollbackBarrier - the default rollback barrier flag

See Also:

• ATTRIBUTE_DEFAULT_ROLLBACK_BARRIER

setDefaultRollbackBarrierExitCode

public void setDefaultRollbackBarrierExitCode(int defaultRollbackBarrierExitCode)

Configures the default rollback barrier exit code. Only has an effect if the "Rollback barrier" property is selected by the user.

Parameters:

defaultRollbackBarrierExitCode - the default rollback barrier type

See Also:

• ATTRIBUTE_DEFAULT_ROLLBACK_BARRIER_EXIT_CODE

setDefaultConditionExpression

public void setDefaultConditionExpression(String defaultConditionExpression)

Configures the default value for the "Condition expression" property of the bean.

Parameters:

defaultConditionExpression - the default value

See Also:

• ATTRIBUTE_DEFAULT_CONDITION_EXPRESSION

setNoticePanel

public void setNoticePanel(JComponent noticePanel)

Sets a panel that is displayed a notice at the top of the configuration panel. This panel cannot be used for configuring the bean.

Parameters:

noticePanel - the panel

setCategorySortOrder

public void setCategorySortOrder(String... categories)

Sets a sort order for property categories of this bean. By default, property categories are sorted alphabetically. You can change the sort order for the categories that are passed to this method. Any categories that are not present in this sort order will still be sorted alphabetically and will be shown at the top of the property tree.

Parameters:

categories - an array with all categories that should be sorted in the order that the categories should appear in the install4j IDE

getBeanClass

public Class<?> getBeanClass()

Convenience method to retrieve the bean class specified in the constructor.

Returns:

the bean class

checkNotEmpty

public void checkNotEmpty(String propertyName,
 Bean bean)
                   throws BeanValidationException

Convenience method for bean validators to assert that a property is not empty. A BeanValidationException with an appropriate message is thrown if the property is empty.

Parameters:

propertyName - the name of the property that should be checked

bean - the bean whose property should be checked

Throws:

BeanValidationException - if the specified property is empty

See Also:

• isEmpty(String, Bean)
• BeanValidator

checkNotEmpty

public void checkNotEmpty(String propertyName,
 String errorMessage,
 Bean bean)
                   throws BeanValidationException

Convenience method for bean validators to assert that a property is not empty. A BeanValidationException with the specified error message is thrown if the property is empty.

Parameters:

propertyName - the name of the property that should be checked

errorMessage - the error message

bean - the bean whose property should be checked

Throws:

BeanValidationException - if the specified property is empty

See Also:

• isEmpty(String, Bean)
• BeanValidator

isEmpty

public boolean isEmpty(String propertyName,
 Bean bean)

Convenience method for bean validators to check if a property is empty.

Parameters:

propertyName - the name of the property that should be checked

bean - the bean whose property should be checked

Returns:

true or false.

getPropertyValue

public Object getPropertyValue(PropertyDescriptor propertyDescriptor,
 Bean bean)

Convenience method for bean validators to get the property value for a property descriptor.

Parameters:

propertyDescriptor - the property descriptor for which the value should be returned

bean - the bean for which the value should be returned

Returns:

the property value or null if the property cannot be found

getPropertyValue

public Object getPropertyValue(String propertyName,
 Bean bean)

Convenience method for bean validators to get the property value for a named property.

Parameters:

propertyName - the name of the property for which the value should be returned

bean - the bean for which the value should be returned

Returns:

the property value or null if the property cannot be found

findPropertyDescriptor

public PropertyDescriptor findPropertyDescriptor(String propertyName)

Convenience method for bean validators to find the property descriptor for a named property.

Parameters:

propertyName - the name of the property for which the property descriptor should be returned

Returns:

the property descriptor