install4j API
A B C D E F G H I J K L M N O P Q R S T U V W

A

AbstractBean - Class in com.install4j.api.beans
Common base class for all abstract super-classes for beans that are handled by install4j.
AbstractBean() - Constructor for class com.install4j.api.beans.AbstractBean
 
AbstractFormComponent - Class in com.install4j.api.formcomponents
Abstract base class for form components.
AbstractFormComponent() - Constructor for class com.install4j.api.formcomponents.AbstractFormComponent
 
AbstractInstallAction - Class in com.install4j.api.actions
Abstract base class for install actions.
AbstractInstallAction() - Constructor for class com.install4j.api.actions.AbstractInstallAction
 
AbstractInstallerOrUninstallerScreen - Class in com.install4j.api.screens
Abstract base class for screens that can be used in the installer or uninstaller.
AbstractInstallerOrUninstallerScreen() - Constructor for class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
AbstractInstallerScreen - Class in com.install4j.api.screens
Abstract base class for installer screens.
AbstractInstallerScreen() - Constructor for class com.install4j.api.screens.AbstractInstallerScreen
 
AbstractInstallOrUninstallAction - Class in com.install4j.api.actions
Abstract base class for actions that can be used for installation or uninstallation.
AbstractInstallOrUninstallAction() - Constructor for class com.install4j.api.actions.AbstractInstallOrUninstallAction
 
AbstractUninstallAction - Class in com.install4j.api.actions
Abstract base class for uninstall actions.
AbstractUninstallAction() - Constructor for class com.install4j.api.actions.AbstractUninstallAction
 
AbstractUninstallerScreen - Class in com.install4j.api.screens
Abstract base class for uninstaller screens.
AbstractUninstallerScreen() - Constructor for class com.install4j.api.screens.AbstractUninstallerScreen
 
Action - Interface in com.install4j.api.actions
The base interface for all actions.
ActionBeanInfo - Class in com.install4j.api.beaninfo
Base class for bean infos of actions classes.
ActionBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class) - Constructor for class com.install4j.api.beaninfo.ActionBeanInfo
Same as Install4JBeanInfo.Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class)
ActionBeanInfo(String, String, String, boolean, boolean, Integer, Class) - Constructor for class com.install4j.api.beaninfo.ActionBeanInfo
Same as ActionBeanInfo.ActionBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class) with a customizer class of null.
activated() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
activated() - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
activated() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
activated() - Method in interface com.install4j.api.screens.Screen
Called by the framework just after the screen has been activated.
addDesignTimeChangeListener(ChangeListener) - Method in interface com.install4j.api.formcomponents.FormEnvironment
If your form component would like to be notified when the list of form components changes at design time, you can add a change listener here.
addInstallerEventListener(InstallerEventListener) - Method in interface com.install4j.api.context.Context
Add a listener to receive installer events.
addPropertyDescriptor(Install4JPropertyDescriptor) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Add a property descriptor to be returned by getPropertyDescriptors.
AFTER_EXECUTE_ACTION - Static variable in class com.install4j.api.events.EventType
Fired after an action has been executed
AFTER_INSTALL_FILE - Static variable in class com.install4j.api.events.EventType
Fired after a file has been installed.
AFTER_PROPERTIES - Static variable in class com.install4j.api.beaninfo.CustomizerPlacement
Place the customizer before the default "Properties" tab.
AFTER_ROLLBACK_ACTION - Static variable in class com.install4j.api.events.EventType
Fired after a rollback is performed
ALWAYS - Static variable in class com.install4j.api.context.OverwriteMode
Indicates that if the destination file exists it will be replaced in any case.
ALWAYS - Static variable in class com.install4j.api.context.UninstallMode
Indicates that the uninstaller will always delete this file.
ALWAYS_ASK - Static variable in class com.install4j.api.context.OverwriteMode
Indicates that the user will be asked whether to replace the file even if it was installed by a previous run of the installer.
ALWAYS_ASK_EXCEPT_FOR_UPDATE - Static variable in class com.install4j.api.context.OverwriteMode
Indicates that if the destination file exists and has not been installed by a previous run of the installer the user will be asked whether to replace the file.
ALWAYS_BUT_NOT_FOR_UPDATE - Static variable in class com.install4j.api.context.UninstallMode
Indicates that the destination file won't be deleted when the uninstaller runs as part of an update.
APPDATA - Static variable in class com.install4j.api.windows.SpecialFolder
Identifies the file system directory that serves as a common repository for application-specific data.
appendToPath(String) - Static method in class com.install4j.api.windows.WinEnvVars
Appends one or more directories to the PATH environment variable.
appendToUserPath(String) - Static method in class com.install4j.api.windows.WinEnvVars
Appends one or more directories to the user-specific PATH environment variable on Windows NT/2000/XP/Vista.
ApplicationRegistry - Class in com.install4j.api
The class provides information about applications installed with install4j.
ApplicationRegistry() - Constructor for class com.install4j.api.ApplicationRegistry
 
ApplicationRegistry.ApplicationInfo - Interface in com.install4j.api
Provides information about an application installed by install4j.
ASK_USER - Static variable in class com.install4j.api.beaninfo.FailureStrategy
Ask the user wheter to continue or to quit.
askContinue(File) - Method in interface com.install4j.api.context.ProgressInterface
Asks the user whether to continue after the specified file could not be installed.
askMultipleSelection(String, String[], String[], int[], boolean) - Method in interface com.install4j.api.screens.Console
Ask the user to select multiple elements from a list of options.
askOkCancel(String) - Method in interface com.install4j.api.screens.Console
Ask the user a question that has to be answered with "OK" or "Cancel".
askOkCancel(String, boolean) - Method in interface com.install4j.api.screens.Console
Ask the user a question that has to be answered with "OK" or "Cancel".
askOption(String, String[], String[]) - Method in interface com.install4j.api.screens.Console
Ask the user a question with a fixed set of answers.
askOption(String, String[], String[], int) - Method in interface com.install4j.api.screens.Console
Ask the user a question with a fixed set of answers.
askOption(String, String[], String[], int, boolean, boolean) - Method in interface com.install4j.api.screens.Console
Ask the user a question with a fixed set of answers.
askOverwrite(File) - Method in interface com.install4j.api.context.ProgressInterface
Asks the user whether the specified file should be overwritten.
askRetry(File) - Method in interface com.install4j.api.context.ProgressInterface
Asks the user whether the installer should retry to overwrite the specified file.
askString(String, String) - Method in interface com.install4j.api.screens.Console
Ask the user to enter a string with a default string that can be accepted by the user.
askYesNo(String) - Method in interface com.install4j.api.screens.Console
Ask the user a question that has to be answered with "Yes" or "No".
askYesNo(String, boolean) - Method in interface com.install4j.api.screens.Console
Ask the user a question that has to be answered with "Yes" or "No".
ATTRIBUTE_ASSOCIATED_ACTION - Static variable in class com.install4j.api.beaninfo.ScreenBeanInfo
 
ATTRIBUTE_ASSOCIATED_ACTION_TARGET_SCREEN - Static variable in class com.install4j.api.beaninfo.ScreenBeanInfo
 
ATTRIBUTE_ASSOCIATED_CONFIRMATION - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
ATTRIBUTE_ASSOCIATED_CONFIRMATION_INIT_SCRIPT - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
ATTRIBUTE_ASSOCIATED_SCREEN - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
ATTRIBUTE_ASSOCIATED_STARTUP_ACTION - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
ATTRIBUTE_ASSOCIATED_STARTUP_ACTION_INSTALLER_AND_UNINSTALLER - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
ATTRIBUTE_BEAN_CATEGORY - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_BEAN_INITIALIZER - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_BEAN_VALIDATOR - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_COLLAPSED_PROPERTY_CATEGORIES - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_CONTEXT - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
 
ATTRIBUTE_CUSTOMIZER_PLACEMENT - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_DEFAULT_CONDITION_EXPRESSION - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_DEFAULT_ERROR_MESSAGE - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
ATTRIBUTE_DEFAULT_FAILURE_STRATEGY - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
ATTRIBUTE_DEFAULT_QUIT_AFTER_SCREEN - Static variable in class com.install4j.api.beaninfo.ScreenBeanInfo
 
ATTRIBUTE_DEFAULT_ROLLBACK_BARRIER - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_ENUMERATION_MAPPERS - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_FILTER_NAME - Static variable in class com.install4j.api.beaninfo.FilePropertyDescriptor
 
ATTRIBUTE_FORM_COMPONENT_CUSTOMIZER_PLACEMENT - Static variable in class com.install4j.api.beaninfo.ScreenBeanInfo
 
ATTRIBUTE_ICON_16x16 - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_ICON_24x24 - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_INSTALLED_FILES_REQUIRED - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_INSTALLER_TARGET_SCREEN - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
ATTRIBUTE_MINIMUM_JAVA_VERSION - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_MULTIPLE_INSTANCES_SUPPORTED - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_PERSISTENCE_DELEGATE_MAP - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_PROPERTY_CATEGORY - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
 
ATTRIBUTE_RETURN_TYPE - Static variable in class com.install4j.api.beaninfo.ScriptPropertyDescriptor
 
ATTRIBUTE_SCRIPT_PARAMETERS - Static variable in class com.install4j.api.beaninfo.ScriptPropertyDescriptor
 
ATTRIBUTE_SELECTION_MODE - Static variable in class com.install4j.api.beaninfo.FilePropertyDescriptor
 
