install4j API

com.install4j.api.beaninfo
Class ActionBeanInfo

java.lang.Object
  extended by java.beans.SimpleBeanInfo
      extended by com.install4j.api.beaninfo.Install4JBeanInfo
          extended by com.install4j.api.beaninfo.ActionBeanInfo
All Implemented Interfaces:
java.beans.BeanInfo

public abstract class ActionBeanInfo
extends Install4JBeanInfo

Base class for BeanInfos of actions classes.

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
static java.lang.String ATTRIBUTE_ASSOCIATED_CONFIRMATION
           
static java.lang.String ATTRIBUTE_ASSOCIATED_CONFIRMATION_INIT_SCRIPT
           
static java.lang.String ATTRIBUTE_ASSOCIATED_CONFIRMATION_VISIBILITY_SCRIPT
           
static java.lang.String ATTRIBUTE_ASSOCIATED_SCREEN
           
static java.lang.String ATTRIBUTE_ASSOCIATED_STARTUP_ACTION
           
static java.lang.String ATTRIBUTE_COMPLEMENTARY_STARTUP_LINK
           
static java.lang.String ATTRIBUTE_DEFAULT_ERROR_MESSAGE
           
static java.lang.String ATTRIBUTE_DEFAULT_FAILURE_STRATEGY
           
static java.lang.String ATTRIBUTE_FULL_PRIVILEGES_REQUIRED
           
static java.lang.String ATTRIBUTE_INSTALLER_TARGET_SCREEN
           
static java.lang.String ATTRIBUTE_UNINSTALLER_TARGET_SCREEN
           
static java.lang.String STARTUP_SEQUENCE
          Special identified for the startup sequence to be used as the className argument in setInstallerTargetScreen(String) and setUninstallerTargetScreen(String).
 
Fields inherited from class com.install4j.api.beaninfo.Install4JBeanInfo
ATTRIBUTE_BEAN_CATEGORY, ATTRIBUTE_BEAN_INITIALIZER, ATTRIBUTE_BEAN_VALIDATOR, ATTRIBUTE_CATEGORY_SORT_ORDER, ATTRIBUTE_COLLAPSED_PROPERTY_CATEGORIES, ATTRIBUTE_CUSTOMIZER_ICON, ATTRIBUTE_CUSTOMIZER_PLACEMENT, ATTRIBUTE_DEFAULT_CONDITION_EXPRESSION, ATTRIBUTE_DEFAULT_ROLLBACK_BARRIER, ATTRIBUTE_ENUMERATION_MAPPERS, ATTRIBUTE_ICON_16x16, ATTRIBUTE_ICON_24x24, ATTRIBUTE_INSTALLED_FILES_REQUIRED, ATTRIBUTE_MINIMUM_JAVA_VERSION, ATTRIBUTE_MULTIPLE_INSTANCES_SUPPORTED, ATTRIBUTE_NOTICE_PANEL, ATTRIBUTE_PERSISTENCE_DELEGATE_MAP, ATTRIBUTE_PROPERTY_CONVERTERS, ATTRIBUTE_SEQUENCE_VALIDATOR, ATTRIBUTE_SORT_KEY
 
Fields inherited from interface java.beans.BeanInfo
ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32
 
Constructor Summary
protected ActionBeanInfo(java.lang.String displayName, java.lang.String shortDescription, java.lang.String category, boolean multipleInstancesSupported, boolean installedFilesRequired, java.lang.Integer sortKey, java.lang.Class beanClass)
          Same as ActionBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class) with a customizer class of null.
protected ActionBeanInfo(java.lang.String displayName, java.lang.String shortDescription, java.lang.String category, boolean multipleInstancesSupported, boolean installedFilesRequired, java.lang.Integer sortKey, java.lang.Class beanClass, java.lang.Class customizerClass)
          Same as Install4JBeanInfo.Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class)
 
Method Summary
 void setAssociatedConfirmation(java.lang.String confirmationDescription, java.lang.String initScript)
          Deprecated.  
 void setAssociatedConfirmation(java.lang.String confirmationDescription, java.lang.String initScript, java.lang.String visibilityScript)
          Configures an associated confirmation.
 void setAssociatedScreen(java.lang.String className)
          Configures an associated screen.
 void setAssociatedStartupAction(java.lang.String className)
          Configures an associated startup action.
 void setComplementaryStartupLink(boolean complementaryStartupLink)
          Determines if a complementary startup link should be placed in the installer or uninstaller.
 void setDefaultErrorMessage(java.lang.String errorMessage)
          Configures the default error message for the action.
 void setDefaultFailureStrategy(FailureStrategy failureStrategy)
          Configures the default failure strategy for the action.
 void setFullPrivilegesRequired(boolean fullPrivilegesRequired)
          Configures if full privileges are required or not.
 void setInstallerTargetScreen(java.lang.String className)
          Configures a target screen for the installer.
 void setUninstallerTargetScreen(java.lang.String className)
          Configures a target screen for the uninstaller.
 
