public abstract class ActionBeanInfo extends Install4JBeanInfo
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.
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
Modifier | Constructor and Description |
---|---|
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<? extends Action> 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<? extends Action> beanClass,
java.lang.Class customizerClass)
|
Modifier and Type | Method and Description |
---|---|
void |
setActionListInitializer(ActionListInitializer actionListInitializer)
Configures an action list initializer.
|
void |
setActionValidator(ActionValidator actionValidator)
Configures an action validator.
|
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 |
setDefaultActionElevationType(ActionElevationType actionElevationType)
|
void |
setDefaultActionElevationType(ActionElevationType actionElevationType,
boolean restrict)
Configures in which elevation mode the action should run in elevated mode by default.
|
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 |
setDefaultMultiExec(boolean multiExec)
Configures the default value for the "Can be executed multiple times" property of 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 |
setUninstallerStartupAction(java.lang.String className)
Determines if a complementary startup action should be placed in the uninstaller.
|
void |
setUninstallerTargetScreen(java.lang.String className)
Configures a target screen for the uninstaller.
|
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
public static final java.lang.String ATTRIBUTE_ASSOCIATED_CONFIRMATION
public static final java.lang.String ATTRIBUTE_ASSOCIATED_CONFIRMATION_INIT_SCRIPT
public static final java.lang.String ATTRIBUTE_ASSOCIATED_CONFIRMATION_VISIBILITY_SCRIPT
public static final java.lang.String ATTRIBUTE_ASSOCIATED_SCREEN
setAssociatedScreen(String)
,
Constant Field Valuespublic static final java.lang.String ATTRIBUTE_INSTALLER_TARGET_SCREEN
public static final java.lang.String ATTRIBUTE_UNINSTALLER_TARGET_SCREEN
public static final java.lang.String ATTRIBUTE_DEFAULT_MULTI_EXEC
public static final java.lang.String ATTRIBUTE_COMPLEMENTARY_STARTUP_LINK
public static final java.lang.String ATTRIBUTE_UNINSTALLER_STARTUP_ACTION
public static final java.lang.String ATTRIBUTE_ASSOCIATED_STARTUP_ACTION
public static final java.lang.String ATTRIBUTE_DEFAULT_FAILURE_STRATEGY
public static final java.lang.String ATTRIBUTE_DEFAULT_ERROR_MESSAGE
public static final java.lang.String ATTRIBUTE_FULL_PRIVILEGES_REQUIRED
public static final java.lang.String ATTRIBUTE_DEFAULT_ACTION_ELEVATION_TYPE
public static final java.lang.String ATTRIBUTE_RESTRICT_ACTION_ELEVATION_TYPE
public static final java.lang.String STARTUP_SEQUENCE
className
argument
in setInstallerTargetScreen(String)
and setUninstallerTargetScreen(String)
.public static final java.lang.String ATTRIBUTE_ACTION_LIST_INITIALIZER
public static final java.lang.String ATTRIBUTE_ACTION_VALIDATOR
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<? extends Action> beanClass, java.lang.Class customizerClass)
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<? extends Action> beanClass)
ActionBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class)
with a customizer class of null
.@Deprecated public void setAssociatedConfirmation(java.lang.String confirmationDescription, java.lang.String initScript)
public void setAssociatedConfirmation(java.lang.String confirmationDescription, java.lang.String initScript, java.lang.String visibilityScript)
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
.
confirmationDescription
- the message of the confirmationinitScript
- the init script, may be null
@see #ATTRIBUTE_ASSOCIATED_CONFIRMATIONvisibilityScript
- the visibility script, may be null
@see #ATTRIBUTE_ASSOCIATED_CONFIRMATIONATTRIBUTE_ASSOCIATED_CONFIRMATION_INIT_SCRIPT
public void setAssociatedScreen(java.lang.String className)
className
- the class name of the associated screenATTRIBUTE_ASSOCIATED_SCREEN
public void setInstallerTargetScreen(java.lang.String className)
className
- the class name of the target screen or STARTUP_SEQUENCE
for the startup sequenceATTRIBUTE_INSTALLER_TARGET_SCREEN
public void setUninstallerTargetScreen(java.lang.String className)
className
- the class name of the target screen or STARTUP_SEQUENCE
for the startup sequenceATTRIBUTE_UNINSTALLER_TARGET_SCREEN
public void setDefaultMultiExec(boolean multiExec)
multiExec
- the default valueATTRIBUTE_DEFAULT_MULTI_EXEC
public void setComplementaryStartupLink(boolean complementaryStartupLink)
complementaryStartupLink
- the valueATTRIBUTE_COMPLEMENTARY_STARTUP_LINK
public void setAssociatedStartupAction(java.lang.String className)
className
- the class name of the associated startup actionATTRIBUTE_ASSOCIATED_STARTUP_ACTION
public void setUninstallerStartupAction(java.lang.String className)
className
- the class name of the complementary startup actionATTRIBUTE_UNINSTALLER_STARTUP_ACTION
public void setDefaultFailureStrategy(FailureStrategy failureStrategy)
failureStrategy
- the default failure strategyATTRIBUTE_DEFAULT_FAILURE_STRATEGY
public void setDefaultErrorMessage(java.lang.String errorMessage)
errorMessage
- the default error messageATTRIBUTE_DEFAULT_ERROR_MESSAGE
public void setFullPrivilegesRequired(boolean fullPrivilegesRequired)
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.
Note: Setting this property to true
automatically implies setDefaultActionElevationType(com.install4j.api.beaninfo.ActionElevationType)
}
set to ActionElevationType.ELEVATE
.
fullPrivilegesRequired
- the valuepublic void setDefaultActionElevationType(ActionElevationType actionElevationType)
actionElevationType
- the elevation typepublic void setDefaultActionElevationType(ActionElevationType actionElevationType, boolean restrict)
restrict
parameter is set to
false
, the user can always change the elevation type in the install4j IDE, otherwise the default
is fixed.actionElevationType
- the elevation typerestrict
- whether the default setting should be the only allowed settingpublic void setActionListInitializer(ActionListInitializer actionListInitializer)
actionListInitializer
- the bean initializer.ActionListInitializer
,
ATTRIBUTE_ACTION_LIST_INITIALIZER
public void setActionValidator(ActionValidator actionValidator)
actionValidator
- the action validator.ActionValidator
,
ATTRIBUTE_ACTION_VALIDATOR