ATTRIBUTE_SEQUENCE_VALIDATOR - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_SORT_KEY - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_SORT_KEY - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
 
ATTRIBUTE_SUFFIXES - Static variable in class com.install4j.api.beaninfo.FilePropertyDescriptor
 
ATTRIBUTE_UNINSTALLER_TARGET_SCREEN - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
AutoUninstallAction - Interface in com.install4j.api.actions
If you write an install action that wants to be automatically invoked in the uninstaller to revert its changes, you can additionally implement this interface.

B

Bean - Interface in com.install4j.api.beans
Common interface for all types of beans that are handled by install4j.
BeanInitializer - Interface in com.install4j.api.beaninfo
Interface for the Install4JBeanInfo.ATTRIBUTE_BEAN_INITIALIZER value of a bean descriptor.
BeanValidationException - Exception in com.install4j.api.beaninfo
Exception for notifying the user that a property value of a bean is not valid.
BeanValidationException(String) - Constructor for exception com.install4j.api.beaninfo.BeanValidationException
Constructor with an error message.
BeanValidationException(String, String) - Constructor for exception com.install4j.api.beaninfo.BeanValidationException
Constructor with an error message and a property name.
BeanValidator - Interface in com.install4j.api.beaninfo
Interface for the Install4JBeanInfo.ATTRIBUTE_BEAN_VALIDATOR value of a bean descriptor.
BEFORE_EXECUTE_ACTION - Static variable in class com.install4j.api.events.EventType
Fired before an action is executed
BEFORE_INSTALL_FILE - Static variable in class com.install4j.api.events.EventType
Fired before a file is installed.
BEFORE_PROPERTIES - Static variable in class com.install4j.api.beaninfo.CustomizerPlacement
Place the customizer after the default "Properties" tab.
BEFORE_ROLLBACK_ACTION - Static variable in class com.install4j.api.events.EventType
Fired before a rollback is performed

C

cancel() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
cancel() - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
cancel() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
cancel() - Method in interface com.install4j.api.screens.Screen
Called when the user clicks the "Cancel" button for this screen.
CANCELED - Static variable in class com.install4j.api.events.EventType
Fired just before the installer or uninstaller quits after having been cancelled.
CANCELLING - Static variable in class com.install4j.api.events.EventType
Fired when the installer or uninstaller is cancelled but before any cleanup has been performed.
CATEGORY_CONFIGURATION - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Default category used by install4j.
checkApplicationId(File) - Static method in class com.install4j.api.ApplicationRegistry
Returns true if the application can be safely installed into the given directory.
checkCompleted() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
checkCompleted() - Method in interface com.install4j.api.formcomponents.FormComponent
This method is called by the framework when the user advances to the next screen in GUI or console mode.
checkNotEmpty(String, Bean) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Convenience method for bean validators to assert that a property is not empty.
checkNotEmpty(String, String, Bean) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Convenience method for bean validators to assert that a property is not empty.
com.install4j.api - package com.install4j.api
This package contains general utility classes for the install4j API.
com.install4j.api.actions - package com.install4j.api.actions
This package contains the interfaces and abstract base classes for actions.
com.install4j.api.beaninfo - package com.install4j.api.beaninfo
This package contains the utility classes for writing BeanInfo classes for screens, actions and form components.
com.install4j.api.beans - package com.install4j.api.beans
This package contains the base classes for all extension points in install4j as well as special property classes.
com.install4j.api.context - package com.install4j.api.context
This package contains classes that allow you to interact with the installer and its environment.
com.install4j.api.events - package com.install4j.api.events
This package contains classes that allow you to listen for events generated by the installer.
com.install4j.api.formcomponents - package com.install4j.api.formcomponents
This package contains the interface and abstract base class for form components.
com.install4j.api.launcher - package com.install4j.api.launcher
This package contains classes that your own application code can use to access runtime services provided by install4j.
com.install4j.api.screens - package com.install4j.api.screens
This package contains the interfaces and abstract base classes for screens.
com.install4j.api.unix - package com.install4j.api.unix
This package contains classes with static utility methods for using Unix-specific features that are not directly supported by the Java platform.
com.install4j.api.windows - package com.install4j.api.windows
This package contains classes with static utility methods for using Windows-specific features that are not directly supported by the Java platform.
ComponentTuple - Interface in com.install4j.api.formcomponents
Represents the created GUI components for a form component.
CONSOLE - Static variable in class com.install4j.api.context.LauncherType
Represents a console launcher.
Console - Interface in com.install4j.api.screens
A Console object allows you to display information to the user and request input when the installer or uninstaller is running in console mode.
Context - Interface in com.install4j.api.context
Base class for installation and uninstallation context.
CONTEXT_DATETIME - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Special context for properties of type java.util.Date that tells the install4j GUI to offer a time editor besides the default date editor as well.
CONTEXT_LAUNCHER_ID - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Special context for properties of type java.lang.String that tells the install4j GUI to treat the string value as the id of a launcher.
CONTEXT_MULTILINE - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Special context for properties of type java.lang.String that tells the install4j GUI to allow the user to enter multi-line strings in a separate dialog.
CONTEXT_NON_SERVICE_LAUNCHER_ID - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Same as Install4JPropertyDescriptor.CONTEXT_LAUNCHER_ID, but service launchers are not selectable.
CONTEXT_SERVICE_LAUNCHER_ID - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Same as Install4JPropertyDescriptor.CONTEXT_LAUNCHER_ID, but only service launchers are selectable.
CONTINUE - Static variable in class com.install4j.api.beaninfo.FailureStrategy
Continue after a failure.
create(String, Class, String, String, FileSelectionMode) - Static method in class com.install4j.api.beaninfo.FilePropertyDescriptor
Same as FilePropertyDescriptor.create(String, Class, String, String, FileSelectionMode, String[], String) with suffixes and filterName set to null.
create(String, Class, String, String, FileSelectionMode, String[], String) - Static method in class com.install4j.api.beaninfo.FilePropertyDescriptor
Create a file property descriptor as with Install4JPropertyDescriptor.create(String, Class, String, String) and additional configuration specific to file properties.
create(String, Class, String, String) - Static method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Same as Install4JPropertyDescriptor.create(String, Class, String, String, String) with a context of null.
create(String, Class, String, String, String) - Static method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Create a property descriptor that can be passed to Install4JBeanInfo.addPropertyDescriptor(Install4JPropertyDescriptor).
create(String, Class, String, String, Class, ScriptParameter[]) - Static method in class com.install4j.api.beaninfo.ScriptPropertyDescriptor
Create a file property descriptor as with Install4JPropertyDescriptor.create(String, Class, String, String) and additional configuration specific to script properties.
create(String, String, File, File) - Static method in class com.install4j.api.windows.WinAssociations
Creates a file assocation.
createCenterComponent() - Method in interface com.install4j.api.formcomponents.FormComponent
Create the main component in the center.
createComponent() - Method in interface com.install4j.api.screens.Screen
Return the visual component that is displayed for the screen.
createKey(RegistryRoot, String) - Static method in class com.install4j.api.windows.WinRegistry
Creates a registry key.
createLeftComponent() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
createLeftComponent() - Method in interface com.install4j.api.formcomponents.FormComponent
Create the leading component to the left of the center component.
createLink(String, File) - Static method in class com.install4j.api.unix.UnixFileSystem
Create a symbolic link on Unix.
createRightComponent() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
createRightComponent() - Method in interface com.install4j.api.formcomponents.FormComponent
Create the trailing component to the right of the center component.
createShellLink(File, File, File) - Static method in class com.install4j.api.windows.WinFileSystem
Creates a shell link.
createShellLink(File, File, File, String) - Static method in class com.install4j.api.windows.WinFileSystem
Creates a shell link.
createShellLink(File, File, File, String, String) - Static method in class com.install4j.api.windows.WinFileSystem
Creates a shell link.
createStartMenuEntry(String, String, File, boolean, File) - Static method in class com.install4j.api.windows.WinFileSystem
Creates a start menu entry.
CustomizerCallback - Interface in com.install4j.api.beaninfo
Extended design-time services for customizers.
CustomizerPlacement - Class in com.install4j.api.beaninfo
Enumeration class for all possible placements of the customizer in the install4j GUI.

D

deactivated() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
deactivated() - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
deactivated() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
deactivated() - Method in interface com.install4j.api.screens.Screen
Called by the framework just after the screen has been deactivated.
DEFAULT_CONTEXT - Static variable in interface com.install4j.api.beaninfo.EnumerationMapper
A default context that you can use in the getContext method if there is only one enumeration mapper for the property type returned by getEnumerationClass
DEFAULT_MODE - Static variable in class com.install4j.api.context.FileOptions
The default file mode on Unix and Mac OS X ("644").
deleteKey(RegistryRoot, String, boolean) - Static method in class com.install4j.api.windows.WinRegistry
Deletes a registry key.
deleteValue(RegistryRoot, String, String) - Static method in class com.install4j.api.windows.WinRegistry
Deletes a registry value.
DESKTOP - Static variable in class com.install4j.api.windows.SpecialFolder
Identifies the file system directory used to physically store file objects on the desktop.
DIRECTORIES_ONLY - Static variable in class com.install4j.api.beaninfo.FileSelectionMode
Only show directories in the file chooser.
DOCS - Static variable in class com.install4j.api.windows.SpecialFolder
Identifies the file system directory used to physically store a user's common repository of documents.
dumpVariables(Context) - Static method in class com.install4j.api.Util
Dump all defined installer variables to stderr.