Methods inherited from class com.install4j.api.beaninfo.Install4JBeanInfo
addPropertyDescriptor, checkNotEmpty, checkNotEmpty, findPropertyDescriptor, getBeanClass, getBeanDescriptor, getPropertyDescriptors, getPropertyValue, getPropertyValue, isEmpty, setBeanInitializer, setBeanValidator, setCategorySortOrder, setCollapsedPropertyCategories, setCustomizerIcon, setCustomizerPlacement, setDefaultConditionExpression, setDefaultRollbackBarrier, setEnumerationMappers, setIcons, setMinimumJavaVersion, setNoticePanel, setPersistenceDelegateMap, setPropertyConverters, setSequenceValidator
 
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 Detail

ATTRIBUTE_ASSOCIATED_CONFIRMATION

public static final java.lang.String ATTRIBUTE_ASSOCIATED_CONFIRMATION
See Also:
setAssociatedConfirmation(String, String, String), Constant Field Values

ATTRIBUTE_ASSOCIATED_CONFIRMATION_INIT_SCRIPT

public static final java.lang.String ATTRIBUTE_ASSOCIATED_CONFIRMATION_INIT_SCRIPT
See Also:
setAssociatedConfirmation(String, String, String), Constant Field Values

ATTRIBUTE_ASSOCIATED_CONFIRMATION_VISIBILITY_SCRIPT

public static final java.lang.String ATTRIBUTE_ASSOCIATED_CONFIRMATION_VISIBILITY_SCRIPT
See Also:
setAssociatedConfirmation(String, String, String), Constant Field Values

ATTRIBUTE_ASSOCIATED_SCREEN

public static final java.lang.String ATTRIBUTE_ASSOCIATED_SCREEN
See Also:
setAssociatedScreen(String), Constant Field Values

ATTRIBUTE_INSTALLER_TARGET_SCREEN

public static final java.lang.String ATTRIBUTE_INSTALLER_TARGET_SCREEN
See Also:
setInstallerTargetScreen(String), Constant Field Values

ATTRIBUTE_UNINSTALLER_TARGET_SCREEN

public static final java.lang.String ATTRIBUTE_UNINSTALLER_TARGET_SCREEN
See Also:
setUninstallerTargetScreen(String), Constant Field Values

ATTRIBUTE_COMPLEMENTARY_STARTUP_LINK

public static java.lang.String ATTRIBUTE_COMPLEMENTARY_STARTUP_LINK
See Also:
setComplementaryStartupLink(boolean)

ATTRIBUTE_ASSOCIATED_STARTUP_ACTION

public static final java.lang.String ATTRIBUTE_ASSOCIATED_STARTUP_ACTION
See Also:
setAssociatedStartupAction(String), Constant Field Values

ATTRIBUTE_DEFAULT_FAILURE_STRATEGY

public static final java.lang.String ATTRIBUTE_DEFAULT_FAILURE_STRATEGY
See Also:
setDefaultFailureStrategy(FailureStrategy), Constant Field Values

ATTRIBUTE_DEFAULT_ERROR_MESSAGE

public static final java.lang.String ATTRIBUTE_DEFAULT_ERROR_MESSAGE
See Also:
setDefaultErrorMessage(String), Constant Field Values

ATTRIBUTE_FULL_PRIVILEGES_REQUIRED

public static final java.lang.String ATTRIBUTE_FULL_PRIVILEGES_REQUIRED
See Also:
setFullPrivilegesRequired(boolean), Constant Field Values

STARTUP_SEQUENCE

public static final java.lang.String STARTUP_SEQUENCE
Special identified for the startup sequence to be used as the className argument in setInstallerTargetScreen(String) and setUninstallerTargetScreen(String).

See Also:
Constant Field Values
Constructor Detail

ActionBeanInfo

protected ActionBeanInfo(java.lang.String displayName,
                         java.lang.String shortDescription,
                         java.lang.String category,
                         boolean multipleInstancesSupported,
                         boolean installedFilesRequired,
                         java.lang.Integer sortKey,
                         java.lang.Class beanClass,
                         java.lang.Class customizerClass)
Same as Install4JBeanInfo.Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class)


ActionBeanInfo

protected ActionBeanInfo(java.lang.String displayName,
                         java.lang.String shortDescription,
                         java.lang.String category,
                         boolean multipleInstancesSupported,
                         boolean installedFilesRequired,
                         java.lang.Integer sortKey,
                         java.lang.Class beanClass)