E

EnumerationMapEntry - Class in com.install4j.api.beaninfo
Entry in an enumeration defined by EnumerationMapper.
EnumerationMapEntry(String, Object) - Constructor for class com.install4j.api.beaninfo.EnumerationMapEntry
Construct a map entry.
EnumerationMapper - Interface in com.install4j.api.beaninfo
Interface for mapping values and descriptions of enumerated properties.
equals(Object) - Method in class com.install4j.api.beans.ScriptProperty
 
EventType - Class in com.install4j.api.events
Enumeration class that represents all different event types for instances of InstallerEvent.
exists(String) - Static method in class com.install4j.api.windows.WinAssociations
Checks whether a file association already exists.
EXTERNAL - Static variable in class com.install4j.api.context.LauncherType
Represents an external launcher.
ExternalFile - Class in com.install4j.api.beans
Property type for files from outside the distribution tree to be used in beans.
ExternalFile(String) - Constructor for class com.install4j.api.beans.ExternalFile
The constructor will be invoked by the framework.

F

FailureStrategy - Class in com.install4j.api.beaninfo
Enumeration class for all possible failure strategies of actions.
fatalError(Throwable) - Static method in class com.install4j.api.Util
This method can be invoked if you encounter a non-recoverable and non-expected error in your custom code.
FAVORITES - Static variable in class com.install4j.api.windows.SpecialFolder
Identifies the file system directory that serves as a common repository for the user's favorite items.
FileInfo - Interface in com.install4j.api.context
Provides information about a file in the distribution tree.
FileOptions - Class in com.install4j.api.context
An object that contains options for the installation and uninstallation of a file.
FileOptions() - Constructor for class com.install4j.api.context.FileOptions
Initializes a FileOptions instance.
FileOptions(String, OverwriteMode, boolean) - Constructor for class com.install4j.api.context.FileOptions
Initializes a FileOptions instance.
FileOptions(long) - Constructor for class com.install4j.api.context.FileOptions
Initializes a FileOptions instance.
FileOptions(long, OverwriteMode) - Constructor for class com.install4j.api.context.FileOptions
Initializes a FileOptions instance.
FileOptions(long, String, OverwriteMode, boolean, UninstallMode) - Constructor for class com.install4j.api.context.FileOptions
Initializes a FileOptions instance.
FileOptions(OverwriteMode, UninstallMode) - Constructor for class com.install4j.api.context.FileOptions
Initializes a FileOptions instance.
FilePropertyDescriptor - Class in com.install4j.api.beaninfo
Property descriptor for properties of type java.io.File and com.install4j.api.beans.ExternalFile.
FILES_AND_DIRECTORIES - Static variable in class com.install4j.api.beaninfo.FileSelectionMode
Show both files and directories in the file chooser.
FILES_ONLY - Static variable in class com.install4j.api.beaninfo.FileSelectionMode
Only show files in the file chooser.
FileSelectionMode - Class in com.install4j.api.beaninfo
Enumeration class for all possible file selection modes for file property descriptors.
findPropertyDescriptor(String) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Convenience method for bean validators to find the property descriptor for a named property.
FINISHED - Static variable in class com.install4j.api.events.EventType
Fired just before the installer or uninstaller quits.
FINISHING - Static variable in class com.install4j.api.events.EventType
Fired when the installer or uninstaller quits but before any cleanup has been performed.
FONTS - Static variable in class com.install4j.api.windows.SpecialFolder
Identifies a virtual folder containing fonts.
formActivated() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
formActivated() - Method in interface com.install4j.api.formcomponents.FormComponent
This method is called by the framework just after the containing screen has been activated.
FormComponent - Interface in com.install4j.api.formcomponents
All form components must implement this interface.
FormComponentBeanInfo - Class in com.install4j.api.beaninfo
Base class for form component bean infos.
FormComponentBeanInfo(String, String, String, Integer, Class, Class) - Constructor for class com.install4j.api.beaninfo.FormComponentBeanInfo
Same as Install4JBeanInfo.Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class) with multipleInstancesSupported set to true and installedFilesRequired set to false.
FormComponentBeanInfo(String, String, String, Integer, Class) - Constructor for class com.install4j.api.beaninfo.FormComponentBeanInfo
Same as FormComponentBeanInfo.FormComponentBeanInfo(String, String, String, Integer, Class, Class) with a customizer class of null.
formDeactivated() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
formDeactivated() - Method in interface com.install4j.api.formcomponents.FormComponent
This method is called by the framework just after the containing screen has been deactivated.
FormEnvironment - Interface in com.install4j.api.formcomponents
The form environment gives access to form components in a form panel as well as to other design time or runtime services related to form components.
formWillActivate() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
formWillActivate() - Method in interface com.install4j.api.formcomponents.FormComponent
This method is called by the framework just before the containing screen will be activated.

G

getActions(Screen) - Method in interface com.install4j.api.context.Context
Get all registered actions for a specified screen.
getActions(Class, Screen) - Method in interface com.install4j.api.context.Context
Get all registered actions for a specified screen and a given action class.
getAddOnApplicationId() - Method in interface com.install4j.api.context.Context
Returns the add on application id if this project generates add-on installers.
getApplicationId() - Method in interface com.install4j.api.context.Context
Returns the application id of this project.
getApplicationInfoByDir(File) - Static method in class com.install4j.api.ApplicationRegistry
Checks if the specified directory contains an application installed by install4j and retrieves information about it.
getApplicationInfoById(String) - Static method in class com.install4j.api.ApplicationRegistry
Retrieves information about an application installed by install4j via its application id.
getBeanClass() - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Convenience method to retrieve the bean class specified in the constructor.
getBeanDescriptor() - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
 
getBooleanVariable(String) - Method in interface com.install4j.api.context.Context
Convenience method to get an installer variable with a type of java.lang.Boolean.
getCenterComponent() - Method in interface com.install4j.api.formcomponents.ComponentTuple
Return the center GUI component created by FormComponent.createCenterComponent.
getCommonFilesDirectory() - Static method in class com.install4j.api.windows.WinFileSystem
Returns a folder for components that are shared across applications.
getCompilerVariable(String) - Method in interface com.install4j.api.context.Context
Gets the value of a compiler variable as it was defined for this media file at compile time.
getComponentTuple(FormComponent) - Method in interface com.install4j.api.formcomponents.FormEnvironment
Get the ComponentTuple associated with a form component.
getConfigurationObject() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
getConfigurationObject() - Method in interface com.install4j.api.formcomponents.FormComponent
If the getConfigurationObjectClass method returns null, this method is not called, otherwise a non-null value of the type returned by getConfigurationObjectClass has to be returned by this method.
getConfigurationObjectClass() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
getConfigurationObjectClass() - Method in interface com.install4j.api.formcomponents.FormComponent
A form component can expose a well-known configuration object that is passed as a parameter to the "Initialization script" property of every form component.
getContext() - Method in interface com.install4j.api.beaninfo.EnumerationMapper
The property descriptor of an enumerated property must have a non-null context that corresponds to the return value of this method.
getContext() - Method in class com.install4j.api.events.InstallerEvent
Get the context.
getContext() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
Returns the Context that the framework has associated with this form component in setContext.
getContext() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
Returns the Context that the framework has associated with this custom screen in either setInstallerContext or setUninstallerContext.
getCustomizerTabName() - Method in exception com.install4j.api.beaninfo.BeanValidationException
Get the name of the customizer tab that was set with setCustomizerTabName.
getDesignTimeName(FormComponent) - Method in interface com.install4j.api.formcomponents.FormEnvironment
At design time, the install4j GUI allows the user to name instances of form components in a form.
getDestinationFile(File) - Method in interface com.install4j.api.context.Context
Get the location where the installer will install a file in the distribution tree.
getDestinationFile(String) - Method in interface com.install4j.api.context.Context
Same as getDestinationFile, only with a path argument.
getDestinationFile() - Method in interface com.install4j.api.context.FileInfo
Get the actual installation location of the file.
getDestinationFile() - Method in class com.install4j.api.events.InstallerFileEvent
Get the installed file location that is associated with this event.
getDestinationFileInfo(String) - Method in interface com.install4j.api.context.Context
Analyze a path in the distribution tree.
getEnumerationClass() - Method in interface com.install4j.api.beaninfo.EnumerationMapper
Return the property type for which this enumeration mapper is eligible.
getEnumerationMapEntries() - Method in interface com.install4j.api.beaninfo.EnumerationMapper
Defines the enumeration.
getenv(String) - Static method in class com.install4j.api.windows.WinEnvVars
Returns a single environment variable.
getenv() - Static method in class com.install4j.api.windows.WinEnvVars
Returns all environment variables.
getExecutable(String) - Static method in class com.install4j.api.windows.WinAssociations
Retrieves the executable associated with an extension.
getExternalFile(ExternalFile, boolean) - Method in interface com.install4j.api.context.Context
Get the location of an external file that was packaged with the installer.
getFileInformation(File) - Static method in class com.install4j.api.unix.UnixFileSystem
Get Unix-specific information about a file.
getFileTime() - Method in class com.install4j.api.context.FileOptions
Returns the file time.
getFirstAction(Class, Screen) - Method in interface com.install4j.api.context.Context
Get the registered action for a specified screen and a given action class.
getFirstScreen(Class) - Method in interface com.install4j.api.context.Context
Get the registered screen for a given screen class.
getFormComponentById(String) - Method in interface com.install4j.api.formcomponents.FormEnvironment
Get the form component of a certain ID.
getFormComponents() - Method in interface com.install4j.api.formcomponents.FormEnvironment
Returns all form components that are contained in the same form.
getFormEnvironment() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
Returns the FormEnvironment that the framework has associated with this form component in setFormEnvironment.
getFreeDiskSpace(File) - Static method in class com.install4j.api.SystemInfo
Retrieves the free disk space for the disk containing the given file on Windows, OS X and Linux.
getFromIntValue(int) - Static method in class com.install4j.api.context.OverwriteMode
Convert int value to constant.
getFromIntValue(int) - Static method in class com.install4j.api.context.UninstallMode
Convert int value to constant.
getId() - Method in interface com.install4j.api.ApplicationRegistry.ApplicationInfo
Returns the application ID.
getId() - Method in class com.install4j.api.beaninfo.FailureStrategy
Convert to an int value.
getId() - Method in interface com.install4j.api.context.InstallationComponentSetup
The ID of the installation component.
getId() - Method in interface com.install4j.api.context.LauncherSetup
Get the ID of the launcher.
getId(FormComponent) - Method in interface com.install4j.api.formcomponents.FormEnvironment
Get the ID that the framework associates with a form component.
getInitValue(Object, String, Class) - Method in class com.install4j.api.formcomponents.AbstractFormComponent
Helper method to get an init value.
getInsertIndex(Bean, List) - Method in interface com.install4j.api.beaninfo.SequenceValidator
When a bean is inserted the first time at design-time, this method will be called to determine the insertion index.
getInstallationComponentById(String) - Method in interface com.install4j.api.context.Context
Returns the installation component for a specified ID.
getInstallationComponents() - Method in interface com.install4j.api.context.Context
Returns all installation components for this installer.
getInstallationDirectory() - Method in interface com.install4j.api.ApplicationRegistry.ApplicationInfo
Returns the directory the application was installed in the last time the installer run.
getInstallationDirectory() - Method in interface com.install4j.api.context.Context
Retrieves the installation directory selected by the user, or the default installation directory if the user has not yet made a selection.
getInstallerContext() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
Returns the InstallerContext that the framework has associated with this custom screen in setInstallerContext.
getInstallerContext() - Method in class com.install4j.api.screens.AbstractInstallerScreen
Returns the InstallerContext that the framework has associated with this custom screen in setInstallerContext.
getInstallerFile() - Method in interface com.install4j.api.context.InstallerContext
Returns the current media file.
getIntValue() - Method in class com.install4j.api.context.OverwriteMode
Convert to an int value.
getIntValue() - Method in class com.install4j.api.context.UninstallMode
Convert to an int value.
getJavaHome() - Method in interface com.install4j.api.JVMSelector.JVMLocation
Returns the base directory of a Java installation.
getJFileChooserMode() - Method in class com.install4j.api.beaninfo.FileSelectionMode
Convert to an int value.
getJVMLocation(File, String, String, boolean) - Static method in class com.install4j.api.JVMSelector
Checks if this directory contains a JVM with the specificed parameters and returns the location object.
getJVMLocations() - Static method in class com.install4j.api.JVMSelector
Returns JVMs found in standard locations.
getJVMLocations(String, String, boolean, File[]) - Static method in class com.install4j.api.JVMSelector
Returns JVMs found in standard locations with the given version requirements.
getLanguageId() - Method in interface com.install4j.api.context.Context
Return the ISO code for the language that the installer is running with.
getLauncherById(String) - Method in interface com.install4j.api.context.Context
Returns the launcher for a specified ID.
getLaunchers() - Method in interface com.install4j.api.context.Context
Returns all launchers for this installer.
getLeftComponent() - Method in interface com.install4j.api.formcomponents.ComponentTuple
Return the left GUI component created by FormComponent.createLeftComponent.
getLinkTarget() - Method in interface com.install4j.api.unix.UnixFileSystem.FileInformation
If isLink returns true, this method returns the target file of the link.
getLogValueForProperty(String, Object) - Method in interface com.install4j.api.beans.PropertyLoggingInterceptor
Replace the value of the property for logging purposes.
getMediaName() - Method in interface com.install4j.api.context.InstallerContext
Get the name of the current media file.
getMessage(String) - Method in interface com.install4j.api.context.Context
Get a message for a localization key.
getMode() - Method in class com.install4j.api.context.FileOptions
Returns the unix access mode.
getMode() - Method in interface com.install4j.api.unix.UnixFileSystem.FileInformation
Get the Unix mode of a file.
getName() - Method in interface com.install4j.api.ApplicationRegistry.ApplicationInfo
Returns the name of the application.
getName() - Method in class com.install4j.api.beaninfo.EnumerationMapEntry
Get the name of the map entry.
getName() - Method in interface com.install4j.api.context.InstallationComponentSetup
Returns the name of this installation components.
getName() - Method in interface com.install4j.api.context.LauncherSetup
Return the name of the installer as configured in the instal4j GUI.
getObject() - Method in class com.install4j.api.beaninfo.EnumerationMapEntry
Get the object that is mapped to the specified name.
getOperationVerbose() - Method in class com.install4j.api.events.EventType
Get a verbose message that describes the operation that is connected with this event.
getOverwriteMode() - Method in class com.install4j.api.context.FileOptions
Returns the overwrite mode.
getOwnerInfo() - Method in interface com.install4j.api.unix.UnixFileSystem.FileInformation
Get the owner of a file.
getParameterClass() - Method in class com.install4j.api.beaninfo.ScriptParameter
Get the parameter class
getParameterName() - Method in class com.install4j.api.beaninfo.ScriptParameter
Get the parameter name
getParentWindow() - Static method in class com.install4j.api.Util
Get the window of the installer.
getPercentCompleted() - Method in interface com.install4j.api.context.ProgressInterface
Retrieves the current progress value
getPersistentProperties() - Method in interface com.install4j.api.actions.AutoUninstallAction
The framework invokes this method in the installer just before the installer exits in order to get the persistent properties of the install action.
getPhysicalMemory() - Static method in class com.install4j.api.SystemInfo
Retrieves the physical memory on Windows, OS X and Linux.
getProgramFilesDirectory() - Static method in class com.install4j.api.windows.WinFileSystem
Returns the program files directory of the current Windows installation.
getProgramGroup() - Method in interface com.install4j.api.ApplicationRegistry.ApplicationInfo
Returns the program group the application used the last time the installer run on Microsoft Windows.
getProgressInterface() - Method in interface com.install4j.api.context.Context
Get the current progress interface.
getProgressInterface(ProgressInterface) - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
getProgressInterface(ProgressInterface) - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
getProgressInterface(ProgressInterface) - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
getProgressInterface(ProgressInterface) - Method in interface com.install4j.api.screens.Screen
Replace the default prorgess interface for actions with a custom progress interface.
getProjectReportProperties() - Method in interface com.install4j.api.beaninfo.CustomizerCallback
Called by the install4j GUI when the user exports a project report.
getPropertyDescriptors() - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
 
getPropertyName() - Method in exception com.install4j.api.beaninfo.BeanValidationException
Get the name of the invalid property, or null if no property name was specified in the constructor.
getPropertyName() - Method in class com.install4j.api.beaninfo.ProjectReportProperty
Get the property name.
getPropertyValue(PropertyDescriptor, Bean) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Convenience method for bean validators to get the property value for a property descriptor.
getRelativeFileName() - Method in interface com.install4j.api.context.LauncherSetup
Get the relative file name for the launcher.
getRelativeFilePath() - Method in interface com.install4j.api.context.FileInfo
Get the relative path of the file in the distribution tree without the installation root.
getReportValue() - Method in class com.install4j.api.beaninfo.ProjectReportProperty
Get the report value.
getRightComponent() - Method in interface com.install4j.api.formcomponents.ComponentTuple
Return the right GUI component created by FormComponent.createRightComponent.
getRootResolved() - Method in interface com.install4j.api.context.FileInfo
Get the resolved installation root for the file.
getRootUnresolved() - Method in interface com.install4j.api.context.FileInfo
Get the unresolved installation root for the file.
getScreen() - Method in interface com.install4j.api.formcomponents.FormEnvironment
Get the form screen associated with this form environment.
getScreens() - Method in interface com.install4j.api.context.Context
Get all registered screens.
getScreens(Class) - Method in interface com.install4j.api.context.Context
Get all registered screens for a given screen class.
getSpecialFolder(SpecialFolder, boolean) - Static method in class com.install4j.api.windows.WinFileSystem
Returns Windows-specific directories like the start menu or the desktop.
getStandardApplicationsDirectory() - Static method in class com.install4j.api.Util
Returns the standard directory for installing applications.
getSubKeyNames(RegistryRoot, String) - Static method in class com.install4j.api.windows.WinRegistry
Retrieves the sub keys of a registry key.
getSubTitle() - Method in interface com.install4j.api.screens.Screen
Returns the subtitle of this custom screen which is displayed at the top of the installer wizard just below the title of the screen.
getSystemDirectory() - Static method in class com.install4j.api.windows.WinFileSystem
Returns the system directory.
getTitle() - Method in interface com.install4j.api.screens.Screen
Returns the title of this custom screen which is displayed at the top of the installer wizard.
getType() - Method in interface com.install4j.api.context.LauncherSetup
Get the type of the launcher.
getType() - Method in class com.install4j.api.events.InstallerEvent
Get the type of the event.
getUninstallerContext() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
Returns the UninstallerContext that the framework has associated with this custom screen in setUninstallerContext.
getUninstallerContext() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
Returns the UninstallerContext that the framework has associated with this custom screen in setUninstallerContext.
getUninstallMode() - Method in class com.install4j.api.context.FileOptions
Returns the uninstallation mode.
getValue() - Method in class com.install4j.api.beans.ScriptProperty
Required by the framework.
getValue() - Method in class com.install4j.api.windows.WinRegistry.ExpandString
Get the string value.
getValue(RegistryRoot, String, String) - Static method in class com.install4j.api.windows.WinRegistry
Retrieves a registry value.
getVariable(String) - Method in interface com.install4j.api.context.Context
Get an installer variable.
getVariableName() - Method in class com.install4j.api.events.InstallerVariableEvent
Get the name of the variable that was changed.
getVariableNames() - Method in interface com.install4j.api.context.Context
Get the names of all defined installer variables.
getVerbose() - Method in class com.install4j.api.events.InstallerEvent
Return a verbose description of this event.
getVerbose() - Method in class com.install4j.api.events.InstallerFileEvent
 