Same as ActionBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class) with a customizer class of null.

Method Detail

setAssociatedConfirmation

public void setAssociatedConfirmation(java.lang.String confirmationDescription,
                                      java.lang.String initScript)
Deprecated. 

Kept for backwards compatibility

See Also:
setAssociatedConfirmation(String, String, String)

setAssociatedConfirmation

public void setAssociatedConfirmation(java.lang.String confirmationDescription,
                                      java.lang.String initScript,
                                      java.lang.String visibilityScript)
Configures an associated confirmation. If the user adds the action, the install4j GUI will ask the user whether to add a question to the associated screen, if the screen is a form screen or to the "Additional confirmation" screen otherwise. The form screen will receive a check box form component with a variable name equal to the simple class name of the action. The condition expression of the action will be set to context.getBooleanVariable("variableName") so that the confirmation and the execution of the action are automatically wired together.

If the initScript parameter is not null and the user accepts the addition of the confirmation, the "Initialization script" property of the check box form component is set to initScript.

Parameters:
confirmationDescription - the message of the confirmation
initScript - the init script, may be null @see #ATTRIBUTE_ASSOCIATED_CONFIRMATION
visibilityScript - the visibility script, may be null @see #ATTRIBUTE_ASSOCIATED_CONFIRMATION
See Also:
ATTRIBUTE_ASSOCIATED_CONFIRMATION_INIT_SCRIPT

setAssociatedScreen

public void setAssociatedScreen(java.lang.String className)
Configures an associated screen. If set, and the user adds the action, the install4j GUI checks if an instance of the specified class is present in the list of configured screens. If not, it will ask the user whether to add such a screen.

Parameters:
className - the class name of the associated screen
See Also:
ATTRIBUTE_ASSOCIATED_SCREEN

setInstallerTargetScreen

public void setInstallerTargetScreen(java.lang.String className)
Configures a target screen for the installer. If set, and the user adds the action, the install4j GUI checks if the current screen is an instance of the specified class. If not, it will ask the user whether the action should rather be added to the target screen, adding that screen if it is not present in the list of configured screens.

Parameters:
className - the class name of the target screen or STARTUP_SEQUENCE for the startup sequence
See Also:
ATTRIBUTE_INSTALLER_TARGET_SCREEN

setUninstallerTargetScreen

public void setUninstallerTargetScreen(java.lang.String className)
Configures a target screen for the uninstaller. If set, and the user adds the action, the install4j GUI checks if the current screen is an instance of the specified class. If not, it will ask the user whether the action should rather be added to the target screen, adding that screen if it is not present in the list of configured screens.

Parameters:
className - the class name of the target screen or STARTUP_SEQUENCE for the startup sequence
See Also:
ATTRIBUTE_UNINSTALLER_TARGET_SCREEN

setComplementaryStartupLink

public void setComplementaryStartupLink(boolean complementaryStartupLink)
Determines if a complementary startup link should be placed in the installer or uninstaller. If the action is added to the startup sequence of the installer, the user will be asked whether a link to the action should be placed in the startup sequence of the uninstaller or vice versa. This setting has no effect if the action is added to any other screen.

Parameters:
complementaryStartupLink - the value
See Also:
ATTRIBUTE_COMPLEMENTARY_STARTUP_LINK

setAssociatedStartupAction

public void setAssociatedStartupAction(java.lang.String className)
Configures an associated startup action. If set, and the user adds the action, the install4j GUI checks if the startup sequence contains an action of the specified class. If not, it will ask the user whether the action of that class should be added to the startup sequence.

Parameters:
className - the class name of the associated startup action
See Also:
ATTRIBUTE_ASSOCIATED_STARTUP_ACTION

setDefaultFailureStrategy

public void setDefaultFailureStrategy(FailureStrategy failureStrategy)
Configures the default failure strategy for the action.

Parameters:
failureStrategy - the default failure strategy
See Also:
ATTRIBUTE_DEFAULT_FAILURE_STRATEGY

setDefaultErrorMessage

public void setDefaultErrorMessage(java.lang.String errorMessage)
Configures the default error message for the action.

Parameters:
errorMessage - the default error message
See Also:
ATTRIBUTE_DEFAULT_ERROR_MESSAGE

setFullPrivilegesRequired

public void setFullPrivilegesRequired(boolean fullPrivilegesRequired)
Configures if full privileges are required or not. If this method is called with the argument true, the install4j IDE will ask the user if all the failure properties of the "Request privileges" action in the startup sequence should be selected. If that action does not exist, it will be created.

Parameters:
fullPrivilegesRequired - the value

install4j API