getVerbose() - Method in class com.install4j.api.events.InstallerVariableEvent
 
getVersion() - Method in interface com.install4j.api.ApplicationRegistry.ApplicationInfo
Returns the version of the application.
getVersion() - Method in interface com.install4j.api.JVMSelector.JVMLocation
Returns the version of the JVM.
getWindowsDirectory() - Static method in class com.install4j.api.windows.WinFileSystem
Returns the Windows directory.
getWizardContext() - Method in interface com.install4j.api.context.Context
Get the wizard context if the installer or uninstaller is running in GUI mode.
goBack(int) - Method in interface com.install4j.api.context.Context
Go backwards in the screen sequence.
goBackInHistory(int) - Method in interface com.install4j.api.context.Context
Go backwards in the screen history.
goForward(int, boolean, boolean) - Method in interface com.install4j.api.context.Context
Go forward in the screen sequence.
gotoScreen(Screen) - Method in interface com.install4j.api.context.Context
Programmatically switch to another screen in the installer.
GUI - Static variable in class com.install4j.api.context.LauncherType
Represents a GUI launcher.

H

handleConsole(Console) - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
handleConsole(Console) - Method in interface com.install4j.api.formcomponents.FormComponent
Handle the console mode.
handleConsole(Console) - Method in interface com.install4j.api.formcomponents.FormEnvironment
Handle console mode for all form components in a form.
handleConsole(Console) - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
handleConsole(Console) - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
handleConsole(Console) - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
handleConsole(Console) - Method in interface com.install4j.api.screens.Screen
Handle the console mode.
handleCriticalException(Throwable) - Method in interface com.install4j.api.context.Context
If you encounter an exception in your code that cannot be handled, you can use this method to invoke the default exception handling of the install4j runtime.
handleUnattended() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
handleUnattended() - Method in interface com.install4j.api.formcomponents.FormComponent
Handle the unattended mode.
handleUnattended() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
handleUnattended() - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
handleUnattended() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
handleUnattended() - Method in interface com.install4j.api.screens.Screen
Handle the unattended mode.
hasFormPanel() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
hasFormPanel() - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
hasFormPanel() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
hasFormPanel() - Method in interface com.install4j.api.screens.Screen
Any screen can have a form panel, just like the "Additional confirmations" screen or the "Configurable form" screen.
hashCode() - Method in class com.install4j.api.beans.ScriptProperty
 
hasTitlePanel() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
hasTitlePanel() - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
hasTitlePanel() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
hasTitlePanel() - Method in interface com.install4j.api.screens.Screen
This method is called by the framework to determine if this screen wants a title area or not.
hide() - Static method in class com.install4j.api.launcher.SplashScreen
Programmatically hide the splash screen.
HKEY_CLASSES_ROOT - Static variable in class com.install4j.api.windows.RegistryRoot
Identifies the root registry key HKEY_CLASSES_ROOT.
HKEY_CURRENT_CONFIG - Static variable in class com.install4j.api.windows.RegistryRoot
Identifies the root registry key HKEY_CURRENT_CONFIG.
HKEY_CURRENT_USER - Static variable in class com.install4j.api.windows.RegistryRoot
Identifies the root registry key HKEY_CURRENT_USER.
HKEY_LOCAL_MACHINE - Static variable in class com.install4j.api.windows.RegistryRoot
Identifies the root registry key HKEY_LOCAL_MACHINE.
HKEY_USERS - Static variable in class com.install4j.api.windows.RegistryRoot
Identifies the root registry key HKEY_USERS.

I

IF_CREATED - Static variable in class com.install4j.api.context.UninstallMode
Indicates that if the destination file was created by the installer it will be deleted for uninstallation.
IF_CREATED_BUT_NOT_FOR_UPDATE - Static variable in class com.install4j.api.context.UninstallMode
Indicates that the destination file won't be deleted when the uninstaller runs as part of an update.
IF_NEWER - Static variable in class com.install4j.api.context.OverwriteMode
Indicates that if the destination file exists it will be replaced if the source file is newer.
IF_NEWER_OTHERWISE_ASK - Static variable in class com.install4j.api.context.OverwriteMode
Indicates that if the destination file exists it will be replaced if the source file is newer.
init(Context) - Method in class com.install4j.api.actions.AbstractInstallAction
 
init(Context) - Method in class com.install4j.api.actions.AbstractInstallOrUninstallAction
 
init(Context) - Method in class com.install4j.api.actions.AbstractUninstallAction
 
init(Context) - Method in interface com.install4j.api.actions.Action
This method is called after the properties have been set
initalize() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
initalize() - Method in interface com.install4j.api.formcomponents.FormComponent
This method is called by the framework when the initial state of the component should be evaluated.
initializeBean(Bean) - Method in interface com.install4j.api.beaninfo.BeanInitializer
Called after the unconfigured bean is instantiated the first time at design-time.
install(InstallerContext) - Method in interface com.install4j.api.actions.InstallAction
This method is called by the framework to perform the action during installation.
Install4JBeanInfo - Class in com.install4j.api.beaninfo
Base class for bean infos.
Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class) - Constructor for class com.install4j.api.beaninfo.Install4JBeanInfo
Constructor.
Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class) - Constructor for class com.install4j.api.beaninfo.Install4JBeanInfo
Same as Install4JBeanInfo.Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class) with a customizer class of null.
Install4JPropertyDescriptor - Class in com.install4j.api.beaninfo
Property descriptor for use in instances of Install4JBeanInfo.
InstallAction - Interface in com.install4j.api.actions
All install actions must implement this interface.
InstallationComponentSetup - Interface in com.install4j.api.context
This interface provides information about installation components.
InstallerContext - Interface in com.install4j.api.context
The context provided by the installer.
InstallerEvent - Class in com.install4j.api.events
The event object that is passed to installer event listeners.
InstallerEvent(Object, Context, EventType, boolean) - Constructor for class com.install4j.api.events.InstallerEvent
The constructor is called by the framework.
installerEvent(InstallerEvent) - Method in interface com.install4j.api.events.InstallerEventListener
Called when an installer event is fired.
installerEvent(InstallerEvent) - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
installerEvent(InstallerEvent) - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
InstallerEventListener - Interface in com.install4j.api.events
The interface that must be implemented by classes who are interested in installer events.
InstallerFileEvent - Class in com.install4j.api.events
The event object that is passed to installer event listeners for file installation event types.
InstallerFileEvent(Object, Context, EventType, boolean, File) - Constructor for class com.install4j.api.events.InstallerFileEvent
The constructor is called by the framework.
InstallerScreen - Interface in com.install4j.api.screens
All installer screens must implement this interface.
InstallerVariableEvent - Class in com.install4j.api.events
The event object that is passed to installer event listeners for the variable change event type.
InstallerVariableEvent(Object, Context, String) - Constructor for class com.install4j.api.events.InstallerVariableEvent
The constructor is called by the framework.
installFile(File, File) - Method in interface com.install4j.api.context.InstallerContext
Installs a file.
installFile(File, File, FileOptions) - Method in interface com.install4j.api.context.InstallerContext
Installs a file.
installFile(File, File, FileOptions, ProgressInterface, int, int) - Method in interface com.install4j.api.context.InstallerContext
Installs a file.
isAdminUser() - Static method in class com.install4j.api.Util
Checks whether the current user has administration privileges.
isBarrier(Bean, Bean) - Method in interface com.install4j.api.beaninfo.SequenceValidator
When a bean is moved in the list of beans, this method is called to check whether the move is valid.
isCancelling() - Method in interface com.install4j.api.context.Context
Returns whether the user has cancelled the installation or not.
isCancelVisible() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
isCancelVisible() - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
isCancelVisible() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
isCancelVisible() - Method in interface com.install4j.api.screens.Screen
Returns whether the "Cancel" button is visible or not for this screen.
isConsole() - Method in interface com.install4j.api.context.Context
Returns whether the installer or uninstaller is running in console mode.
isDesignTime() - Method in interface com.install4j.api.formcomponents.FormEnvironment
Returns whether the form component has been instantiated at design time.
isEmpty(String, Bean) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Convenience method for bean validators to check if a property is empty.
isEnabled() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
isEnabled() - Method in interface com.install4j.api.formcomponents.FormComponent
Returns whether the form component is enabled or not.
isErrorOccured() - Method in interface com.install4j.api.context.Context
Determine if an error has occured for any of the previous actions.
isExcludeFromMenu() - Method in interface com.install4j.api.context.LauncherSetup
Returns whether the launcher is excluded from menu integration.
isFillCenterHorizontal() - Method in interface com.install4j.api.formcomponents.FormComponent
Determine whether the center component created by createCenterComponent should fill all available horizontal space.
isFillHorizontal() - Method in interface com.install4j.api.screens.Screen
Returns whether this screen wants to grow in the horizontal direction.
isFillVertical() - Method in interface com.install4j.api.screens.Screen
Returns whether this screen wants to grow in the vertical direction.
isHidden() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
isHidden() - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
isHidden() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
isHidden() - Method in interface com.install4j.api.screens.Screen
Returns whether this screen should be hidden.
isHiddenForNext() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
isHiddenForNext() - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
isHiddenForNext() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
isHiddenForNext() - Method in interface com.install4j.api.screens.Screen
Returns whether this screen should be hidden when the user traverses screens in the forward direction.
isHiddenForPrevious() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
isHiddenForPrevious() - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
isHiddenForPrevious() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
isHiddenForPrevious() - Method in interface com.install4j.api.screens.Screen
Returns whether this screen should be hidden when the user traverses screens in the backward direction.
isHpux() - Static method in class com.install4j.api.Util
Returns whether the platform is HP UX.
isJDK() - Method in interface com.install4j.api.JVMSelector.JVMLocation
Returns whether this a JDK installation.
isLink() - Method in interface com.install4j.api.unix.UnixFileSystem.FileInformation
Return whether the file is a link or not.
isLinux() - Static method in class com.install4j.api.Util
Returns whether the platform is Linux.
isMacOS() - Static method in class com.install4j.api.Util
Returns whether the platform is Mac OS X.
isMacosInstaller() - Static method in class com.install4j.api.Util
Returns whether the installer is a Mac OS X installer
isNextVisible() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
isNextVisible() - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
isNextVisible() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
isNextVisible() - Method in interface com.install4j.api.screens.Screen
Returns whether the "Next" button is visible or not for this screen.
isPreviousVisible() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
isPreviousVisible() - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
isPreviousVisible() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
isPreviousVisible() - Method in interface com.install4j.api.screens.Screen
Returns whether the "Back" button is visible or not for this screen.
isSelected() - Method in interface com.install4j.api.context.InstallationComponentSetup
Returns whether the installation components has been selected by the user.
isServiceInstalled(File) - Static method in class com.install4j.api.ServiceInfo
Checks if a service is installed on Windows.
isServiceRunning(File) - Static method in class com.install4j.api.ServiceInfo
Checks if a services is running.
isShared() - Method in class com.install4j.api.context.FileOptions
Returns whether the file will be installed as a shared file on Windows.
isSolaris() - Static method in class com.install4j.api.Util
Returns whether the platform is Solaris.
isUnattended() - Method in interface com.install4j.api.context.Context
Returns whether the installer or uninstaller is running in unattended mode.
isUninstaller() - Method in interface com.install4j.api.context.LauncherSetup
Returns whether the launcher is the uninstaller.
isUninstallForUpgrade() - Method in interface com.install4j.api.context.UninstallerContext
Returns whether the uninstaller is running as part of an upgrade.
isUnixInstaller() - Static method in class com.install4j.api.Util
Returns whether the installer is a Unix installer
isUpdateDirectory(File) - Static method in class com.install4j.api.ApplicationRegistry
Returns true if this application is already installed in the given directory.
isVisible() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
isVisible() - Method in interface com.install4j.api.formcomponents.FormComponent
Returns whether the form component is visible or not.
isWindows() - Static method in class com.install4j.api.Util
Returns whether the platform is Windows.
isWindows2000() - Static method in class com.install4j.api.Util
Returns whether the platform is Windows 2000.
isWindows9X() - Static method in class com.install4j.api.Util
Returns whether the platform is Windows 9X (95, 98, ME).
isWindowsInstaller() - Static method in class com.install4j.api.Util
Returns whether the installer is a Windows installer
isWindowsNT() - Static method in class com.install4j.api.Util
Returns whether the platform is Windows NT (not Windows 2000 and XP).
isWindowsVista() - Static method in class com.install4j.api.Util
Returns whether the platform is Windows Vista.
isWindowsXP() - Static method in class com.install4j.api.Util
Returns whether the platform is Windows XP.

J

JVMSelector - Class in com.install4j.api
With this class, you can retrieve the installed JVMs on Windows, Linux and Unix systems.
JVMSelector.JVMLocation - Interface in com.install4j.api
The interface providing information about a JVM.

K

keyExists(RegistryRoot, String) - Static method in class com.install4j.api.windows.WinRegistry
Checks if a registry key exists.

L

LauncherSetup - Interface in com.install4j.api.context
This interface provides information about launchers.
LauncherType - Class in com.install4j.api.context
Enumeration class that represents the different types of launchers.
LOCAL_APPDATA - Static variable in class com.install4j.api.windows.SpecialFolder
Identifies the file system directory that serves as a data repository for local applications.
logError(Object, String) - Static method in class com.install4j.api.Util
Writes an error message to the installation log.
logInfo(Object, String) - Static method in class com.install4j.api.Util
Writes an info message to the installation log.

M

migrateIds(Map) - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
migrateIds(Map) - Method in interface com.install4j.api.formcomponents.FormComponent
This method is only called at design time when a user pastes form components or a screen with form components from the clipboard.
more(String) - Method in interface com.install4j.api.screens.Console
Print a long text to the console and partition it into pages.
moveWithDelayUntilReboot(File, File) - Static method in class com.install4j.api.windows.WinFileSystem
Calls the win32 API function MoveFileEx with MOVEFILE_DELAY_UNTIL_REBOOT.

N

NEVER - Static variable in class com.install4j.api.context.OverwriteMode
Indicates that if the destination file exists it won't be replaced in any case.
NEVER - Static variable in class com.install4j.api.context.UninstallMode
Indicates that the destination file won't be deleted for uninstallation.
next() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
next() - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
next() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
next() - Method in interface com.install4j.api.screens.Screen
Called when the user clicks the "Next" button for this screen.

O

OVERWRITE_ALL - Static variable in interface com.install4j.api.context.ProgressInterface
Returned by askOverwrite if the user hits "All".
OVERWRITE_NEVER - Static variable in interface com.install4j.api.context.ProgressInterface
Returned by askOverwrite if the user hits "Never".
OVERWRITE_NO - Static variable in interface com.install4j.api.context.ProgressInterface
Returned by askOverwrite if the user hits "No".
OVERWRITE_YES - Static variable in interface com.install4j.api.context.ProgressInterface
Returned by askOverwrite if the user hits "Yes".
OverwriteMode - Class in com.install4j.api.context
Enumeration class that represents the different ways how install4j can react if asked to install a file over an already existing file.

P

PLAIN - Static variable in class com.install4j.api.beans.ReplacementMode
Normal replacement like in AbstractBean.replaceVariables(String).
prependToPath(String) - Static method in class com.install4j.api.windows.WinEnvVars
Prepends one or more directories to the PATH environment variable.
prependToUserPath(String) - Static method in class com.install4j.api.windows.WinEnvVars
Prepends one or more directories to the user-specific PATH environment variable on Windows NT/2000/XP/Vista.
pressCancelButton() - Method in interface com.install4j.api.context.WizardContext
Cancel the installer or uninstaller.
pressNextButton() - Method in interface com.install4j.api.context.WizardContext
Move to the next screen.
pressPreviousButton() - Method in interface com.install4j.api.context.WizardContext
Move to the previous screen.
previous() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
previous() - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
previous() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
previous() - Method in interface com.install4j.api.screens.Screen
Called when the user clicks the "Back" button for this screen.
print(Object) - Method in interface com.install4j.api.screens.Console
Print an object to the console by invoking its toString() method.
println(Object) - Method in interface com.install4j.api.screens.Console
Print an object to the console by invoking its toString() method and append a line feed.
println() - Method in interface com.install4j.api.screens.Console
Print a line feed to the console.
PROGRAMS - Static variable in class com.install4j.api.windows.SpecialFolder
Identifies the file system directory that contains the user's program groups.
ProgressInterface - Interface in com.install4j.api.context
The user notification interface during installation.
ProjectReportProperty - Class in com.install4j.api.beaninfo
A project report element contributed by a customizer.
ProjectReportProperty(String, String) - Constructor for class com.install4j.api.beaninfo.ProjectReportProperty
Comstruct a project report property with a property name and a report value.
PropertyLoggingInterceptor - Interface in com.install4j.api.beans
Interceptor interface for beans to modify property values that are written to the installer log file.

Q

QUIT - Static variable in class com.install4j.api.beaninfo.FailureStrategy
Quit after a failure.

R

readLine() - Method in interface com.install4j.api.screens.Console
Read input from the console.
REGEXP_MATCH - Static variable in class com.install4j.api.beans.ReplacementMode
The property is used as a regular expression.
REGEXP_REPLACEMENT - Static variable in class com.install4j.api.beans.ReplacementMode
The property is used as a replacement part of a regular expression.
registerHiddenVariable(String) - Method in interface com.install4j.api.context.Context
Register a variable whose values should not be written to the installation log file.
registerResponseFileVariable(String) - Method in interface com.install4j.api.context.Context
Register a variable that should be written to the response file when the installation is finished.
registerStartupListener(StartupNotification.Listener) - Static method in class com.install4j.api.launcher.StartupNotification
Register a listener to receive startup events in single instance mode on Microsoft Windows or to receive file open events on OS X.
registerUninstallFile(File) - Method in interface com.install4j.api.context.InstallerContext
Registers an arbitrary file for uninstallation.
RegistryRoot - Class in com.install4j.api.windows
Enumeration class for the different registry roots in the Microsoft Windows registry.
remove(String) - Static method in class com.install4j.api.windows.WinAssociations
Removes a file association.
removeDesignTimeChangeListener(ChangeListener) - Method in interface com.install4j.api.formcomponents.FormEnvironment
Remove a change listener added with addDesignTimeChangeListener.
removeInstallerEventListener(InstallerEventListener) - Method in interface com.install4j.api.context.Context
Remove a listener added with addInstallerEventListener.
ReplacementMode - Class in com.install4j.api.beans
Variable replacement mode for string properties that are used in regular expressions.
ReplacementMode() - Constructor for class com.install4j.api.beans.ReplacementMode
 
replaceVariables(String) - Static method in class com.install4j.api.beans.AbstractBean
Replace all installer variables and localization keys in a string.
replaceVariables(String, ReplacementMode) - Static method in class com.install4j.api.beans.AbstractBean
Replace all installer variables and localization keys in a string that should be used in a regular expression.
replaceVariables(File) - Static method in class com.install4j.api.beans.AbstractBean
Replace all installer variables and localization keys in a file.
replaceVariables(String[]) - Static method in class com.install4j.api.beans.AbstractBean
Replace all installer variables and localization keys in a string array.
restoreKey(RegistryRoot, String, String) - Static method in class com.install4j.api.windows.WinRegistry
Restore a sub-tree of the registry from a file.
RETRY_CANCEL - Static variable in interface com.install4j.api.context.ProgressInterface
Returned by askRetry if the user hits "Cancel".
RETRY_NO - Static variable in interface com.install4j.api.context.ProgressInterface
Returned by askRetry if the user hits "No".
RETRY_YES - Static variable in interface com.install4j.api.context.ProgressInterface
Returned by askRetry if the user hits "Yes".
rollback(InstallerContext) - Method in class com.install4j.api.actions.AbstractInstallAction
 
rollback(InstallerContext) - Method in class com.install4j.api.actions.AbstractInstallOrUninstallAction
 
rollback(InstallerContext) - Method in interface com.install4j.api.actions.InstallAction
This method is called by the framework to perform a rollback of the install method.
runScript(ScriptProperty, Bean, Object[]) - Method in interface com.install4j.api.context.Context
Run a script.

S

saveKey(RegistryRoot, String, String) - Static method in class com.install4j.api.windows.WinRegistry
Save a sub-tree of the registry to a file.
Screen - Interface in com.install4j.api.screens
The base interface for all screens.
ScreenBeanInfo - Class in com.install4j.api.beaninfo
Base class for screen bean infos.
ScreenBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class) - Constructor for class com.install4j.api.beaninfo.ScreenBeanInfo
Same as Install4JBeanInfo.Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class).
ScreenBeanInfo(String, String, String, boolean, boolean, Integer, Class) - Constructor for class com.install4j.api.beaninfo.ScreenBeanInfo
Same as Install4JBeanInfo.Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class).
ScriptParameter - Class in com.install4j.api.beaninfo
Descriptor for script parameters of script properties defined with a ScriptPropertyDescriptor.
ScriptParameter(String, Class) - Constructor for class com.install4j.api.beaninfo.ScriptParameter
Create a script parameter.
ScriptProperty - Class in com.install4j.api.beans
Property type for script properties to be used in beans.
ScriptProperty() - Constructor for class com.install4j.api.beans.ScriptProperty
The constructor is called by the framework.
ScriptProperty(String) - Constructor for class com.install4j.api.beans.ScriptProperty
The constructor is called by the framework.
ScriptPropertyDescriptor - Class in com.install4j.api.beaninfo
Property descriptor for properties of type ScriptProperty.
SENDTO - Static variable in class com.install4j.api.windows.SpecialFolder
Identifies the file system directory that contains Send To menu items.
SequenceValidator - Interface in com.install4j.api.beaninfo
Interface for controlling insertion and reordering of beans at design-time.
SERVICE - Static variable in class com.install4j.api.context.LauncherType
Represents a service launcher.
ServiceInfo - Class in com.install4j.api
Provides information about services created with install4j.
ServiceInfo() - Constructor for class com.install4j.api.ServiceInfo
 
set(String, String) - Static method in class com.install4j.api.windows.WinEnvVars
Sets a global environment variable.
setAssociatedAction(String, String) - Method in class com.install4j.api.beaninfo.ScreenBeanInfo
Configures an associated action.
setAssociatedConfirmation(String, String) - Method in class com.install4j.api.beaninfo.ActionBeanInfo
Configures an associated confirmation.
setAssociatedScreen(String) - Method in class com.install4j.api.beaninfo.ActionBeanInfo
Configures an associated screen.
setAssociatedStartupAction(String, boolean) - Method in class com.install4j.api.beaninfo.ActionBeanInfo
Configures an associated startup action.
setBackButtonEnabled(boolean) - Method in interface com.install4j.api.context.WizardContext
Change the enabled status of the "Back" button at the bottom of the current screen.
setBeanInitializer(BeanInitializer) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Configures a bean initializer.
setBeanValidator(BeanValidator) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Configures a bean validator.
setCancelButtonEnabled(boolean) - Method in interface com.install4j.api.context.WizardContext
Change the enabled status of the "Cancel" button at the bottom of the current screen.
setCollapsedPropertyCategories(String[]) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Specifies property categories that should be collapsed by default.
setContext(Context) - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
setContext(Context) - Method in interface com.install4j.api.formcomponents.FormComponent
This method is called by the framework to set the Context just after the form component has been constructed.
setCustomizerPlacement(CustomizerPlacement) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Configures the placement of the customizer.
setCustomizerTabName(String) - Method in exception com.install4j.api.beaninfo.BeanValidationException
Set the name of the customizer tab, if the error message applies to a customizer.
setDefaultConditionExpression(String) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Configures the default value for the "Condition expression" property of the bean.
setDefaultErrorMessage(String) - Method in class com.install4j.api.beaninfo.ActionBeanInfo
Configures the default error message for the action.
setDefaultFailureStrategy(FailureStrategy) - Method in class com.install4j.api.beaninfo.ActionBeanInfo
Configures the default failure strategy for the action.
setDefaultQuitAfterScreen(boolean) - Method in class com.install4j.api.beaninfo.ScreenBeanInfo
Configures the default value of the "Quit after screen" property of the screen.
setDefaultRollbackBarrier(boolean) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Configures if the action is a rollback barrier by default.
setDetailMessage(String) - Method in interface com.install4j.api.context.ProgressInterface
Sets the detail message on the progress screen.
setDisplayName(String) - Method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
 
setEnabled(boolean) - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
setEnabled(boolean) - Method in interface com.install4j.api.formcomponents.FormComponent
Sets whether the form component is enabled or not.
setEnumerationMappers(EnumerationMapper[]) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Specifies enumeration mappers for properties of this bean.
setErrorOccured(boolean) - Method in interface com.install4j.api.context.Context
Clear or set the error flag that is described for isErrorOccured.
setFileTime(long) - Method in class com.install4j.api.context.FileOptions
Sets the file time.
setFormComponentCustomizerPlacement(CustomizerPlacement) - Method in class com.install4j.api.beaninfo.ScreenBeanInfo
Configures the placement of the form component customizer for form screens.
setFormEnvironment(FormEnvironment) - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
setFormEnvironment(FormEnvironment) - Method in interface com.install4j.api.formcomponents.FormComponent
At runtime, this method is called twice by the framework.
setFormPanel(JPanel, FormEnvironment) - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
setFormPanel(JPanel, FormEnvironment) - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
setFormPanel(JPanel, FormEnvironment) - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
setFormPanel(JPanel, FormEnvironment) - Method in interface com.install4j.api.screens.Screen
If hasFormPanel returns true, this method is calle by the framework to pass the form panel to this screen.
setHandleQuit(boolean) - Static method in class com.install4j.api.launcher.StartupNotification
Sets if the Quit command should be handled on OS X (that means if the application should quit when the command is invoked).
setIcons(Icon, Icon) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Configures custom icons for the bean.
setIndeterminateProgress(boolean) - Method in interface com.install4j.api.context.ProgressInterface
Indicate that an action is performed whose duration is not known.
setInstallationDirectory(File) - Method in interface com.install4j.api.context.InstallerContext
Set the installation directory programmatically.
setInstallerContext(InstallerContext) - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
setInstallerContext(InstallerContext) - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
setInstallerContext(InstallerContext) - Method in interface com.install4j.api.screens.InstallerScreen
This method is called by the framework to set the InstallerContext just after the screen has been constructed.
setInstallerTargetScreen(String) - Method in class com.install4j.api.beaninfo.ActionBeanInfo
Configures a target screen for the installer.
setMinimumJavaVersion(String) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Sets the minimum Java version that this bean will work with.
setMode(int) - Method in class com.install4j.api.context.FileOptions
Sets the unix file mode as an integer.
setMode(String) - Method in class com.install4j.api.context.FileOptions
Sets the unix file mode as an octal string.
setMode(int, File) - Static method in class com.install4j.api.unix.UnixFileSystem
Set the Unix file mode for a file.
setMode(String, File) - Static method in class com.install4j.api.unix.UnixFileSystem
Set the Unix file mode for a file.
setNextButtonEnabled(boolean) - Method in interface com.install4j.api.context.WizardContext
Change the enabled status of the "Next" button at the bottom of the current screen.
setOverwriteMode(OverwriteMode) - Method in class com.install4j.api.context.FileOptions
Sets the overwrite mode.
setOwner(String, File) - Static method in class com.install4j.api.unix.UnixFileSystem
Set the owner of a file.
setParentWindow(Window) - Method in interface com.install4j.api.beaninfo.CustomizerCallback
Called by the install4j GUI afer the customizer is initialized and sets the parent window.
setPercentCompleted(int) - Method in interface com.install4j.api.context.ProgressInterface
Sets the percentage of completion of the current action.
setPersistenceDelegateMap(Map) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Specifies persistence delegates for this bean.
setPersistentProperties(Properties) - Method in interface com.install4j.api.actions.AutoUninstallAction
The framework invokes this method in the uninstaller at the beginning of the "Uninstall files" action in order to restore the persistent properties that were saved in the installer.
setPreferredJVM(String) - Static method in class com.install4j.api.JVMSelector
Set the preferred JRE/JDK for your application.
setPropertyCategory(String) - Method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Configures the property category.
setPropertyName(String) - Method in class com.install4j.api.beaninfo.ProjectReportProperty
Set the property name.
setReportValue(String) - Method in class com.install4j.api.beaninfo.ProjectReportProperty
Set the report value.
setSelected(boolean) - Method in interface com.install4j.api.context.InstallationComponentSetup
Sets whether the installation component should be installed or not.
setSequenceValidator(SequenceValidator) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Configures a sequence validator.
setShared(boolean) - Method in class com.install4j.api.context.FileOptions
Sets whether the file should be installed as shared on Windows.
setSortKey(Integer) - Method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Set an integer key by which properties are sorted.
setStatusMessage(String) - Method in interface com.install4j.api.context.ProgressInterface
Sets the status message on the progress screen.
setUninstallerContext(UninstallerContext) - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
setUninstallerContext(UninstallerContext) - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
setUninstallerContext(UninstallerContext) - Method in interface com.install4j.api.screens.UninstallerScreen
This method is called by the framework to set the UninstallerContext.
setUninstallerTargetScreen(String) - Method in class com.install4j.api.beaninfo.ActionBeanInfo
Configures a target screen for the uninstaller.
setUninstallMode(UninstallMode) - Method in class com.install4j.api.context.FileOptions
Sets whether the file should be uninstalled.
setUserSpecific(String, String) - Static method in class com.install4j.api.windows.WinEnvVars
Sets a user-specific environment variable on NT/2000/XP/Vista.
setValue(String) - Method in class com.install4j.api.beans.ScriptProperty
Required by the framework.
setValue(RegistryRoot, String, String, Object) - Static method in class com.install4j.api.windows.WinRegistry
Sets a registry value.
setVariable(String, Object) - Method in interface com.install4j.api.context.Context
Set an installer variable.
setVisible(boolean) - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
setVisible(boolean) - Method in interface com.install4j.api.formcomponents.FormComponent
Sets whether the form component is visible or not.
SHOW_SCREEN - Static variable in class com.install4j.api.events.EventType
Fired before a screen is shown.
showErrorMessage(String) - Static method in class com.install4j.api.Util
Show a message dialog.
showFailure(String) - Method in interface com.install4j.api.context.ProgressInterface
Shows an error dialog with the specified message.
showMessage(String, int) - Static method in class com.install4j.api.Util
Show a message dialog.
showMessage(String) - Static method in class com.install4j.api.Util
Show a message dialog.
showOptionDialog(String, String[], int) - Static method in class com.install4j.api.Util
Show an options dialog.
showUrl(URL) - Static method in class com.install4j.api.Util
Show a URL in the default browser.
showWarningMessage(String) - Static method in class com.install4j.api.Util
Show a message dialog.
SpecialFolder - Class in com.install4j.api.windows
Enumeration class for the different special system folders in Microsoft Windows.
SplashScreen - Class in com.install4j.api.launcher
This class allows you to control the splash screen of an install4j launcher from your Java code.
SplashScreen.ConnectionException - Exception in com.install4j.api.launcher
The exception thrown by methods of the SplashScreen class to indicate that a splash screen operation was not successful.
STARTMENU - Static variable in class com.install4j.api.windows.SpecialFolder
Identifies the file system directory containing Start menu items.
STARTUP - Static variable in class com.install4j.api.windows.SpecialFolder
Identifies the file system directory that corresponds to the user's Startup program group.
StartupNotification - Class in com.install4j.api.launcher
This class allows you to register a listener to receive startup events in single instance mode on Microsoft Windows and file open events on Mac OS X.
StartupNotification() - Constructor for class com.install4j.api.launcher.StartupNotification
 
StartupNotification.Listener - Interface in com.install4j.api.launcher
The interface for startup events in single instance mode or for open file events on OS X.
startupPerformed(String) - Method in interface com.install4j.api.launcher.StartupNotification.Listener
Will be called when the executable is started again or when a file open event is received.
stopEditing() - Method in interface com.install4j.api.beaninfo.CustomizerCallback
Called by the install4j GUI when the user moves to another bean or to a different comfiguation step.
SystemInfo - Class in com.install4j.api
The class contains utility functions to get information about the current system that is not available via the Java API.
SystemInfo() - Constructor for class com.install4j.api.SystemInfo
 

T

TEMPLATES - Static variable in class com.install4j.api.windows.SpecialFolder
Identifies the file system directory that serves as a common repository for document templates.
toString() - Method in class com.install4j.api.beans.ScriptProperty
 
toString() - Method in class com.install4j.api.context.FileOptions
 
toString() - Method in class com.install4j.api.context.LauncherType
 
toString() - Method in class com.install4j.api.context.OverwriteMode
 
toString() - Method in class com.install4j.api.context.UninstallMode
 
toString() - Method in class com.install4j.api.events.EventType
 
toString() - Method in class com.install4j.api.events.InstallerEvent
 
toString() - Method in class com.install4j.api.events.InstallerFileEvent
 
toString() - Method in class com.install4j.api.events.InstallerVariableEvent
 
toString() - Method in class com.install4j.api.windows.RegistryRoot
 
toString() - Method in class com.install4j.api.windows.WinRegistry.ExpandString
 

U

uninstall(UninstallerContext) - Method in interface com.install4j.api.actions.UninstallAction
This method is called by the framework to perform the action during uninstallation.
UninstallAction - Interface in com.install4j.api.actions
All uninstall actions must implement this interface.
UninstallerContext - Interface in com.install4j.api.context
The context provided by the uninstaller.
UninstallerScreen - Interface in com.install4j.api.screens
All uninstaller screens must implement this interface.
UninstallMode - Class in com.install4j.api.context
Enumeration class that represents the different ways how install4j can handle the uninstallation of a file.
UnixFileSystem - Class in com.install4j.api.unix
Collection of static methods to access Unix-specific file operations and information.
UnixFileSystem() - Constructor for class com.install4j.api.unix.UnixFileSystem
 
UnixFileSystem.FileInformation - Interface in com.install4j.api.unix
Holds Unix-specific information about a file.
UserCanceledException - Exception in com.install4j.api.context
Installation methods throw this exception if the user cancels an operation.
UserCanceledException(String) - Constructor for exception com.install4j.api.context.UserCanceledException
Initializes a new instance with a message.
UserCanceledException() - Constructor for exception com.install4j.api.context.UserCanceledException
Initializes a new instance.
Util - Class in com.install4j.api
The class contains various utility functions to be used by script properties, custom actions and custom screens.
Util() - Constructor for class com.install4j.api.Util
 

V

validateBean(Bean) - Method in interface com.install4j.api.beaninfo.BeanValidator
Called by the install4j GUI at design-time to check the validity of the bean properties.
VARIABLE_CHANGED - Static variable in class com.install4j.api.events.EventType
Fired after a variable has been set.

W

waitForEnter() - Method in interface com.install4j.api.screens.Console
Print [Enter] to the console and wait for the user to hit the Enter key.
wasSuccessful() - Method in class com.install4j.api.events.InstallerEvent
Return whether the operation associated with the event was successful
willActivate() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
willActivate() - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
willActivate() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
willActivate() - Method in interface com.install4j.api.screens.Screen
Called by the framework just before the screen is activated.
WinAssociations - Class in com.install4j.api.windows
Collection of static methods to create and remove file associations on Microsoft Windows.
WinEnvVars - Class in com.install4j.api.windows
Collection of static methods to get and modify environment variables on Windows.
WinEnvVars() - Constructor for class com.install4j.api.windows.WinEnvVars
 
WinFileSystem - Class in com.install4j.api.windows
Collection of static methods to access Microsoft Windows-specific folder locations and to execute native file system operations.
WinRegistry - Class in com.install4j.api.windows
Collection of static methods to access the Microsoft Windows registry.
WinRegistry.ExpandString - Class in com.install4j.api.windows
Class to represent Strings with type REG_EXPAND_SZ.
WinRegistry.ExpandString(String) - Constructor for class com.install4j.api.windows.WinRegistry.ExpandString
Constructor.
WizardContext - Interface in com.install4j.api.context
The wizard context allows you to modify the GUI installer or uninstaller.
writeMessage(String) - Static method in class com.install4j.api.launcher.SplashScreen
Update the status text line of the splash screen with a different message.

A B C D E F G H I J K L M N O P Q R S T U V W
install4j API