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

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
 
AbstractStyle - Class in com.install4j.api.styles
Abstract base class for styles.
AbstractStyle() - Constructor for class com.install4j.api.styles.AbstractStyle
 
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
 
acceptAllCertificates(boolean) - Method in class com.install4j.api.update.UpdateCheckRequest
Sets if an HTTPS connection should accept invalid certificates (not recommended for production).
Action - Interface in com.install4j.api.actions
The base interface for all actions.
ACTION_KEY_NO_ROLLBACK - Static variable in class com.install4j.api.beaninfo.ActionListPropertyDescriptor
Action key for properties of type ActionList that do not support rollback.
ActionBeanInfo - Class in com.install4j.api.beaninfo
Base class for BeanInfos of actions classes.
ActionBeanInfo(String, String, String, boolean, boolean, Integer, Class<? extends Action>) - Constructor for class com.install4j.api.beaninfo.ActionBeanInfo
ActionBeanInfo(String, String, String, boolean, boolean, Integer, Class<? extends Action>, Class) - Constructor for class com.install4j.api.beaninfo.ActionBeanInfo
ActionElevationType - Enum in com.install4j.api.beaninfo
Enumeration class for all possible elevation strategies for actions.
ActionList - Class in com.install4j.api.beans
Property type for a configurable list of actions.
ActionList() - Constructor for class com.install4j.api.beans.ActionList
 
ActionListInitializer - Interface in com.install4j.api.beaninfo
Interface for the ActionBeanInfo.ATTRIBUTE_ACTION_LIST_INITIALIZER value of a bean descriptor.
ActionListPropertyDescriptor - Class in com.install4j.api.beaninfo
Property descriptor for properties that contain a list of configurable actions.
ActionValidator - Interface in com.install4j.api.beaninfo
Validates actions if the validation depends on a containing ActionList property.
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.
activated() - Method in class com.install4j.api.styles.AbstractStyle
 
activated() - Method in interface com.install4j.api.styles.Style
This method is called by the framework just after a screen with this style has been activated.
activated() - Method in class com.install4j.api.styles.WrapperStyle
 
activated(Style) - Method in interface com.install4j.api.styles.StyleManager
Notify a nested style that it 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.
addDownloadProgressListener(InstallerDownloadEvent.DownloadProgressListener) - Method in class com.install4j.api.events.InstallerDownloadEvent
Add a progress listener that is informed how the progress download is progressing.
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.
addToClassPath(File) - Method in interface com.install4j.api.context.Context
Add a JAR file or a classpath directory root to the classpath of the installer application.
addUser(String, String, String, WinUser.GroupCreationMode, String, String) - Static method in class com.install4j.api.windows.WinUser
Add a user and optionally a local group.
AFTER_DOWNLOAD - com.install4j.api.events.EventType
Fired before a file has been downloaded.
AFTER_EXECUTE_ACTION - com.install4j.api.events.EventType
Fired after an action has been executed.
AFTER_INSTALL_FILE - com.install4j.api.events.EventType
Fired after a file has been installed.
AFTER_PROPERTIES - com.install4j.api.beaninfo.CustomizerPlacement
Place the customizer before the default "Properties" tab.
AFTER_ROLLBACK_ACTION - com.install4j.api.events.EventType
Fired after a rollback is performed
ALL_VALUES - Static variable in enum com.install4j.api.update.UpdateSchedule
Deprecated. 
ALWAYS - com.install4j.api.context.OverwriteMode
Indicates that if the destination file exists it will be replaced in any case.
ALWAYS - com.install4j.api.context.UninstallMode
Indicates that the uninstaller will always delete this file.
ALWAYS_ASK - 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 - 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 - com.install4j.api.context.UninstallMode
Indicates that the destination file won't be deleted when the uninstaller runs as part of an update.
ALWAYS_ERROR_MESSAGE - Static variable in class com.install4j.api.beans.VariableErrorHandlingDescriptor
Always replace undefined variables with an error message.
ALWAYS_EXCEPTION - Static variable in class com.install4j.api.beans.VariableErrorHandlingDescriptor
Always throw exceptions for undefined variables.
ALWAYS_IGNORE - Static variable in class com.install4j.api.beans.VariableErrorHandlingDescriptor
Ignore all undefined variables.
Anchor - Enum in com.install4j.api.beans
Property type for an anchor.
APPDATA - 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.
applicationDisplayMode(ApplicationDisplayMode) - Method in class com.install4j.api.update.UpdateCheckRequest
Sets the display mode that should be used if proxy information should be required
ApplicationDisplayMode - Enum in com.install4j.api.update
Enumeration class that represents the different display modes.
ApplicationLauncher - Class in com.install4j.api.launcher
This class allows you to launch an installer application, such as an updater, from your own application.
ApplicationLauncher() - Constructor for class com.install4j.api.launcher.ApplicationLauncher
 
ApplicationLauncher.Callback - Interface in com.install4j.api.launcher
You can implement this interface to receive notifications when the installer application exits or needs to shut down your application.
ApplicationLauncher.WindowMode - Enum in com.install4j.api.launcher
Window mode for starting the application in process.
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.
areInstalledLaunchersRunning() - Static method in class com.install4j.api.macos.MacProcesses
Determine if any of the installed launchers are currently running.
areInstalledLaunchersRunning() - Static method in class com.install4j.api.windows.WinProcesses
Determine if any of the installed launchers are currently running.
ASK_USER - com.install4j.api.beaninfo.FailureStrategy
Ask the user whether to continue or to quit.
ASK_USER_RETRY - com.install4j.api.beaninfo.FailureStrategy
Ask the user whether to continue, to retry or to quit.
askContinue(File) - Method in class com.install4j.api.context.DefaultUnattendedProgressInterface
Default implementation for unattended mode.
askContinue(File) - Method in interface com.install4j.api.context.ProgressInterface
Asks the user whether to continue after the specified file could not be installed.
askForProxy(boolean) - Method in class com.install4j.api.update.UpdateCheckRequest
Sets if a proxy config dialog should be shown if the connection fails.
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 class com.install4j.api.context.DefaultUnattendedProgressInterface
Default implementation for unattended mode.
askOverwrite(File) - Method in interface com.install4j.api.context.ProgressInterface
Asks the user whether the specified file should be overwritten.
askPassword(String, String) - Method in interface com.install4j.api.screens.Console
Ask the user to enter a password.
askRetry(File) - Method in class com.install4j.api.context.DefaultUnattendedProgressInterface
Default implementation for unattended mode.
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_ACTION_KEYS - Static variable in class com.install4j.api.beaninfo.ActionListPropertyDescriptor
 
ATTRIBUTE_ACTION_LIST_HIDDEN_KEYS - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
 
ATTRIBUTE_ACTION_LIST_INITIALIZER - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
ATTRIBUTE_ACTION_LIST_SHOWN_KEYS - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
 
ATTRIBUTE_ACTION_VALIDATOR - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
ATTRIBUTE_ALLOW_TEXT_OVERRIDE - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
 
ATTRIBUTE_ALLOWED_ACTION_CLASSES - Static variable in class com.install4j.api.beaninfo.ActionListPropertyDescriptor
 
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_CONFIRMATION_VISIBILITY_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_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_CATEGORY_SORT_ORDER - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_CODE_GALLERY_TAGS - Static variable in class com.install4j.api.beaninfo.ScriptPropertyDescriptor
 
ATTRIBUTE_COLLAPSED_PROPERTY_CATEGORIES - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_COMPLEMENTARY_STARTUP_LINK - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
ATTRIBUTE_CONFIGURABLE_ELEVATION_TYPE - Static variable in class com.install4j.api.beaninfo.ActionListPropertyDescriptor
 
ATTRIBUTE_CONTEXT - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
 
ATTRIBUTE_CUSTOMIZER_ICON - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_CUSTOMIZER_PLACEMENT - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_DEFAULT_ACTION_ELEVATION_TYPE - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
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_MULTI_EXEC - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
ATTRIBUTE_DEFAULT_POST_ACTIVATION_SCRIPT - Static variable in class com.install4j.api.beaninfo.ScreenBeanInfo
 
ATTRIBUTE_DEFAULT_PRE_ACTIVATION_SCRIPT - Static variable in class com.install4j.api.beaninfo.ScreenBeanInfo
 
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_DEFAULT_ROLLBACK_BARRIER_EXIT_CODE - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_DEFAULT_STYLE_NAME - Static variable in class com.install4j.api.beaninfo.ScreenBeanInfo
 
ATTRIBUTE_DEFAULT_VISIBILITY_SCRIPT - Static variable in class com.install4j.api.beaninfo.FormComponentBeanInfo
 
ATTRIBUTE_EMPTY_MESSAGE - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
 
ATTRIBUTE_ENUMERATION_MAPPERS - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_EXTRA_SCRIPT_PARAMETERS - Static variable in class com.install4j.api.beaninfo.ActionListPropertyDescriptor
 
ATTRIBUTE_FILE_CONTENT_TYPE - Static variable in class com.install4j.api.beaninfo.FilePropertyDescriptor
 
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
Deprecated.
no longer used
ATTRIBUTE_FULL_PRIVILEGES_REQUIRED - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
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_NOTICE_PANEL - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_PARENT_PROPERTY - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
 
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_PROPERTY_CHANGE_LISTENER - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
 
ATTRIBUTE_PROPERTY_CONVERTERS - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
 
ATTRIBUTE_RESTRICT_ACTION_ELEVATION_TYPE - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
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_SUGGESTED_VALUES - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
 
ATTRIBUTE_UNINSTALLER_STARTUP_ACTION - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
ATTRIBUTE_UNINSTALLER_TARGET_SCREEN - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
 
ATTRIBUTE_VARIABLE_VALUE_CLASS - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
 
ATTRIBUTE_VISIBILITY_DISCRIMINATOR - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
 
AUTO - com.install4j.api.windows.service.ServiceStartType
 
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

background(Color) - Method in class com.install4j.api.context.WizardIndex
Sets the background color of the index panel.
backgroundImage(File) - Method in class com.install4j.api.context.WizardIndex
Sets the background image file.
backgroundImageAnchor(Anchor) - Method in class com.install4j.api.context.WizardIndex
Sets the anchor for the background image file.
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_DOWNLOAD - com.install4j.api.events.EventType
Fired before a file is downloaded.
BEFORE_EXECUTE_ACTION - com.install4j.api.events.EventType
Fired before an action is executed
BEFORE_INSTALL_FILE - com.install4j.api.events.EventType
Fired before a file is installed.
BEFORE_PROPERTIES - com.install4j.api.beaninfo.CustomizerPlacement
Place the customizer after the default "Properties" tab.
BEFORE_ROLLBACK_ACTION - com.install4j.api.events.EventType
Fired before a rollback is performed
binaryName(String) - Method in class com.install4j.api.windows.service.ServiceConfiguration
The path to the binary.
bindTextWithVariables(String, JComponent) - Method in interface com.install4j.api.formcomponents.FormEnvironment
Set text with unresolved variables on a JLabel or JTextComponent.
BIT32 - com.install4j.api.windows.RegistryView
Always use the 32-bit view stored in the special Wow6432Node key.
BIT64 - com.install4j.api.windows.RegistryView
Always use the 64-bit view.

C

cancel() - Method in interface com.install4j.api.beaninfo.PropertyCustomizer
Called if the property customizer dialog is exited with the Cancel button.
cancel() - Method in interface com.install4j.api.context.Context
Cancel the installer application without asking any questions.
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.
CANCEL - com.install4j.api.beans.ErrorHandlingMode
Cancel the current operation.
CANCEL - com.install4j.api.context.ControlButtonType
The button to cancel the installer application.
CANCELED - com.install4j.api.events.EventType
Fired just before the installer or uninstaller quits after having been cancelled.
CANCELLING - 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.
CDROM - com.install4j.api.windows.DriveType
A CD-ROM.
CENTER - com.install4j.api.beans.Anchor
 
change(String, ServiceConfiguration) - Static method in class com.install4j.api.windows.service.WinServices
Changes a service configuration.
checkAndReset() - Static method in class com.install4j.api.update.UpdateScheduleRegistry
Checks if you should check for an update.
checkApplicationId(File) - Static method in class com.install4j.api.ApplicationRegistry
Checks 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.
checkedForUpdate() - Static method in class com.install4j.api.update.UpdateScheduleRegistry
Tells the registry that the current time should be set as the last update check date.
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.
checkVersionCompatible(String) - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Checks if a version is compatible with the minimum and maximum updatable versions and lower than the new version of this update descriptor entry.
clearInstallerVariablesCache() - Static method in class com.install4j.api.launcher.Variables
Clear the cache of read installer variables.
cloneStyleById(String) - Method in interface com.install4j.api.styles.StyleManager
Clones a style for a specified ID.
closeProcesses(int[], int) - Static method in class com.install4j.api.windows.WinProcesses
Tries to close the processes with the given ids by sending a WM_CLOSE message to all visible top-level windows.
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.macos - package com.install4j.api.macos
This package contains classes with static utility methods for using macOS-specific features that are not directly supported by the Java platform.
com.install4j.api.screens - package com.install4j.api.screens
This package contains the interfaces and abstract base classes for screens.
com.install4j.api.styles - package com.install4j.api.styles
This package contains the interface and abstract base class for styles.
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.update - package com.install4j.api.update
This package contains classes that help you to handle auto-updates.
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.
com.install4j.api.windows.service - package com.install4j.api.windows.service
This package contains classes to manipulate Windows services.
ComponentTuple - Interface in com.install4j.api.formcomponents
Represents the created GUI components for a form component.
connectTimeout(int) - Method in class com.install4j.api.update.UpdateCheckRequest
Sets the connect timeout in milliseconds for the HTTP connection.
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.
CONSOLE - com.install4j.api.context.LauncherType
Represents a console launcher.
CONSOLE - com.install4j.api.update.ApplicationDisplayMode
The invoking application runs on the command line.
Context - Interface in com.install4j.api.context
Base class for installation and uninstallation context.
CONTEXT_ANCHOR_CORNERS - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Special context for properties of type Anchor that tells the install4j GUI to offer only the corner values of the anchor (north-west, north-east, south-west, south-east).
CONTEXT_ANCHOR_HORIZONTAL - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Special context for properties of type Anchor that tells the install4j GUI to offer only the horizontal values of the anchor (west, center, east).
CONTEXT_ANCHOR_SIDES - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Special context for properties of type Anchor that tells the install4j GUI to offer only the side values of the anchor (north, west, east, south).
CONTEXT_ANCHOR_VERTICAL - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Special context for properties of type Anchor that tells the install4j GUI to offer only the vertical values of the anchor (north, center, south).
CONTEXT_COMPONENT_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 an installation component.
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_DOWNLOADABLE_COMPONENT_ID - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Same as Install4JPropertyDescriptor.CONTEXT_COMPONENT_ID, but only downloaded installation components are selectable.
CONTEXT_EXTERNAL_OR_INTERNAL - Static variable in class com.install4j.api.beaninfo.FilePropertyDescriptor
Special context for properties of type com.install4j.api.beans.ExternalFile that tells the install4j GUI to offer the user the possibility to select a file from the distribution tree instead.
CONTEXT_FORM_COMPONENT_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 form component.
CONTEXT_HTML - 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 an HTML document in a separate editor with syntax coloring and preview functionality.
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_NO_INSTALLER_VARIABLES - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Special context for properties of type java.lang.String and java.io.File that tells the install4j GUI not to offer installer variables in the text field for the property.
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.
CONTEXT_STRING_TO_STRING_MAP - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Special context for properties of type java.util.LinkedHashMap that tells the install4j GUI that the map contains string keys and values and to offer a suitable converter and property customizer.
CONTEXT_STYLE_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 style.
CONTEXT_VARIABLE_NAME - 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 an installer variable name.
CONTINUE - com.install4j.api.beaninfo.FailureStrategy
Continue after a failure.
ControlButton - Interface in com.install4j.api.styles
Implemented by form components that want to handle navigation functionality for a style.
ControlButtonContainer - Interface in com.install4j.api.styles
Implemented by objects that handle navigation functionality.
ControlButtonType - Enum in com.install4j.api.context
Types of navigations buttons in the user interface.
create(String, Class, String, String) - Static method in class com.install4j.api.beaninfo.ActionListPropertyDescriptor
Create a property descriptor that can be passed to Install4JBeanInfo.addPropertyDescriptor(Install4JPropertyDescriptor).
create(String, Class, String, String) - Static method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
create(String, Class, String, String, FileSelectionMode) - Static method in class com.install4j.api.beaninfo.FilePropertyDescriptor
create(String, Class, String, String, FileSelectionMode, String) - Static method in class com.install4j.api.beaninfo.FilePropertyDescriptor
create(String, Class, String, String, FileSelectionMode, String[], String) - Static method in class com.install4j.api.beaninfo.FilePropertyDescriptor
create(String, Class, String, String, FileSelectionMode, String[], 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, 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, 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, String, File, File) - Static method in class com.install4j.api.windows.WinAssociations
Creates a file association.
CREATE_IF_NECESSARY - com.install4j.api.windows.WinUser.GroupCreationMode
If the specified group does not exist, create it.
CREATE_OR_FAIL - com.install4j.api.windows.WinUser.GroupCreationMode
Fail if the group already exists.
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.
createComponent() - Method in interface com.install4j.api.styles.Style
Create the UI component for the style.
createComponent() - Method in class com.install4j.api.styles.WrapperStyle
 
createComponent(JComponent) - Method in class com.install4j.api.styles.WrapperStyle
Create the UI component for the style.
createKey(RegistryRoot, String) - Static method in class com.install4j.api.windows.WinRegistry
Creates a registry key.
createKey(RegistryRoot, String, RegistryView) - 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.
createShellLink(File, File, File, String, String, File) - Static method in class com.install4j.api.windows.WinFileSystem
Creates a shell link.
createShellLink(File, File, File, String, String, File, ShowCommand) - 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.
createStartMenuEntry(String, String, File, boolean, File, String) - Static method in class com.install4j.api.windows.WinFileSystem
Creates a start menu entry.
createStartMenuEntry(String, String, File, boolean, File, String, boolean) - Static method in class com.install4j.api.windows.WinFileSystem
Creates a start menu entry.
createStyleComponent(Style) - Method in interface com.install4j.api.styles.StyleManager
Create a style component.
CustomizerCallback - Interface in com.install4j.api.beaninfo
Extended design-time services for customizers.
CustomizerPlacement - Enum in com.install4j.api.beaninfo
Enumeration class for all possible placements of the customizer in the install4j GUI.

D

DAILY - com.install4j.api.update.UpdateSchedule
UpdateScheduleRegistry.checkAndReset() always returns true after more than one day has passed since the last update
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.
deactivated() - Method in class com.install4j.api.styles.AbstractStyle
 
deactivated() - Method in interface com.install4j.api.styles.Style
This method is called by the framework just after a screen with this style has been deactivated.
deactivated() - Method in class com.install4j.api.styles.WrapperStyle
 
deactivated(Style) - Method in interface com.install4j.api.styles.StyleManager
Notify a nested style that it has been deactivated.
DEFAULT - com.install4j.api.windows.RegistryView
Use the 32-bit view for a 32-bit, and the 64-bit view for a 64-bit process.
DEFAULT - Static variable in class com.install4j.api.beans.VariableErrorHandlingDescriptor
The default error handling.
DEFAULT_CONTEXT - Static variable in interface com.install4j.api.beaninfo.EnumerationMapper
A default context that you can use in the EnumerationMapper.getContext() method if there is only one enumeration mapper for the property type returned byEnumerationMapper.getEnumerationClass()}
DEFAULT_CONTEXT - Static variable in interface com.install4j.api.beaninfo.PropertyConverter
A default context that you can use in the PropertyConverter.getContext() method if there is only one property converter for the property type returned by PropertyConverter.getPropertyClass()
DEFAULT_MODE - Static variable in class com.install4j.api.context.FileOptions
The default file mode on Unix and macOS ("644").
DefaultUnattendedProgressInterface - Class in com.install4j.api.context
Default implementation of UnattendedProgressInterface.
DefaultUnattendedProgressInterface() - Constructor for class com.install4j.api.context.DefaultUnattendedProgressInterface
 
delayedAutoStart(Boolean) - Method in class com.install4j.api.windows.service.ServiceConfiguration
If startType is set to AUTO, you can specify with this property that the service is started with a short delay after all other auto-start services.
deleteKey(RegistryRoot, String, boolean) - Static method in class com.install4j.api.windows.WinRegistry
Deletes a registry key.
deleteKey(RegistryRoot, String, boolean, RegistryView) - Static method in class com.install4j.api.windows.WinRegistry
Deletes a registry key.
deleteLocalGroup(String) - Static method in class com.install4j.api.windows.WinUser
Delete a local group.
deleteUser(String) - Static method in class com.install4j.api.windows.WinUser
Delete a user.
deleteValue(RegistryRoot, String, String) - Static method in class com.install4j.api.windows.WinRegistry
Deletes a registry value.
deleteValue(RegistryRoot, String, String, RegistryView) - Static method in class com.install4j.api.windows.WinRegistry
Deletes a registry value.
DEMAND - com.install4j.api.windows.service.ServiceStartType
 
dependencies(String) - Method in class com.install4j.api.windows.service.ServiceConfiguration
A comma separated list of dependencies
description(String) - Method in class com.install4j.api.windows.service.ServiceConfiguration
An additional description for the service
DESKTOP - com.install4j.api.windows.SpecialFolder
Identifies the file system directory used to physically store file objects on the desktop.
DIALOG - com.install4j.api.launcher.ApplicationLauncher.WindowMode
Shows the wizard in a modal dialog.
DIRECTORIES_ONLY - com.install4j.api.beaninfo.FileSelectionMode
Only show directories in the file chooser.
DIRECTORY_CREATED - com.install4j.api.events.EventType
Fired after a directory has been installed.
DISABLED - com.install4j.api.windows.service.ServiceStartType
 
displayName(String) - Method in class com.install4j.api.windows.service.ServiceConfiguration
The display name.
DOCS - com.install4j.api.windows.SpecialFolder
Identifies the file system directory used to physically store a user's common repository of documents.
downloadCompleted(long) - Method in interface com.install4j.api.events.InstallerDownloadEvent.DownloadProgressListener
Indicates download progress.
DriveType - Enum in com.install4j.api.windows
Enumeration class for the different drive types a file can be located on.
dumpVariables(Context) - Static method in class com.install4j.api.Util
Dump all defined installer variables to stderr.

E

EAST - com.install4j.api.beans.Anchor
 
ELEVATE - com.install4j.api.beaninfo.ActionElevationType
If elevated privileges are available, the action will be run in the elevated helper process.
Elevation - Class in com.install4j.api.windows
Collection of methods regarding the UAC elevation state on Windows Vista or higher.
ELEVATION_STATE_DEFAULT - com.install4j.api.windows.ElevationState
The current process is not limited and not elevated on Vista or higher.
ELEVATION_STATE_FULL - com.install4j.api.windows.ElevationState
The current process was elevated and runs with full rights.
ELEVATION_STATE_LIMITED - com.install4j.api.windows.ElevationState
The current process runs with limited rights.
ELEVATION_STATE_NOT_APPLICABLE - com.install4j.api.windows.ElevationState
All processes on a system with a Windows version previous to Vista.
ElevationState - Enum in com.install4j.api.windows
Enumeration class for the different elevation states the current process can be in.
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.
EnumerationMapEntry(String, Object, Icon) - 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.ExternalFile
 
equals(Object) - Method in class com.install4j.api.beans.ScriptProperty
 
equals(Object) - Method in class com.install4j.api.ProcessInfo
 
ERROR_ACCESS_DENIED - com.install4j.api.windows.WinUser.AddUserResultType
The current user has no access to the user database or the operation is only allowed on the primary domain controller of the domain.
ERROR_BAD_USER_NAME - com.install4j.api.windows.WinUser.AddUserResultType
The user name is invalid.
ERROR_GROUP_EXISTS - com.install4j.api.windows.WinUser.AddUserResultType
The group that should be newly created already exists.
ERROR_GROUP_NOT_FOUND - com.install4j.api.windows.WinUser.AddUserResultType
The group that should already exist could not be found.
ERROR_MESSAGE - com.install4j.api.beans.VariableErrorHandling
Replace an undefined variable with an error message
ERROR_OTHER - com.install4j.api.windows.WinUser.AddUserResultType
Another type of error occurred during user creation.
ERROR_PASSWORD_REQUIREMENTS - com.install4j.api.windows.WinUser.AddUserResultType
The password does not meet the password policy requirements.
ERROR_USER_EXISTS - com.install4j.api.windows.WinUser.AddUserResultType
The group that should already exist could not be found.
errorHandlingCallback(ErrorHandlingCallback) - Method in class com.install4j.api.update.UpdateCheckRequest
Sets the callback for handling network errors.
ErrorHandlingCallback - Interface in com.install4j.api.beans
Callback for deciding how an error should be handled.
ErrorHandlingMode - Enum in com.install4j.api.beans
Indicates the action that should be taken after an error has occurred.
errorOccurred(Exception) - Method in interface com.install4j.api.beans.ErrorHandlingCallback
Called when an error has occurred.
EventType - Enum in com.install4j.api.events
Enumeration class that represents all different event types for instances of InstallerEvent.
EXCEPTION - com.install4j.api.beans.VariableErrorHandling
Throw an exception if an undefined variable is found
execute() - Method in interface com.install4j.api.context.RemoteCallable
The method that will be executed within the requested account.
executeActionListAsync(ActionList, Object...) - Static method in class com.install4j.api.beans.AbstractBean
Asynchronously execute an action list.
executeActionListSync(ActionList, Object...) - Static method in class com.install4j.api.beans.AbstractBean
Synchronously execute an action list.
executeElevated(File, String, File) - Static method in class com.install4j.api.windows.Elevation
Runs an executable in elevated state.
executeScheduledUpdate(List<String>, boolean, Runnable) - Static method in class com.install4j.api.update.UpdateChecker
If an update is scheduled for installation execute the update installer and shutdown the current launcher.
executeScheduledUpdate(List<String>, boolean, List<String>, Runnable) - Static method in class com.install4j.api.update.UpdateChecker
If an update is scheduled for installation execute the update installer and shutdown the current launcher.
exists() - Method in class com.install4j.api.beans.ExternalFile
 
exists(String) - Static method in class com.install4j.api.windows.WinAssociations
Checks whether a file association already exists.
exited(int) - Method in interface com.install4j.api.launcher.ApplicationLauncher.Callback
Invoked when the installer application has exited.
ExpandString(String) - Constructor for class com.install4j.api.windows.WinRegistry.ExpandString
Constructor.
EXTERNAL - 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 - Enum 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 - com.install4j.api.windows.SpecialFolder
Identifies the file system directory that serves as a common repository for the user's favorite items.
FILE_INSTALLATION_STARTED - com.install4j.api.events.EventType
Fired before the file installation is started by the "Install files" action.
FileContentType - Enum in com.install4j.api.beaninfo
Enumeration class for all possible file content types for file property descriptors.
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(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, boolean, UninstallMode) - 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.
FileOptions(String, OverwriteMode, boolean) - Constructor for class com.install4j.api.context.FileOptions
Initializes a FileOptions instance.
FilePropertyDescriptor - Class in com.install4j.api.beaninfo
Property descriptor for properties that contain one or several file.
FILES_AND_DIRECTORIES - com.install4j.api.beaninfo.FileSelectionMode
Show both files and directories in the file chooser.
FILES_ONLY - com.install4j.api.beaninfo.FileSelectionMode
Only show files in the file chooser.
FileSelectionMode - Enum in com.install4j.api.beaninfo
Enumeration class for all possible file selection modes for file property descriptors.
FileSetSetup - Interface in com.install4j.api.context
This interface provides information about file sets.
findExecutableInPath(String) - Static method in class com.install4j.api.unix.UnixFileSystem
Returns the absolute path of an executable if it is located on the path.
findPropertyDescriptor(String) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Convenience method for bean validators to find the property descriptor for a named property.
finish(int) - Method in interface com.install4j.api.context.Context
Quits the process in an ordered manner.
FINISHED - com.install4j.api.events.EventType
Fired just before the installer or uninstaller quits.
FINISHING - com.install4j.api.events.EventType
Fired when the installer or uninstaller quits but before any cleanup has been performed.
FIXED - com.install4j.api.windows.DriveType
A fixed (local) drive.
focusControlButton() - Method in interface com.install4j.api.styles.ControlButton
Called when the control button is focused.
focusControlButton(ControlButtonType) - Method in interface com.install4j.api.context.WizardContext
Transfer the focus to a particular control button.
focusControlButton(ControlButtonType) - Method in interface com.install4j.api.styles.ControlButtonContainer
Called when a control button is focused.
focusControlButton(ControlButtonType) - Method in class com.install4j.api.styles.WrapperStyle
 
focusNextButton() - Method in interface com.install4j.api.context.WizardContext
FONTS - com.install4j.api.windows.SpecialFolder
Identifies a virtual folder containing fonts.
foreground(Color) - Method in class com.install4j.api.context.WizardIndex
Sets the foreground color of the index panel.
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, boolean, Integer, Class<? extends FormComponent>, Class) - Constructor for class com.install4j.api.beaninfo.FormComponentBeanInfo
FormComponentBeanInfo(String, String, String, Integer, Class<? extends FormComponent>) - Constructor for class com.install4j.api.beaninfo.FormComponentBeanInfo
FormComponentBeanInfo(String, String, String, Integer, Class<? extends FormComponent>, Class) - Constructor for class com.install4j.api.beaninfo.FormComponentBeanInfo
Same as Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class, Class) with multipleInstancesSupported set to true and installedFilesRequired set to false.
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.
FormPanelContainer - Interface in com.install4j.api.screens
Any screen can have a form panel, just like the "Additional confirmations" screen or the "Configurable form" screen.
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.
FRAME - com.install4j.api.launcher.ApplicationLauncher.WindowMode
Shows the wizard in a frame.
fromString(String) - Method in interface com.install4j.api.beaninfo.PropertyConverter
Converts a string representation to an object of type PropertyConverter.getPropertyClass().

G

getAccountName() - Method in enum com.install4j.api.windows.service.ServiceAccount
 
getAccountName(String) - Static method in class com.install4j.api.windows.WinUser
Try to get an account name for a SID (Security Identifier).
getActionById(String) - Method in interface com.install4j.api.context.Context
Get a particular action with the specified ID.
getActionId() - Method in class com.install4j.api.events.InstallerActionEvent
Returns the ID of the action.
getActions(Screen) - Method in interface com.install4j.api.context.Context
Get all registered actions for a specified screen.
getActions(Class<? extends Action>, Screen) - Method in interface com.install4j.api.context.Context
Get all registered actions for a specified screen and a given action class.
getAdditionalAttribute(String, String) - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Returns an additional attribute that you have added to the entry element in the updates.xml file represented by this instance.
getAddOnApplicationId() - Method in interface com.install4j.api.context.Context
Returns the add on application id if this project generates add-on installers.
getAddOnApplicationInfoByDir(File) - Static method in class com.install4j.api.ApplicationRegistry
Checks if the specified directory contains an application installed by install4j and retrieves information about the add-on installers in it.
getAnchor() - Method in interface com.install4j.api.beans.VisualContainerBean
Returns the position where the visual component should be anchored.
getAnchor() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
Returns a default value for the anchor of the screen component.
getAnchor() - Method in class com.install4j.api.screens.AbstractInstallerScreen
Returns a default value for the anchor of the screen component.
getAnchor() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
Returns a default value for the anchor of the screen component.
getAnchor() - Method in class com.install4j.api.styles.AbstractStyle
Returns a default value for the anchor of the style component.
getAnnotatedStackTrace(Throwable) - Static method in class com.install4j.api.Util
If a stack trace comes from scripts, it can be difficult to trace them to their origin by looking at the stack trace alone.
getApplicationDisplayMode() - Method in class com.install4j.api.update.UpdateCheckRequest
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.
getApplicationName() - Method in interface com.install4j.api.context.Context
Returns the name of the application.
getBackground() - Method in class com.install4j.api.context.WizardIndex
Returns the background color of the index panel
getBackgroundImage() - Method in class com.install4j.api.context.WizardIndex
Returns the background image file.
getBackgroundImageAnchor() - Method in class com.install4j.api.context.WizardIndex
Returns the anchor for the background image file.
getBaseUrl() - Method in interface com.install4j.api.update.UpdateDescriptor
Returns the base URL from which update installers will be downloaded.
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
 
getBinary(String) - Static method in class com.install4j.api.windows.service.WinServices
Returns the registered binary of a service.
getBooleanVariable(String) - Method in interface com.install4j.api.context.Context
Convenience method to get an installer variable with a type of java.lang.Boolean.
getBundledJre() - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Returns the identifier of the bundled JRE.
getBundleIdentifier() - Method in class com.install4j.api.macos.MacProcesses.Info
The bundle identifier of the application.
getById(String) - Static method in enum com.install4j.api.update.UpdateSchedule
Returns the UpdateSchedule for a string ID.
getByValue(int) - Static method in enum com.install4j.api.beans.Anchor
Get the anchor constant that corresponds to the specified value
getCenterComponent() - Method in interface com.install4j.api.formcomponents.ComponentTuple
Return the center GUI component created by FormComponent.createCenterComponent.
getChildren() - Method in interface com.install4j.api.formcomponents.LayoutGroup
Get the children of this layout group.
getClassName() - Method in class com.install4j.api.windows.WindowInfo
Returns the window class name.
getComment() - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Returns the comment for this entry.
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.ApplicationRegistry.ApplicationInfo
Get the value of a compiler variable of the application.
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.
getCompilerVariable(String) - Static method in class com.install4j.api.launcher.Variables
Get the value of a compiler variable.
getCompilerVariables() - Method in class com.install4j.api.beans.VariableErrorHandlingDescriptor
Returns the error handling for compiler variables.
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.
getConnectTimeout() - Method in class com.install4j.api.update.UpdateCheckRequest
Returns the value set with UpdateCheckRequest.connectTimeout(int) The default value is 10000 ms.
getContentComponent() - Method in interface com.install4j.api.styles.StyleContext
Returns the UI component of the current Screen as returned by Screen.createComponent().
getContentDirectory() - Method in interface com.install4j.api.context.Context
Retrieves the directory that is mapped to the "Installation directory" in the distribution tree.
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 interface com.install4j.api.beaninfo.PropertyConverter
The property descriptor of a property that wants to use this property converter 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.
getContext() - Method in class com.install4j.api.styles.AbstractStyle
Returns the Context that the framework has associated with this form component in AbstractStyle.setContext(Context).
getControlButtonType() - Method in interface com.install4j.api.styles.ControlButton
Called by the framework to check the type of the control button.
getCustomizerTabName() - Method in exception com.install4j.api.beaninfo.BeanValidationException
Get the name of the customizer tab that was set with setCustomizerTabName.
getDefaultInstallationDirectory() - Method in interface com.install4j.api.context.Context
Retrieves the default installation directory configured in the install4j IDE.
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.
getDesignTimeName(LayoutGroup) - Method in interface com.install4j.api.formcomponents.FormEnvironment
At design time, the install4j GUI allows the user to name instances of layout groups in a form.
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.
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.
getDestinationFileInfo(String) - Method in interface com.install4j.api.context.Context
Analyze a path in the distribution tree.
getDirectory() - Method in class com.install4j.api.events.InstallerDirectoryEvent
Get the created directory that is associated with this event.
getDisplayedName() - Method in class com.install4j.api.macos.MacProcesses.Info
The displayed name of the application.
getDownloadFile() - Method in class com.install4j.api.events.InstallerDownloadEvent
Returns the file where the download is saved.
getDownloadProgressListeners() - Method in class com.install4j.api.events.InstallerDownloadEvent
Get the complete set of download progress listeners.
getDownloadSize() - Method in class com.install4j.api.events.InstallerDownloadEvent
Returns the size for the download in bytes.
getDriveType(File) - Static method in class com.install4j.api.windows.WinFileSystem
Tests on what kind of drive the given file is (or would be) located.
getDuration() - Method in class com.install4j.api.events.InstallerActionEvent
Returns the duration of the action in milliseconds
getElevationState() - Static method in class com.install4j.api.windows.Elevation
Returns the elevation state of the current process.
getEntries() - Method in interface com.install4j.api.update.UpdateDescriptor
Returns all descriptor entries for the different media files of the available version.
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() - Static method in class com.install4j.api.windows.WinEnvVars
Returns all environment variables.
getenv(String) - Static method in class com.install4j.api.windows.WinEnvVars
Returns a single environment variable.
getErrorHandlingCallback() - Method in class com.install4j.api.update.UpdateCheckRequest
getException() - Method in class com.install4j.api.events.InstallerActionEvent
The exception if the action terminated abnormally or null.
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.
getExternalFile(LocalizedExternalFile, boolean) - Method in interface com.install4j.api.context.Context
Get the location of a localized external file that was packaged with the installer.
getExtraCommandLineArguments() - Method in interface com.install4j.api.context.Context
Returns an array with the command line arguments that were not recognized by install4j.
getFileCount() - Method in class com.install4j.api.events.InstallerFileInstallationEvent
Returns the total file count
getFileInformation(File) - Static method in class com.install4j.api.unix.UnixFileSystem
Get Unix-specific information about a file.
getFileName() - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Returns the file name of the update installer.
getFileSetById(String) - Method in interface com.install4j.api.context.Context
Returns the file set for a specified ID.
getFileSetByName(String) - Method in interface com.install4j.api.context.Context
Returns one file set with the specified name.
getFilesetId() - Method in interface com.install4j.api.context.FileInfo
Get the id of the fileset or a zero length string for the default fileset.
getFilesetName() - Method in interface com.install4j.api.context.FileInfo
Get the name of the fileset, a zero length string for the default fileset, or null if the fileset is non-existent.
getFileSets() - Method in interface com.install4j.api.context.Context
Returns all additional files sets contained in this installer.
getFileSize() - Method in class com.install4j.api.events.InstallerFileEvent
Get the size of the installed file in bytes.
getFileSize() - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Returns the file size of the update installer in bytes.
getFileSizeVerbose() - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Returns the file size of the update installer as a verbose string.
getFileTime() - Method in class com.install4j.api.context.FileOptions
Returns the file time.
getFirstAction(Class<? extends Action>, Screen) - Method in interface com.install4j.api.context.Context
Get the registered action for a specified screen and a given action class.
getFirstFormComponent(Class<T>) - Method in interface com.install4j.api.formcomponents.FormEnvironment
Get the form component for a given class or interface.
getFirstScreen(Class) - Method in interface com.install4j.api.context.Context
Get the registered screen for a given screen class.
getForeground() - Method in class com.install4j.api.context.WizardIndex
Returns the foreground color of the index panel used for the text color
getFormComponentById(String) - Method in interface com.install4j.api.formcomponents.FormEnvironment
Get the form component for a specified ID.
getFormComponents() - Method in interface com.install4j.api.formcomponents.FormEnvironment
Returns all form components that are contained in the same form.
getFormComponents(Class<T>) - Method in interface com.install4j.api.formcomponents.FormEnvironment
Get all form components for a given class or interface.
getFormComponentTree() - Method in interface com.install4j.api.formcomponents.FormEnvironment
Returns the top level of the tree of form components.
getFormEnvironment() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
Returns the FormEnvironment that the framework has associated with this form component in setFormEnvironment.
getFormEnvironment() - Method in interface com.install4j.api.screens.FormPanelContainer
Returns the form environment that was set with FormPanelContainer.setFormPanel(JPanel, FormEnvironment) .
getFormVariable(String) - Method in interface com.install4j.api.formcomponents.FormEnvironment
Get the value of a form variable.
getFormVariableNames() - Method in interface com.install4j.api.formcomponents.FormEnvironment
Get the names of all defined form variables.
getFormVariables() - Method in class com.install4j.api.beans.VariableErrorHandlingDescriptor
Returns the error handling for form variables.
getFreeDiskSpace(File) - Static method in class com.install4j.api.SystemInfo
Retrieves the free disk space for the disk containing the given file on Windows, macOS and Linux.
getFromIntValue(int) - Static method in enum com.install4j.api.context.OverwriteMode
Convert int value to constant.
getFromIntValue(int) - Static method in enum com.install4j.api.context.UninstallMode
Convert int value to constant.
getFromIntValue(int) - Static method in enum com.install4j.api.update.ApplicationDisplayMode
Convert int value to constant.
getFromIntValue(int) - Static method in enum com.install4j.api.windows.DriveType
Convert int value to constant.
getFromRegistry(String, boolean) - Static method in class com.install4j.api.windows.WinEnvVars
Return an environment variable as set in the Windows registry.
getGroupSid() - Method in class com.install4j.api.windows.WinUser.AddUserResult
The SID (Security Identifier) of the used group in String form.
getGroupType() - Method in interface com.install4j.api.formcomponents.LayoutGroup
Returns the type of the layout group
getHwnd() - Method in class com.install4j.api.windows.WindowInfo
Returns the window handle.
getI18nKeys() - Method in class com.install4j.api.beans.VariableErrorHandlingDescriptor
Returns the error handling for localization keys.
getIcon() - Method in class com.install4j.api.beaninfo.EnumerationMapEntry
Get the icon that is to be displayed in the drop-down list in the IDE.
getId() - Method in interface com.install4j.api.ApplicationRegistry.ApplicationInfo
Returns the application ID.
getId() - Method in enum com.install4j.api.beaninfo.ActionElevationType
Convert to an int value.
getId() - Method in enum com.install4j.api.beaninfo.FailureStrategy
Convert to an int value.
getId() - Method in class com.install4j.api.beans.ActionList
Called by the framework.
getId() - Method in interface com.install4j.api.context.FileSetSetup
The ID of the file set.
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() - Method in interface com.install4j.api.formcomponents.LayoutGroup
Get the ID that the framework associates with this layout group.
getId() - Method in enum com.install4j.api.update.UpdateSchedule
Returns the string ID for the UpdateSchedule.
getId(Action) - Method in interface com.install4j.api.context.Context
Get the ID that the framework associates with an action.
getId(FormComponent) - Method in interface com.install4j.api.formcomponents.FormEnvironment
Get the ID that the framework associates with a form component.
getId(Screen) - Method in interface com.install4j.api.context.Context
Get the ID that the framework associates with a screen.
getInitialKey() - Method in class com.install4j.api.context.WizardIndex
Returns the key of the step name that should be initially selected
getInitValue(Object, String, Class<?>) - Method in class com.install4j.api.formcomponents.AbstractFormComponent
Helper method to get an init value.
getInsertIndex(Bean, List<Bean>) - 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.
getInstallerVariable(String) - Method in interface com.install4j.api.ApplicationRegistry.ApplicationInfo
Get the value of an installer variable that was saved to the automatically created response file response.varfile.
getInstallerVariable(String) - Static method in class com.install4j.api.launcher.Variables
Get the value of an installer variable that was saved to the automatically created response file response.varfile.
getInstallerVariables() - Method in class com.install4j.api.beans.VariableErrorHandlingDescriptor
Returns the error handling for installer variables.
getInstallerVariables() - Static method in class com.install4j.api.launcher.Variables
Get a map of installer variables that were saved to the automatically created response file response.varfile.
getIntValue() - Method in enum com.install4j.api.context.OverwriteMode
Convert to an int value.
getIntValue() - Method in enum com.install4j.api.context.UninstallMode
Convert to an int value.
getIntValue() - Method in enum com.install4j.api.update.ApplicationDisplayMode
Convert to an int value.
getIntValue() - Method in enum com.install4j.api.windows.DriveType
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 enum 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 specified 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.
getKeys() - Method in class com.install4j.api.context.WizardIndex
Returns the index keys
getLanguageId() - Method in interface com.install4j.api.context.Context
Return the ISO code for the language that the installer is running with.
getLanguageIdToExternalFile() - Method in class com.install4j.api.beans.LocalizedExternalFile
Returns the map from language IDs to ExternalFiles.
getLastUpdateCheckDate() - Static method in class com.install4j.api.update.UpdateScheduleRegistry
Returns the date you last called UpdateScheduleRegistry.checkAndReset() and got a return value of true.
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.
getLayoutGroupById(String) - Method in interface com.install4j.api.formcomponents.FormEnvironment
Get the layout group of a certain ID.
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.
getLog() - Method in class com.install4j.api.events.InstallerActionEvent
Returns the log output produced by the action
getLogFile() - Static method in class com.install4j.api.Util
Get the location of the log file.
getLogValueForProperty(String, Object) - Method in interface com.install4j.api.beans.PropertyLoggingInterceptor
Replace the value of the property for logging purposes.
getMaxRestarts() - Method in class com.install4j.api.windows.service.ServiceConfiguration
 
getMaxWidth() - Method in class com.install4j.api.context.WizardIndex
Returns the maximum width of the index panel
getMd5Sum() - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Returns the MD5 sum of the file if the option to calculate checksums has been enabled.
getMediaFileId() - Method in interface com.install4j.api.context.Context
Returns the ID of the media file that was used to create this installer.
getMediaName() - Method in interface com.install4j.api.context.InstallerContext
Get the name of the current media file.
getMediaSetId() - Method in interface com.install4j.api.ApplicationRegistry.ApplicationInfo
Returns the ID of the media file that was used to install this application.
getMessage(String) - Method in interface com.install4j.api.context.Context
Get a message for a localization key.
getMessage(String, Object...) - Method in interface com.install4j.api.context.Context
Get a message for a localization key.
getMinWidth() - Method in class com.install4j.api.context.WizardIndex
Returns the minimum width of the index panel.
getMnemonicCharIndex(String) - Static method in class com.install4j.api.formcomponents.AbstractFormComponent
 
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.
getModuleName() - Method in class com.install4j.api.ProcessInfo
Retrieves the full executable path of the process.
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.FileSetSetup
Returns the name of this file set.
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 launcher as configured in the install4j GUI.
getNestedStyleId() - Method in class com.install4j.api.styles.WrapperStyle
Returns the ID of the nested style.
getNestedStyleIds() - Method in interface com.install4j.api.styles.NestedStyleContainer
Return the IDs of all nested styles.
getNestedStyleIds() - Method in class com.install4j.api.styles.WrapperStyle
 
getNewMediaFileId() - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Returns the media file ID of the update installer that is represented by this entry.
getNewVersion() - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Returns the version of the available update.
getObject() - Method in class com.install4j.api.beaninfo.EnumerationMapEntry
Get the object that is mapped to the specified name.
getOperationVerbose() - Method in enum 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
getParameterType() - Method in class com.install4j.api.beaninfo.ScriptParameter
Get the parameter type
getParentWindow() - Static method in class com.install4j.api.Util
Get the window of the installer.
getPercentCompleted() - Method in class com.install4j.api.context.DefaultUnattendedProgressInterface
Returns the last value set by setPercentCompleted.
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, macOS and Linux.
getPossibleUpdateEntry() - Method in interface com.install4j.api.update.UpdateDescriptor
An entry that has been identified as a match for the current installation and should be used for choosing an update installer.
getProcessId() - Method in class com.install4j.api.ProcessInfo
Retrieves the process id.
getProgramDataDirectory() - Static method in class com.install4j.api.windows.WinFileSystem
Returns the program data directory where applications can save data that is not specific to particular users.
getProgramFilesDirectory() - Static method in class com.install4j.api.windows.WinFileSystem
Returns the program files directory of the current Windows installation.
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 progress 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.
getPropertyClass() - Method in interface com.install4j.api.beaninfo.PropertyConverter
Returns the property type for which this property converter is eligible.
getPropertyCustomizerClass() - Method in interface com.install4j.api.beaninfo.PropertyConverter
Returns the class of the optional property customizer.
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.
getPropertyValue(String, Bean) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Convenience method for bean validators to get the property value for a named property.
getReadTimeout() - Method in class com.install4j.api.update.UpdateCheckRequest
Returns the value set with UpdateCheckRequest.readTimeout(int) The default value is 10000 ms.
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.
getRequestHeaders() - Method in class com.install4j.api.update.UpdateCheckRequest
Returns the value set with UpdateCheckRequest.requestHeaders(Map).
getResetSeconds() - Method in class com.install4j.api.windows.service.ServiceConfiguration
 
getResourceDirectory() - Method in interface com.install4j.api.context.Context
Retrieves the directory where the resource files are present that have been configured on the Installer->Custom Code &Resources tab.
getRestartMillis() - Method in class com.install4j.api.windows.service.ServiceConfiguration
 
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.
getRunningProcesses() - Static method in class com.install4j.api.macos.MacProcesses
Get a list of all running processes the installer can see.
getRunningProcesses() - Static method in class com.install4j.api.windows.WinProcesses
Get a list of all running processes the installer can see.
getScreen() - Method in interface com.install4j.api.formcomponents.FormEnvironment
Get the form screen associated with this form environment.
getScreenById(String) - Method in interface com.install4j.api.context.Context
Get a particular screen with the specified ID.
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.
getSha256Sum() - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Returns the SHA-256 sum of the file if the option to calculate checksums has been enabled.
getShell() - Static method in class com.install4j.api.unix.UnixFileSystem
Returns the shell executable of the current user.
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.
getStartType(String) - Static method in class com.install4j.api.windows.service.WinServices
Returns the start type of a service.
getStepNames() - Method in class com.install4j.api.context.WizardIndex
Returns the step names
getStyle() - Method in class com.install4j.api.windows.WindowInfo
Returns the window style.
getStyleById(String) - Method in interface com.install4j.api.styles.StyleManager
Get the style for a specified ID.
getStyleManager() - Method in interface com.install4j.api.context.WizardContext
Get the style manager.
getStyleManager() - Method in class com.install4j.api.styles.AbstractStyle
Returns the StyleManager.
getSubKeyNames(RegistryRoot, String) - Static method in class com.install4j.api.windows.WinRegistry
Retrieves the sub keys of a registry key.
getSubKeyNames(RegistryRoot, String, RegistryView) - 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.
getSubTitle() - Method in interface com.install4j.api.styles.StyleContext
The subtitle of the screen as returned by Screen.getSubTitle().
getSystemDirectory() - Static method in class com.install4j.api.windows.WinFileSystem
Returns the system directory.
getTargetMediaFileId() - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Returns the media file ID for which this update is suitable.
getTextOverrideValue(Bean, String, Class<T>) - Static method in class com.install4j.api.beans.AbstractBean
Get the value for a property for which a text replacement has been configured in the IDE.
getTextWithoutMnemonics(String) - Static method in class com.install4j.api.formcomponents.AbstractFormComponent
 
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.
getTitle() - Method in interface com.install4j.api.styles.StyleContext
The title of the screen as returned by Screen.getTitle().
getTopLevelWindows(long) - Static method in class com.install4j.api.windows.WindowInfo
Returns all visible top level windows of the process with the supplied process id.
getTotalSize() - Method in class com.install4j.api.events.InstallerFileInstallationEvent
Returns the total size of the installation in bytes
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.
getType() - Method in class com.install4j.api.windows.WinUser.AddUserResult
The result type (success / specific errors)
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.
getUpdatableVersionMax() - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Returns the maximum version that is eligible for an update.
getUpdatableVersionMin() - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Returns the minimum version that is eligible for an update.
getUpdateDescriptor(UpdateCheckRequest) - Static method in class com.install4j.api.update.UpdateChecker
Download an updates.xml file programatically from a given URL and returns an UpdateDescriptor instance.
getUpdateDescriptor(String, ApplicationDisplayMode) - Static method in class com.install4j.api.update.UpdateChecker
getUpdateDescriptor(String, ApplicationDisplayMode, ErrorHandlingCallback) - Static method in class com.install4j.api.update.UpdateChecker
getUpdateSchedule() - Static method in class com.install4j.api.update.UpdateScheduleRegistry
Returns the configured update schedule.
getUrl() - Method in class com.install4j.api.events.InstallerDownloadEvent
Returns the URL of the download.
getURL() - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Returns the full URL from which the update installer can be downloaded.
getUrlSpec() - Method in class com.install4j.api.update.UpdateCheckRequest
Returns the value set with UpdateCheckRequest.urlSpec(String)
getUserHome() - Static method in class com.install4j.api.Util
Returns the home directory.
getUserName(String) - Static method in class com.install4j.api.windows.WinUser
Try to get the user name (an unqualified account name) for a SID (Security Identifier).
getUserSid() - Method in class com.install4j.api.windows.WinUser.AddUserResult
The SID (Security Identifier) of the created user in String form.
getUserSid() - Static method in class com.install4j.api.windows.WinUser
Get the users SID (Security Identifier) of the current process.
getValue() - Method in enum com.install4j.api.beans.Anchor
The value of the anchor which can be used by java.awt.GridBagLayout.
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.
getValue(RegistryRoot, String, String, RegistryView) - Static method in class com.install4j.api.windows.WinRegistry
Retrieves a registry value.
getValueNames(RegistryRoot, String) - Static method in class com.install4j.api.windows.WinRegistry
Retrieves the exiting value names of a registry key.
getValueNames(RegistryRoot, String, RegistryView) - Static method in class com.install4j.api.windows.WinRegistry
Retrieves the exiting value names of a registry key.
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.InstallerActionEvent
 
getVerbose() - Method in class com.install4j.api.events.InstallerDirectoryEvent
 
getVerbose() - Method in class com.install4j.api.events.InstallerDownloadEvent
 
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.InstallerFileInstallationEvent
 
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.context.Context
Returns the version of the installer.
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.
getWindowTitle() - Method in class com.install4j.api.macos.MacProcesses.Info
 
getWindowTitle() - Method in class com.install4j.api.ProcessInfo
Get the title of one of the visible top-level windows of this process.
getWindowTitle() - Method in class com.install4j.api.windows.WindowInfo
Returns the window title.
getWindowTitle() - Method in class com.install4j.api.windows.WinProcesses.Info
 
getWindowTitle(int) - Static method in class com.install4j.api.windows.WinProcesses
Get the title of one of the visible top-level windows of this process.
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.
goBackInHistory(Screen) - Method in interface com.install4j.api.context.Context
Go backwards in the screen history to the target screen.
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 without checking the condition of the target screen or executing any actions.
gotoScreen(Screen, boolean, boolean) - Method in interface com.install4j.api.context.Context
Programmatically switch to another screen in the installer.
GroupType - Enum in com.install4j.api.formcomponents
Type of a layout group.
GUI - com.install4j.api.context.LauncherType
Represents a GUI launcher.
GUI - com.install4j.api.update.ApplicationDisplayMode
The invoking application runs with a Swing GUI.

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.
hasBeenElevated() - Method in interface com.install4j.api.context.Context
Returns if the code is running in the elevated helper process started by the "Request privileges" action.
hasFullAdminRights() - Static method in class com.install4j.api.Util
Checks whether the current process has full administration rights.
hashCode() - Method in class com.install4j.api.beans.ScriptProperty
 
hashCode() - Method in class com.install4j.api.ProcessInfo
 
hasUserInput() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
hasUserInput() - Method in interface com.install4j.api.formcomponents.FormComponent
This method is called in situations where the installer must disable all user input.
hide() - Static method in class com.install4j.api.launcher.SplashScreen
Programmatically hide the splash screen.
HKEY_CLASSES_ROOT - com.install4j.api.windows.RegistryRoot
Identifies the root registry key HKEY_CLASSES_ROOT.
HKEY_CURRENT_CONFIG - com.install4j.api.windows.RegistryRoot
Identifies the root registry key HKEY_CURRENT_CONFIG.
HKEY_CURRENT_USER - com.install4j.api.windows.RegistryRoot
Identifies the root registry key HKEY_CURRENT_USER.
HKEY_LOCAL_MACHINE - com.install4j.api.windows.RegistryRoot
Identifies the root registry key HKEY_LOCAL_MACHINE.
HKEY_USERS - com.install4j.api.windows.RegistryRoot
Identifies the root registry key HKEY_USERS.
HORIZONTAL - com.install4j.api.formcomponents.GroupType
Horizontal layout group
HTML - com.install4j.api.beaninfo.FileContentType
The file contains HTML encoded in UTF-8 format.

I

I18N_ONLY - com.install4j.api.beans.ReplacementMode
Only i18n variables like ${i18n:myKey} will be replaced.
IF_CREATED - 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 - 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 - 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 - com.install4j.api.context.OverwriteMode
Indicates that if the destination file exists it will be replaced if the source file is newer.
IGNORE - com.install4j.api.beans.ErrorHandlingMode
Ignore the error and continue.
IGNORE - com.install4j.api.beans.VariableErrorHandling
Ignore an undefined variable and leave it in place
Info(int, String) - Constructor for class com.install4j.api.windows.WinProcesses.Info
Called by the framework.
Info(int, String, String, String, boolean) - Constructor for class com.install4j.api.macos.MacProcesses.Info
Called by the framework.
INHERIT - com.install4j.api.beaninfo.ActionElevationType
The action elevation type will be inherited from the parent element, such as the action or screen group, the screen or the installer application itself.
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
Deprecated.
initialize() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
initialize() - 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.
initializeAction(Action, List<String>) - Method in interface com.install4j.api.beaninfo.ActionListInitializer
Called after the unconfigured action is instantiated the first time at design-time.
initializeBean(Bean) - Method in interface com.install4j.api.beaninfo.BeanInitializer
Called after the unconfigured bean is instantiated the first time at design-time.
initializeLazilyCreatedScreens() - Method in interface com.install4j.api.context.Context
Initialize all lazily created screens.
initialKey(String) - Method in class com.install4j.api.context.WizardIndex
Sets the key of the step name that should be initially selected.
install(InstallerContext) - Method in interface com.install4j.api.actions.InstallAction
This method is called by the framework to perform the action during installation.
install(String, ServiceConfiguration) - Static method in class com.install4j.api.windows.service.WinServices
Installs a service.
Install4JBeanInfo - Class in com.install4j.api.beaninfo
Base class for bean infos.
Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class<? extends Bean>) - Constructor for class com.install4j.api.beaninfo.Install4JBeanInfo
Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class<? extends Bean>, Class<?>) - Constructor for class com.install4j.api.beaninfo.Install4JBeanInfo
Constructor.
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.
installDirectory(File, UninstallMode) - Method in interface com.install4j.api.context.InstallerContext
Creates a directory.
INSTALLER_APPLICATION - com.install4j.api.context.LauncherType
Represents a custom installer application.
InstallerActionEvent - Class in com.install4j.api.events
The event object that is passed to installer event listeners after an action has been executed.
InstallerActionEvent(Object, Context, EventType, boolean, String, long, Exception, List<String>) - Constructor for class com.install4j.api.events.InstallerActionEvent
The constructor is called by the framework.
InstallerContext - Interface in com.install4j.api.context
The context provided by the installer.
InstallerDirectoryEvent - Class in com.install4j.api.events
The event object that is passed to installer event listeners for the directory creation event.
InstallerDirectoryEvent(Object, Context, EventType, boolean, File) - Constructor for class com.install4j.api.events.InstallerDirectoryEvent
The constructor is called by the framework.
InstallerDownloadEvent - Class in com.install4j.api.events
The event object that is passed to installer event listeners for download events types.
InstallerDownloadEvent(Object, Context, EventType, boolean, URL, File, long) - Constructor for class com.install4j.api.events.InstallerDownloadEvent
The constructor is called by the framework.
InstallerDownloadEvent(Object, Context, EventType, URL, File, long) - Constructor for class com.install4j.api.events.InstallerDownloadEvent
The constructor is called by the framework.
InstallerDownloadEvent.DownloadProgressListener - Interface in com.install4j.api.events
A listener that is informed about the progress of a download.
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
 
InstallerEvent - Class in com.install4j.api.events
The event object that is passed to installer event listeners.
InstallerEvent(Object, Context, EventType) - Constructor for class com.install4j.api.events.InstallerEvent
The constructor is called by the framework.
InstallerEvent(Object, Context, EventType, boolean) - Constructor for class com.install4j.api.events.InstallerEvent
The constructor is called by the framework.
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 single file installation events types.
InstallerFileEvent(Object, Context, EventType, boolean, File, long) - Constructor for class com.install4j.api.events.InstallerFileEvent
The constructor is called by the framework.
InstallerFileEvent(Object, Context, EventType, File, long) - Constructor for class com.install4j.api.events.InstallerFileEvent
The constructor is called by the framework.
InstallerFileInstallationEvent - Class in com.install4j.api.events
The event object that is passed to installer event listeners when the file installation is started.
InstallerFileInstallationEvent(Object, Context, EventType, long, long) - Constructor for class com.install4j.api.events.InstallerFileInstallationEvent
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.
is64BitWindows() - Static method in class com.install4j.api.Util
Returns whether the Windows is a 64-bit Windows, regardless of whether the installer is running with a 32-bit JVM or a 64-bit JVM.
isAcceptAllCertificates() - Method in class com.install4j.api.update.UpdateCheckRequest
isAdminGroup() - Static method in class com.install4j.api.Util
Checks whether the current user is from the administration group.
isAdminUser() - Static method in class com.install4j.api.Util
Deprecated.
isAix() - Static method in class com.install4j.api.Util
Returns whether the platform is AIX.
isArchive() - Method in interface com.install4j.api.context.Context
Returns whether the media set was an archive as opposed to an installer.
isArchive() - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Returns whether the media file is an installer or an archive.
isAskForProxy() - Method in class com.install4j.api.context.DefaultUnattendedProgressInterface
Default implementation for unattended mode.
isAskForProxy() - Method in interface com.install4j.api.context.UnattendedProgressInterface
Called if no internet connection is available for a download.
isAskForProxy() - Method in class com.install4j.api.update.UpdateCheckRequest
Returns the value set with UpdateCheckRequest.askForProxy(boolean)
isAtLeastWindows7() - Static method in class com.install4j.api.Util
Returns whether the platform is at least Windows 7.
isAtLeastWindowsVista() - Static method in class com.install4j.api.Util
Returns whether the platform is at least Windows Vista.
isAtLeastWindowsXP() - Static method in class com.install4j.api.Util
Deprecated.
isBackgroundOnly() - Method in class com.install4j.api.macos.MacProcesses.Info
Returns if the process is only running in the background and does not display any windows.
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.
isBreakOnError() - Method in class com.install4j.api.beans.ActionList
If the execution of the actions should be terminated when an action fails.
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.
isChangeable() - Method in interface com.install4j.api.context.InstallationComponentSetup
Returns whether the selection state of the installation component can be changed by the user or not.
isConsole() - Method in interface com.install4j.api.context.Context
Returns whether the installer or uninstaller is running in console mode.
isCorner() - Method in enum com.install4j.api.beans.Anchor
If the anchor is a corner.
isCreateLazily() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
 
isCreateLazily() - Method in class com.install4j.api.screens.AbstractInstallerScreen
 
isCreateLazily() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
 
isCreateLazily() - Method in interface com.install4j.api.screens.Screen
This method is called by the framework to determine if the screen should only be created when it is shown.
isDelayIfNecessary() - Method in class com.install4j.api.context.FileOptions
Returns whether the operation should be delayed until reboot on Windows if necessary.
isDesignTime() - Method in interface com.install4j.api.formcomponents.FormEnvironment
Returns whether the form component has been instantiated at design time.
isDirectoryWritable(File) - Static method in class com.install4j.api.Util
Checks if a directory is writable with the currently available privileges.
isDownloaded() - Method in interface com.install4j.api.context.InstallationComponentSetup
Returns whether the installation component is downloaded.
isDownloaded() - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Checks if an updater with this version is already downloaded and scheduled for installation by an "Schedule update installation" action.
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.
isErrorOccurred() - Method in interface com.install4j.api.context.Context
Determine if an error has occurred 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.
isFillCenterVertical() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
isFillCenterVertical() - Method in interface com.install4j.api.formcomponents.FormComponent
Determine how the center component created by createCenterComponent should should fill all available vertical space.
isFillHorizontal() - Method in interface com.install4j.api.beans.VisualContainerBean
Returns whether the visual component wants to grow in the horizontal direction.
isFillHorizontal() - Method in class com.install4j.api.styles.WrapperStyle
 
isFillVertical() - Method in interface com.install4j.api.beans.VisualContainerBean
Returns whether the visual component wants to grow in the vertical direction.
isFillVertical() - Method in class com.install4j.api.styles.WrapperStyle
 
isGroupCreated() - Method in class com.install4j.api.windows.WinUser.AddUserResult
Check if the local group was newly created
isGui() - Method in interface com.install4j.api.context.Context
Returns whether the installer or uninstaller is running in GUI mode.
isHidden() - Method in interface com.install4j.api.context.InstallationComponentSetup
Returns whether the installation component is hidden from the user.
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.
isInitialized() - Method in interface com.install4j.api.formcomponents.FormEnvironment
Check if the form panel is fully initialized.
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 macOS.
isMacosInstaller() - Static method in class com.install4j.api.Util
Returns whether the installer is a macOS installer
isModified() - Method in interface com.install4j.api.beaninfo.PropertyCustomizer
Called by the install4j IDE when the dialog is closed in order to determine if the user has made any modifications.
isNewArchiveInstallation() - Static method in class com.install4j.api.launcher.ApplicationLauncher
Determine if this is a new archive installation.
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.
isNumbered() - Method in class com.install4j.api.context.WizardIndex
Returns if numbers should be added in front of each index step.
isPartiallyDefined() - Method in class com.install4j.api.context.WizardIndex
Returns of the wizard index is partially defined.
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.
isRebootRequired() - Method in interface com.install4j.api.context.Context
Returns whether a reboot is required on Windows.
isRollbackSupported() - Method in class com.install4j.api.actions.AbstractInstallAction
 
isRollbackSupported() - Method in class com.install4j.api.actions.AbstractInstallOrUninstallAction
 
isRollbackSupported() - Method in interface com.install4j.api.actions.InstallAction
This method is called by the framework to determine if the action supports a rollback.
isRunning(String) - Static method in class com.install4j.api.windows.service.WinServices
Checks if a service is currently running.
isScrollFormPanel() - Method in interface com.install4j.api.screens.FormPanelContainer
Determine if the form panel should be wrapped in a scroll pane.
isSelected() - Method in interface com.install4j.api.context.FileSetSetup
Returns whether the file set is selected for installation.
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.
isShowProxyOnErrorCode() - Method in class com.install4j.api.update.UpdateCheckRequest
isSingleBundle() - Method in interface com.install4j.api.update.UpdateDescriptorEntry
Returns whether the media file is a macOS single bundle installer or archive.
isSolaris() - Static method in class com.install4j.api.Util
Returns whether the platform is Solaris.
isStandalone() - Method in class com.install4j.api.styles.AbstractStyle
 
isStandalone() - Method in interface com.install4j.api.styles.Style
Returns if the style is intended to by applied to installer applications, screens and screen groups.
isTabletMode() - Static method in class com.install4j.api.windows.WindowInfo
Checks if Windows 10 is currently used in tablet mode.
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
Checks if this application is already installed in the given directory.
isUpdateInstallation() - Method in interface com.install4j.api.context.InstallerContext
Returns whether the installer is or will be updating an existing version of the same program.
isUpdateScheduled() - Static method in class com.install4j.api.update.UpdateChecker
Checks if the "Schedule update installation" action has registered a downloaded update for installation.
isVersionGreaterThan(String, String) - Static method in class com.install4j.api.update.UpdateChecker
Compares two version strings and checks if the first version is greater than the second version.
isVersionLessThanOrEqual(String, String) - Static method in class com.install4j.api.update.UpdateChecker
Compares two version strings and checks if the first version is lower or equal than the second version.
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.
isVisible() - Method in interface com.install4j.api.formcomponents.LayoutGroup
Returns whether the layout group is visible or not.
isVisible(Bean, Object) - Method in interface com.install4j.api.beaninfo.VisibilityDiscriminator
Determine if the property for which this callback has been registered should be visible or not.
isWindows() - Static method in class com.install4j.api.Util
Returns whether the platform is Windows.
isWindows10() - Static method in class com.install4j.api.Util
Returns whether the platform is Windows 10.
isWindows2000() - Static method in class com.install4j.api.Util
Returns whether the platform is Windows 2000.
isWindows2003() - Static method in class com.install4j.api.Util
Returns whether the platform is Windows 2003.
isWindows2008() - Static method in class com.install4j.api.Util
Returns whether the platform is Windows 2008.
isWindows2012() - Static method in class com.install4j.api.Util
Returns whether the platform is Windows 2012.
isWindows2016() - Static method in class com.install4j.api.Util
Returns whether the platform is Windows 2016.
isWindows7() - Static method in class com.install4j.api.Util
Returns whether the platform is Windows 7.
isWindows8() - Static method in class com.install4j.api.Util
Returns whether the platform is Windows 8.
isWindows9X() - Static method in class com.install4j.api.Util
Deprecated.
always returns false because launchers do not work with Windows 9X anymore
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
Deprecated.
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.
keyExists(RegistryRoot, String, RegistryView) - Static method in class com.install4j.api.windows.WinRegistry
Checks if a registry key exists.

L

launchApplication(String, String[], boolean, ApplicationLauncher.Callback) - Static method in class com.install4j.api.launcher.ApplicationLauncher
Launch an installer application that you have defined in the install4j IDE.
launchApplicationInProcess(String, String[], ApplicationLauncher.Callback, ApplicationLauncher.WindowMode, Window) - Static method in class com.install4j.api.launcher.ApplicationLauncher
Launch an installer application that you have defined in the install4j IDE.
LauncherSetup - Interface in com.install4j.api.context
This interface provides information about launchers.
LauncherType - Enum in com.install4j.api.context
Enumeration class that represents the different types of launchers.
LayoutGroup - Interface in com.install4j.api.formcomponents
Represents a layout group for form components.
loadFromPreferenceStore(boolean) - Static method in class com.install4j.api.launcher.Variables
Load installer variables from the preference stores that have been saved by a "Save installer variables to the preference store" action.
loadFromPreferenceStore(String, boolean) - Static method in class com.install4j.api.launcher.Variables
Load installer variables from the preference stores that have been saved by a "Save installer variables to the preference store" action.
loadNativeFromResources(String) - Static method in class com.install4j.api.Util
Call System.load(java.lang.String) with the supplied file name resolved against the resource directory.
LOCAL_APPDATA - com.install4j.api.windows.SpecialFolder
Identifies the file system directory that serves as a data repository for local applications.
LOCAL_SERVICE - com.install4j.api.windows.service.ServiceAccount
 
LOCAL_SYSTEM - com.install4j.api.windows.service.ServiceAccount
 
LocalizedExternalFile - Class in com.install4j.api.beans
Container for a set of localized files that represent a single ExternalFile with textual content.
LocalizedExternalFile() - Constructor for class com.install4j.api.beans.LocalizedExternalFile
 
log(Throwable) - Static method in class com.install4j.api.Util
Writes an stack trace to the installation log.
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

MacProcesses - Class in com.install4j.api.macos
Collection of static methods to check for running processes on macOS and terminate them.
MacProcesses() - Constructor for class com.install4j.api.macos.MacProcesses
 
MacProcesses.Info - Class in com.install4j.api.macos
Class that holds information about running macOS processes.
makeParentGroupVisible(FormComponent) - Method in interface com.install4j.api.formcomponents.FormEnvironment
Makes the parent group of a form component visible.
MAXIMIZED - com.install4j.api.windows.ShowCommand
 
maxRestarts(int) - Method in class com.install4j.api.windows.service.ServiceConfiguration
The maximum number of restarts when ServiceConfiguration.restartOnFailure is set to true.
maxWidth(int) - Method in class com.install4j.api.context.WizardIndex
Sets the maximum width of the index panel.
migrateIds(Map<String, String>) - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
migrateIds(Map<String, String>) - 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.
MINIMIZED - com.install4j.api.windows.ShowCommand
 
minWidth(int) - Method in class com.install4j.api.context.WizardIndex
Sets the minimum width of the index panel.
MNEMONIC_PATTERN - Static variable in class com.install4j.api.formcomponents.AbstractFormComponent
 
MONTHLY - com.install4j.api.update.UpdateSchedule
UpdateScheduleRegistry.checkAndReset() always returns true after more than one month has passed since the last update
more(String) - Method in interface com.install4j.api.screens.Console
Print a long text to the console and partition it into pages.
moveLogFile(File) - Static method in class com.install4j.api.Util
Move the log file to a new location.
moveWithDelayUntilReboot(File, File) - Static method in class com.install4j.api.windows.WinFileSystem
Calls the win32 API function MoveFileEx with MOVEFILE_DELAY_UNTIL_REBOOT.

N

NestedStyleContainer - Interface in com.install4j.api.styles
Implemented by styles that contain nested styles.
NETWORK_SERVICE - com.install4j.api.windows.service.ServiceAccount
 
NEVER - com.install4j.api.context.OverwriteMode
Indicates that if the destination file exists it won't be replaced in any case.
NEVER - com.install4j.api.context.UninstallMode
Indicates that the destination file won't be deleted for uninstallation.
NEVER - com.install4j.api.update.UpdateSchedule
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.
NEXT - com.install4j.api.context.ControlButtonType
The button to go to the next screen.
NONE - com.install4j.api.beaninfo.ActionElevationType
The action will not be elevated, it will run in-process as the original user.
NONE - com.install4j.api.windows.WinUser.GroupCreationMode
No group should be created and associated with the new user.
NORMAL - com.install4j.api.windows.ShowCommand
 
NORTH - com.install4j.api.beans.Anchor
 
NORTHEAST - com.install4j.api.beans.Anchor
 
NORTHWEST - com.install4j.api.beans.Anchor
 
NotSupportedInElevationException - Exception in com.install4j.api.context
Exception that is thrown if a method is called that is not supported for elevated actions.
NotSupportedInElevationException() - Constructor for exception com.install4j.api.context.NotSupportedInElevationException
 
numbered(boolean) - Method in class com.install4j.api.context.WizardIndex
Sets if numbers should be added in front of each index step.

O

ok() - Method in interface com.install4j.api.beaninfo.PropertyCustomizer
Called if the property customizer dialog is exited with the OK button.
ON_EVERY_START - com.install4j.api.update.UpdateSchedule
OTHER - com.install4j.api.beaninfo.FileContentType
The file has a content type that cannot be edited in the editors that associated with the other file content types in this enumeration class.
OTHER - com.install4j.api.windows.service.ServiceAccount
 
otherAccountName(String) - Method in class com.install4j.api.windows.service.ServiceConfiguration
The service account name to be used.
otherAccountPassword(String) - Method in class com.install4j.api.windows.service.ServiceConfiguration
The service account password to be used.
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 - Enum 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

partiallyDefined(boolean) - Method in class com.install4j.api.context.WizardIndex
Sets if the wizard index should be partially defined.
PLAIN - com.install4j.api.beans.ReplacementMode
Normal replacement like in AbstractBean.replaceVariables(String).
prepareShutdown() - Method in interface com.install4j.api.launcher.ApplicationLauncher.Callback
Invoked before the installer application shuts down this JVM.
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.
pressCancelButton() - Method in interface com.install4j.api.context.WizardContext
pressControlButton(ControlButtonType) - Method in interface com.install4j.api.context.WizardContext
Perform the action associated with a particular control button.
pressNextButton() - Method in interface com.install4j.api.context.WizardContext
pressPreviousButton() - Method in interface com.install4j.api.context.WizardContext
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.
PREVIOUS - com.install4j.api.context.ControlButtonType
The button to go to the previous screen.
print(Object) - Method in interface com.install4j.api.screens.Console
Print an object to the console by invoking its toString() method.
printAnnotatedStackTrace(Throwable) - Static method in class com.install4j.api.Util
Prints the return value of Util.getAnnotatedStackTrace(Throwable) to System.err.
printHeader(String) - Method in interface com.install4j.api.screens.Console
Print the header for a new screen.
println() - Method in interface com.install4j.api.screens.Console
Print a line feed to the console.
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.
ProcessInfo - Class in com.install4j.api
Represents a running process on Windows and macOS.
ProcessInfo(int, String) - Constructor for class com.install4j.api.ProcessInfo
Called by implementations.
PROGRAMS - 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
Construct a project report property with a property name and a report value.
PROPERTIES_FILE - com.install4j.api.beans.ReplacementMode
The property is used while replacing text directly in a Java properties file.
PropertyConverter - Interface in com.install4j.api.beaninfo
A property converter translates between a string representation and the actual object state and provides an optional property customizer.
PropertyCustomizer - Interface in com.install4j.api.beaninfo
Customizer component for a property that is used in a dialog.
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 - com.install4j.api.beaninfo.FailureStrategy
Quit after a failure.

R

RAMDISK - com.install4j.api.windows.DriveType
A ram disk.
readLine() - Method in interface com.install4j.api.screens.Console
Read input from the console.
readResolve() - Method in class com.install4j.api.SerializableEnum
 
readTimeout(int) - Method in class com.install4j.api.update.UpdateCheckRequest
Sets the read timeout in milliseconds for the HTTP connection.
REGEXP_MATCH - com.install4j.api.beans.ReplacementMode
The property is used as a regular expression.
REGEXP_REPLACEMENT - 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.
registerResponseFileComment(String, String) - Method in interface com.install4j.api.context.Context
Register a comment for a variable that is written to the response 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 macOS.
registerUninstallFile(File) - Method in interface com.install4j.api.context.InstallerContext
Registers an arbitrary file for uninstallation.
RegistryRoot - Enum in com.install4j.api.windows
Enumeration class for the different registry roots in the Microsoft Windows registry.
RegistryView - Enum in com.install4j.api.windows
Enumeration class for the different views of the Microsoft Windows registry on 64-bit systems.
reinitializeFormComponents() - Method in interface com.install4j.api.formcomponents.FormEnvironment
All form components including those that do not have their "Reset initialization on previous" property selected are initialized again.
REMOTE - com.install4j.api.windows.DriveType
A remote (network) drive.
RemoteCallable - Interface in com.install4j.api.context
On macOS and Windows Vista and higher, the 'require admin user' action can spawn additional installation processes that have full admin rights.
REMOVABLE - com.install4j.api.windows.DriveType
A removable drive.
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.
replaceFormVariables(String) - Method in class com.install4j.api.formcomponents.AbstractFormComponent
Same as AbstractBean.replaceVariables(String), only with the additional replacement of form variables.
replaceFormVariables(String[]) - Method in class com.install4j.api.formcomponents.AbstractFormComponent
Same as AbstractBean.replaceVariables(String[]), only with the additional replacement of form variables.
replaceFormVariables(String[], VariableErrorHandlingDescriptor) - Method in class com.install4j.api.formcomponents.AbstractFormComponent
Same as AbstractBean.replaceVariables(String[], VariableErrorHandlingDescriptor), only with the additional replacement of form variables.
replaceFormVariables(String, ReplacementMode) - Method in class com.install4j.api.formcomponents.AbstractFormComponent
Same as AbstractBean.replaceVariables(String, ReplacementMode), only with the additional replacement of form variables.
replaceFormVariables(String, ReplacementMode, VariableErrorHandlingDescriptor) - Method in class com.install4j.api.formcomponents.AbstractFormComponent
Same as AbstractBean.replaceVariables(String, ReplacementMode, VariableErrorHandlingDescriptor), only with the additional replacement of form variables.
replaceFormVariables(String, ReplacementMode, VariableErrorHandlingDescriptor) - Method in interface com.install4j.api.formcomponents.FormEnvironment
Replace all form variables, installer variables and localization keys in a string.
replaceFormVariables(String, VariableErrorHandlingDescriptor) - Method in class com.install4j.api.formcomponents.AbstractFormComponent
Same as AbstractBean.replaceVariables(String, VariableErrorHandlingDescriptor), only with the additional replacement of form variables.
ReplacementMode - Enum in com.install4j.api.beans
Variable replacement mode for string properties that are used in regular expressions.
replaceVariables(File) - Static method in class com.install4j.api.beans.AbstractBean
Replace all installer variables and localization keys in a file name.
replaceVariables(File[]) - Static method in class com.install4j.api.beans.AbstractBean
Replace all installer variables and localization keys in a file array.
replaceVariables(String) - Static method in class com.install4j.api.beans.AbstractBean
replaceVariables(String[]) - Static method in class com.install4j.api.beans.AbstractBean
replaceVariables(String[], VariableErrorHandlingDescriptor) - Static method in class com.install4j.api.beans.AbstractBean
Replace all installer variables and localization keys in a string array.
replaceVariables(String, ReplacementMode) - Static method in class com.install4j.api.beans.AbstractBean
replaceVariables(String, ReplacementMode, VariableErrorHandlingDescriptor) - Static method in class com.install4j.api.beans.AbstractBean
Replace all installer variables and localization keys in a string.
replaceVariables(String, VariableErrorHandlingDescriptor) - Static method in class com.install4j.api.beans.AbstractBean
replaceWithTextOverride(Bean, String, T, Class<T>) - Static method in class com.install4j.api.beans.AbstractBean
A convenience method for AbstractBean.getTextOverrideValue(com.install4j.api.beans.Bean, java.lang.String, java.lang.Class<T>) that returns a default value if no replacement has been configured.
replaceWithTextOverride(String, boolean) - Method in class com.install4j.api.beans.AbstractBean
 
replaceWithTextOverride(String, byte) - Method in class com.install4j.api.beans.AbstractBean
 
replaceWithTextOverride(String, char) - Method in class com.install4j.api.beans.AbstractBean
 
replaceWithTextOverride(String, double) - Method in class com.install4j.api.beans.AbstractBean
 
replaceWithTextOverride(String, float) - Method in class com.install4j.api.beans.AbstractBean
 
replaceWithTextOverride(String, int) - Method in class com.install4j.api.beans.AbstractBean
 
replaceWithTextOverride(String, long) - Method in class com.install4j.api.beans.AbstractBean
 
replaceWithTextOverride(String, short) - Method in class com.install4j.api.beans.AbstractBean
 
replaceWithTextOverride(String, T, Class<T>) - Method in class com.install4j.api.beans.AbstractBean
 
requestFocus() - Method in class com.install4j.api.formcomponents.AbstractFormComponent
 
requestFocus() - Method in interface com.install4j.api.formcomponents.FormComponent
Transfer the focus to this form component.
requestHeaders(Map<String, List<String>>) - Method in class com.install4j.api.update.UpdateCheckRequest
Sets request headers that should be set for the HTTP connection.
resetFormComponents() - Method in interface com.install4j.api.formcomponents.FormEnvironment
All form components whose "Reset initialization on previous" property is selected, will be initialized again when the screen is shown the next time.
resetSeconds(int) - Method in class com.install4j.api.windows.service.ServiceConfiguration
The time without failure in seconds after which to reset the restart counter configured with ServiceConfiguration.maxRestarts.
restartMillis(int) - Method in class com.install4j.api.windows.service.ServiceConfiguration
The restart period when ServiceConfiguration.restartOnFailure is set to true.
restartOnFailure(Boolean) - Method in class com.install4j.api.windows.service.ServiceConfiguration
If set to true, the service will be restarted after a period defined with ServiceConfiguration.restartMillis (defaults to one second) if it was terminated with an error
restoreKey(RegistryRoot, String, String) - Static method in class com.install4j.api.windows.WinRegistry
Restore a sub-tree of the registry from a file.
restoreKey(RegistryRoot, String, String, RegistryView) - Static method in class com.install4j.api.windows.WinRegistry
Restore a sub-tree of the registry from a file.
RETRY - com.install4j.api.beans.ErrorHandlingMode
Retry the operation that just failed.
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".
RETURN_TO_SCREEN - com.install4j.api.beaninfo.FailureStrategy
No further actions will be executed and the previous screen will be displayed again.
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.
rollbackActionList(ActionList) - Static method in class com.install4j.api.beans.AbstractBean
Roll back an action list.
runElevated(RemoteCallable, boolean) - Method in interface com.install4j.api.context.Context
Execute an remoteCallable with full admin rights if possible.
runScript(ScriptProperty, Bean, Object...) - Method in interface com.install4j.api.context.Context
Run a script.
runUnelevated(RemoteCallable) - Method in interface com.install4j.api.context.Context
Execute an remoteCallable with the rights of the original user that started the installer.
runWithSuspendedActions(Runnable) - Method in interface com.install4j.api.context.Context
Execute some code while any running actions are suspended.

S

saveFormComponents() - Method in interface com.install4j.api.formcomponents.FormEnvironment
All form components will be validated and their variables will be saved.
saveKey(RegistryRoot, String, String) - Static method in class com.install4j.api.windows.WinRegistry
Save a sub-tree of the registry to a file.
saveKey(RegistryRoot, String, String, RegistryView) - Static method in class com.install4j.api.windows.WinRegistry
Save a sub-tree of the registry to a file.
saveToPreferenceStore(Map<String, Object>, boolean) - Static method in class com.install4j.api.launcher.Variables
Save a map of installer variables to the preference store.
saveToPreferenceStore(Map<String, Object>, String, boolean) - Static method in class com.install4j.api.launcher.Variables
Save a map of installer variables to the preference store.
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<? extends Screen>) - Constructor for class com.install4j.api.beaninfo.ScreenBeanInfo
ScreenBeanInfo(String, String, String, boolean, boolean, Integer, Class<? extends Screen>, Class) - Constructor for class com.install4j.api.beaninfo.ScreenBeanInfo
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.
ScriptParameter(String, ParameterizedType) - Constructor for class com.install4j.api.beaninfo.ScriptParameter
Create a script parameter with a generic type.
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 - 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.
SerializableEnum - Class in com.install4j.api
Support class for old-style enums that work with Java 1.4 and are serializable.
SerializableEnum() - Constructor for class com.install4j.api.SerializableEnum
 
SERVICE - com.install4j.api.context.LauncherType
Represents a service launcher.
ServiceAccessException - Exception in com.install4j.api.windows.service
This exception is thrown when a call to WinServices was made with insufficient privileges.
ServiceAccessException() - Constructor for exception com.install4j.api.windows.service.ServiceAccessException
 
serviceAccount(ServiceAccount) - Method in class com.install4j.api.windows.service.ServiceConfiguration
The service account to be used.
ServiceAccount - Enum in com.install4j.api.windows.service
An enum to specify service accounts.
ServiceConfiguration - Class in com.install4j.api.windows.service
The service configuration passed to WinServices.
ServiceConfiguration() - Constructor for class com.install4j.api.windows.service.ServiceConfiguration
 
ServiceException - Exception in com.install4j.api.windows.service
The base exception type used by WinServices.
ServiceException() - Constructor for exception com.install4j.api.windows.service.ServiceException
 
ServiceException(String) - Constructor for exception com.install4j.api.windows.service.ServiceException
 
ServiceInfo - Class in com.install4j.api
Provides information about services created with install4j.
ServiceInfo() - Constructor for class com.install4j.api.ServiceInfo
 
ServiceNotFoundException - Exception in com.install4j.api.windows.service
This exception is thrown when a call to WinServices was made with a non-existing service name.
ServiceNotFoundException() - Constructor for exception com.install4j.api.windows.service.ServiceNotFoundException
 
ServiceStartType - Enum in com.install4j.api.windows.service
The start types of Windows services
set(String, String) - Static method in class com.install4j.api.windows.WinEnvVars
Sets a global environment variable.
setActionKeys(String[]) - Method in class com.install4j.api.beaninfo.ActionListPropertyDescriptor
Action keys can be used to show or hide properties of other actions.
setActionListHiddenKeys(String[]) - Method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Hide this property if the bean is shown in the configuration of an action list property whose configured action keys contain one of the specified strings.
setActionListInitializer(ActionListInitializer) - Method in class com.install4j.api.beaninfo.ActionBeanInfo
Configures an action list initializer.
setActionListShownKeys(String[]) - Method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Show this property only if the bean is shown in the configuration of an action list property whose configured action keys contain one of the specified strings.
setActionValidator(ActionValidator) - Method in class com.install4j.api.beaninfo.ActionBeanInfo
Configures an action validator.
setAllowedActionClasses(Class[]) - Method in class com.install4j.api.beaninfo.ActionListPropertyDescriptor
If set to a non-null value, the action registry dialog will only display the specified actions.
setAllowTextOverride(boolean) - Method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Allow the user to switch to text mode in the context menu when editing the property in the install4j IDE.
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
Deprecated. 
setAssociatedConfirmation(String, 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) - Method in class com.install4j.api.beaninfo.ActionBeanInfo
Configures an associated startup action.
setBackButtonEnabled(boolean) - Method in interface com.install4j.api.context.WizardContext
setBackButtonVisible(boolean) - Method in interface com.install4j.api.context.WizardContext
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.
setBreakOnError(boolean) - Method in class com.install4j.api.beans.ActionList
Determines if the execution of the actions should be terminated when an action fails.
setCancelButtonEnabled(boolean) - Method in class com.install4j.api.context.DefaultUnattendedProgressInterface
Default implementation for unattended mode that does nothing.
setCancelButtonEnabled(boolean) - Method in interface com.install4j.api.context.UnattendedProgressInterface
Called if the cancel button is enabled or disabled.
setCancelButtonEnabled(boolean) - Method in interface com.install4j.api.context.WizardContext
setCancelButtonText(String) - Method in interface com.install4j.api.context.WizardContext
setCancelButtonVisible(boolean) - Method in class com.install4j.api.context.DefaultUnattendedProgressInterface
Default implementation for unattended mode that does nothing.
setCancelButtonVisible(boolean) - Method in interface com.install4j.api.context.UnattendedProgressInterface
Called if the cancel button is made visible or invisible.
setCancelButtonVisible(boolean) - Method in interface com.install4j.api.context.WizardContext
setCategorySortOrder(String[]) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Sets a sort order for property categories of this bean.
setChangeable(boolean) - Method in interface com.install4j.api.context.InstallationComponentSetup
Sets whether the selection state of the installation component can be changed by the user or not.
setCodeGalleryTags(String[]) - Method in class com.install4j.api.beaninfo.ScriptPropertyDescriptor
Sets the code gallery tags that are are used to build the code gallery for this script property.
setCollapsedPropertyCategories(String[]) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Specifies property categories that should be collapsed by default.
setComplementaryStartupLink(boolean) - Method in class com.install4j.api.beaninfo.ActionBeanInfo
Determines if a complementary startup link should be placed in the installer or uninstaller.
setConfigurableElevationType(boolean) - Method in class com.install4j.api.beaninfo.ActionListPropertyDescriptor
By default, the user can configure the elevation type of the nested actions.
setContext(Context) - Method in class com.install4j.api.events.InstallerEvent
 
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.
setContext(Context) - Method in class com.install4j.api.styles.AbstractStyle
 
setContext(Context) - Method in interface com.install4j.api.styles.Style
This method is called by the framework to set the Context just after the style has been constructed.
setContext(String) - Method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Set the context for the property.
setControlButtonEnabled(ControlButtonType, boolean) - Method in interface com.install4j.api.context.WizardContext
Change the enabled status of control buttons on the current screen.
setControlButtonEnabled(ControlButtonType, boolean) - Method in interface com.install4j.api.styles.ControlButtonContainer
Called when the enabled state of a control button is changed.
setControlButtonEnabled(ControlButtonType, boolean) - Method in class com.install4j.api.styles.WrapperStyle
 
setControlButtonText(ControlButtonType, String) - Method in interface com.install4j.api.context.WizardContext
Set the test of control buttons on the current screen.
setControlButtonText(ControlButtonType, String) - Method in interface com.install4j.api.styles.ControlButtonContainer
Called when a control button text is changed.
setControlButtonText(ControlButtonType, String) - Method in class com.install4j.api.styles.WrapperStyle
 
setControlButtonText(String) - Method in interface com.install4j.api.styles.ControlButton
Called when the control button text is changed.
setControlButtonVisible(ControlButtonType, boolean) - Method in interface com.install4j.api.context.WizardContext
Change the visibility of control buttons on the current screen.
setControlButtonVisible(ControlButtonType, boolean) - Method in interface com.install4j.api.styles.ControlButtonContainer
Called when the visibility of a control button is changed.
setControlButtonVisible(ControlButtonType, boolean) - Method in class com.install4j.api.styles.WrapperStyle
 
setCustomizerIcon(Icon) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Configures the icon of the customizer tab.
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.
setDefaultActionElevationType(ActionElevationType) - Method in class com.install4j.api.beaninfo.ActionBeanInfo
setDefaultActionElevationType(ActionElevationType, boolean) - Method in class com.install4j.api.beaninfo.ActionBeanInfo
Configures in which elevation mode the action should run in elevated mode by default.
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.
setDefaultMultiExec(boolean) - Method in class com.install4j.api.beaninfo.ActionBeanInfo
Configures the default value for the "Can be executed multiple times" property of the action.
setDefaultPostActivationScript(String) - Method in class com.install4j.api.beaninfo.ScreenBeanInfo
Configures the default value for the "Post-activation script" property of the bean.
setDefaultPreActivationScript(String) - Method in class com.install4j.api.beaninfo.ScreenBeanInfo
Configures the default value for the "Pre-activation script" property of the bean.
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.
setDefaultRollbackBarrierExitCode(int) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Configures the default rollback barrier exit code.
setDefaultStyleName(String) - Method in class com.install4j.api.beaninfo.ScreenBeanInfo
Sets a default style name.
setDefaultVisibilityScript(String) - Method in class com.install4j.api.beaninfo.FormComponentBeanInfo
Configures the default value for the "Visibility script" property of the form component.
setDelayIfNecessary(boolean) - Method in class com.install4j.api.context.FileOptions
Sets whether the operation should be delayed until reboot on Windows if necessary.
setDetailMessage(String) - Method in class com.install4j.api.context.DefaultUnattendedProgressInterface
Default implementation for unattended mode that does nothing.
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
 
setEmptyMessage(String) - Method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
If the the value is null or empty, display a special text in a shaded color in the install4j IDE.
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.
setEnabled(boolean) - Method in interface com.install4j.api.formcomponents.LayoutGroup
Sets whether contained form components are enabled or not.
setEnumerationMappers(EnumerationMapper[]) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Specifies enumeration mappers for properties of this bean.
setErrorOccurred(boolean) - Method in interface com.install4j.api.context.Context
Clear or set the error flag that is described for isErrorOccurred.
setExtraScriptParameters(ScriptParameter[]) - Method in class com.install4j.api.beaninfo.ActionListPropertyDescriptor
If set to a non-null value, script properties of any actions contained in this action list will receive fixed extra script parameter of the defined type.
setFileContentType(FileContentType) - Method in class com.install4j.api.beaninfo.FilePropertyDescriptor
Set the file content type.
setFileTime(long) - Method in class com.install4j.api.context.FileOptions
Sets the file time.
setFormComponentCustomizerPlacement(CustomizerPlacement) - Method in class com.install4j.api.beaninfo.ScreenBeanInfo
Deprecated.
no longer used
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 interface com.install4j.api.screens.FormPanelContainer
This method is called by the framework to pass the form panel to this screen.
setFormVariable(String, Object) - Method in interface com.install4j.api.formcomponents.FormEnvironment
Set a form variable.
setFullPrivilegesRequired(boolean) - Method in class com.install4j.api.beaninfo.ActionBeanInfo
Configures if full privileges are required or not.
setHandleQuit(boolean) - Static method in class com.install4j.api.launcher.StartupNotification
Sets if the Quit command should be handled on macOS (that means if the application should quit when the command is invoked).
setHidden(boolean) - Method in interface com.install4j.api.context.InstallationComponentSetup
Sets whether the installation component is hidden.
setHiddenInActionLists() - Method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Do not show this property if the bean is shown in the configuration of the action list.
setIcons(Icon, Icon) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Configures custom icons for the bean.
setId(String) - Method in class com.install4j.api.beans.ActionList
Called by the framework.
setIndeterminateProgress(boolean) - Method in class com.install4j.api.context.DefaultUnattendedProgressInterface
Default implementation for unattended mode that does nothing.
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.
setLanguageIdToExternalFile(Map<String, ExternalFile>) - Method in class com.install4j.api.beans.LocalizedExternalFile
Sets the map from language IDs to ExternalFiles.
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(int, File) - Static method in class com.install4j.api.unix.UnixFileSystem
Set the Unix file mode for a file.
setMode(String) - Method in class com.install4j.api.context.FileOptions
Sets the unix file mode as an octal string.
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
setNextButtonText(String) - Method in interface com.install4j.api.context.WizardContext
setNextButtonVisible(boolean) - Method in interface com.install4j.api.context.WizardContext
setNoticePanel(JComponent) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Sets a panel that is displayed a notice at the top of the configuration panel.
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.
setParentProperty(String) - Method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Set the parent property under which this property should be shown in the install4j IDE.
setParentWindow(Window) - Method in interface com.install4j.api.beaninfo.CustomizerCallback
Called by the install4j GUI after the customizer is initialized and sets the parent window.
setParentWindow(Window) - Method in interface com.install4j.api.beaninfo.PropertyCustomizer
Called by the install4j IDE after the property customizer is initialized and sets the parent window.
setPercentCompleted(int) - Method in class com.install4j.api.context.DefaultUnattendedProgressInterface
Sets the percentage of completion of the current action and saves it to a local variable.
setPercentCompleted(int) - Method in interface com.install4j.api.context.ProgressInterface
Sets the percentage of completion of the current action.
setPersistenceDelegateMap(Map<? extends Class, ? extends PersistenceDelegate>) - 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.
setPreviousButtonText(String) - Method in interface com.install4j.api.context.WizardContext
setPropertyCategory(String) - Method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Configures the property category.
setPropertyChangeListener(PropertyChangeListener) - Method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Set a property change listener that is invoked when the property is changed in the IDE.
setPropertyConverters(PropertyConverter[]) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
Specifies property converters for properties of this bean.
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.
setSecondaryPercentCompleted(int) - Method in class com.install4j.api.context.DefaultUnattendedProgressInterface
 
setSecondaryPercentCompleted(int) - Method in interface com.install4j.api.context.ProgressInterface
Sets the percentage of completion of a secondary task, like the unpacking of a JAR file that was packed with Pack200.
setSelected(boolean) - Method in interface com.install4j.api.context.FileSetSetup
Sets whether the file set should be installed or not.
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 class com.install4j.api.context.DefaultUnattendedProgressInterface
Default implementation for unattended mode that does nothing.
setStatusMessage(String) - Method in interface com.install4j.api.context.ProgressInterface
Sets the status message on the progress screen.
setStyleContext(StyleContext) - Method in interface com.install4j.api.styles.StyleContextReceiver
Called by the framework when the current screen changes.
setStyleContext(StyleContext) - Method in class com.install4j.api.styles.WrapperStyle
 
setSuggestedValues(String[]) - Method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Enable auto-completion of a list of values when using the text field property editor in the install4j IDE.
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.
setUninstallerStartupAction(String) - Method in class com.install4j.api.beaninfo.ActionBeanInfo
Determines if a complementary startup action should be placed in the uninstaller.
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.
setUpdateSchedule(UpdateSchedule) - Static method in class com.install4j.api.update.UpdateScheduleRegistry
Sets the new update schedule.
setUserSpecific(String, String) - Static method in class com.install4j.api.windows.WinEnvVars
Sets a user-specific environment variable.
setValue(RegistryRoot, String, String, Object) - Static method in class com.install4j.api.windows.WinRegistry
Sets a registry value.
setValue(RegistryRoot, String, String, Object, RegistryView) - Static method in class com.install4j.api.windows.WinRegistry
Sets a registry value.
setValue(Object, Bean) - Method in interface com.install4j.api.beaninfo.PropertyCustomizer
Sets the property value and the bean.
setValue(String) - Method in class com.install4j.api.beans.ScriptProperty
Required by the framework.
setVariable(String, Object) - Method in interface com.install4j.api.context.Context
Set an installer variable.
setVariableValueClass(Class) - Method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Set the class of the variable value, if Install4JPropertyDescriptor.CONTEXT_VARIABLE_NAME is set.
setVisibilityDiscriminator(VisibilityDiscriminator) - Method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
Sets a visibility discriminator for this property.
setVisible(boolean) - Method in class com.install4j.api.context.DefaultUnattendedProgressInterface
Default implementation for unattended mode that does nothing.
setVisible(boolean) - Method in interface com.install4j.api.context.UnattendedProgressInterface
Called when the progress interface is created and destroyed.
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.
setVisible(boolean) - Method in interface com.install4j.api.formcomponents.LayoutGroup
Sets whether the layout group is visible or not.
setWindowSize(int, int) - Method in interface com.install4j.api.context.WizardContext
Sets the size of the application window.
setWindowTitle(String) - Method in interface com.install4j.api.context.WizardContext
Sets the title of the application window.
setWizardIndex(WizardIndex) - Method in interface com.install4j.api.context.WizardContext
Install a wizard index on the left side of the window to show overall installation progress.
setWizardIndexKey(String) - Method in interface com.install4j.api.context.WizardContext
Change the highlighted step in the currently installed wizard index.
SHOW_SCREEN - com.install4j.api.events.EventType
Fired before a screen is shown.
ShowCommand - Enum in com.install4j.api.windows
The show command for a shell link.
showErrorMessage(String) - Static method in class com.install4j.api.Util
Show a message dialog.
showFailure(String) - Method in class com.install4j.api.context.DefaultUnattendedProgressInterface
Default implementation for unattended mode that does nothing.
showFailure(String) - Method in interface com.install4j.api.context.ProgressInterface
Shows an error dialog with the specified message.
showMessage(String) - Static method in class com.install4j.api.Util
Show a message dialog.
showMessage(String, int) - 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.
showPath(String) - Static method in class com.install4j.api.Util
Show the specified directory or file.
showProxyOnErrorCode(boolean) - Method in class com.install4j.api.update.UpdateCheckRequest
Sets if a proxy config dialog should be shown if the connection succeeds, but an error code is returned.
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.
SINGLE_TAB - com.install4j.api.formcomponents.GroupType
Tabbed pane
SOUTH - com.install4j.api.beans.Anchor
 
SOUTHEAST - com.install4j.api.beans.Anchor
 
SOUTHWEST - com.install4j.api.beans.Anchor
 
SpecialFolder - Enum 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.
start(String, String...) - Static method in class com.install4j.api.windows.service.WinServices
Starts a service.
STARTMENU - com.install4j.api.windows.SpecialFolder
Identifies the file system directory containing Start menu items.
startType(ServiceStartType) - Method in class com.install4j.api.windows.service.ServiceConfiguration
The start type
STARTUP - com.install4j.api.windows.SpecialFolder
Identifies the file system directory that corresponds to the user's Startup program group.
STARTUP_SEQUENCE - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
Special identified for the startup sequence to be used as the className argument in ActionBeanInfo.setInstallerTargetScreen(String) and ActionBeanInfo.setUninstallerTargetScreen(String).
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 macOS.
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 macOS.
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.
stop(String) - Static method in class com.install4j.api.windows.service.WinServices
Stops a service.
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 configuration step.
Style - Interface in com.install4j.api.styles
All styles must implement this interface.
StyleContext - Interface in com.install4j.api.styles
Context object that gives access to the style-relevant properties of a screen and its content component that should be embedded into the style component.
StyleContextReceiver - Interface in com.install4j.api.styles
Implemented by objects that handle style context changes.
StyleManager - Interface in com.install4j.api.styles
Helper for working with nested styles.
SUCCESS - com.install4j.api.windows.WinUser.AddUserResultType
The user creation and the optional local group creation succeeded.
supportsFromString() - Method in interface com.install4j.api.beaninfo.PropertyConverter
Returns if the property converter is able to convert a string representation to an object.
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

TABBED_PANE - com.install4j.api.formcomponents.GroupType
Tabbed pane
TEMPLATES - com.install4j.api.windows.SpecialFolder
Identifies the file system directory that serves as a common repository for document templates.
terminateProcesses(int[]) - Static method in class com.install4j.api.windows.WinProcesses
Terminates the processes with the given ids forcefully.
terminateProcesses(int[], boolean, int) - Static method in class com.install4j.api.macos.MacProcesses
Tries to close the processes with the given ids by sending a VM_CLOSE message to all visible top-level windows.
TEXT - com.install4j.api.beaninfo.FileContentType
The file contains text encoded in UTF-8 format.
toString() - Method in enum com.install4j.api.beaninfo.FileContentType
 
toString() - Method in enum com.install4j.api.beans.Anchor
 
toString() - Method in enum com.install4j.api.beans.ErrorHandlingMode
 
toString() - Method in class com.install4j.api.beans.ScriptProperty
 
toString() - Method in enum com.install4j.api.beans.VariableErrorHandling
 
toString() - Method in enum com.install4j.api.context.ControlButtonType
 
toString() - Method in class com.install4j.api.context.FileOptions
 
toString() - Method in enum com.install4j.api.context.LauncherType
 
toString() - Method in enum com.install4j.api.context.OverwriteMode
 
toString() - Method in enum com.install4j.api.context.UninstallMode
 
toString() - Method in enum com.install4j.api.events.EventType
 
toString() - Method in class com.install4j.api.events.InstallerActionEvent
 
toString() - Method in class com.install4j.api.events.InstallerDirectoryEvent
 
toString() - Method in class com.install4j.api.events.InstallerDownloadEvent
 
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.InstallerFileInstallationEvent
 
toString() - Method in class com.install4j.api.events.InstallerVariableEvent
 
toString() - Method in enum com.install4j.api.formcomponents.GroupType
 
toString() - Method in class com.install4j.api.macos.MacProcesses.Info
 
toString() - Method in class com.install4j.api.ProcessInfo
 
toString() - Method in enum com.install4j.api.update.ApplicationDisplayMode
 
toString() - Method in enum com.install4j.api.update.UpdateSchedule
 
toString() - Method in enum com.install4j.api.windows.DriveType
 
toString() - Method in enum com.install4j.api.windows.ElevationState
 
toString() - Method in enum com.install4j.api.windows.RegistryRoot
 
toString() - Method in enum com.install4j.api.windows.RegistryView
 
toString() - Method in enum com.install4j.api.windows.service.ServiceAccount
 
toString() - Method in class com.install4j.api.windows.WindowInfo
 
toString() - Method in class com.install4j.api.windows.WinProcesses.Info
 
toString() - Method in class com.install4j.api.windows.WinRegistry.ExpandString
 
toString() - Method in class com.install4j.api.windows.WinUser.AddUserResult
 
toString() - Method in enum com.install4j.api.windows.WinUser.AddUserResultType
 
toString() - Method in enum com.install4j.api.windows.WinUser.GroupCreationMode
 
toString(Object) - Method in interface com.install4j.api.beaninfo.PropertyConverter
Converts the property value to a string value.
triggerReboot(boolean) - Method in interface com.install4j.api.context.Context
Triggers a reboot at the end of installation or uninstallation on Windows.

U

UNATTENDED - com.install4j.api.update.ApplicationDisplayMode
The invoking application does not take user input from a GUI or on the command line.
UnattendedProgressInterface - Interface in com.install4j.api.context
The user notification interface during unattended installations.
UndefinedVariableException - Exception in com.install4j.api.beans
Exception that is thrown by the replaceVariables(...) methods in AbstractBean if a variable cannot be found the VariableErrorHandling for the corresponding variable type is VariableErrorHandling.EXCEPTION.
UndefinedVariableException(String) - Constructor for exception com.install4j.api.beans.UndefinedVariableException
Will be called by the framework with the offending variable name as the message.
uninstall(UninstallerContext) - Method in interface com.install4j.api.actions.UninstallAction
This method is called by the framework to perform the action during uninstallation.
uninstall(String) - Static method in class com.install4j.api.windows.service.WinServices
Uninstalls a service.
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 - Enum 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.
UNKNOWN - com.install4j.api.windows.DriveType
The drive type could not be determined.
unregisterResponseFileVariable(String) - Method in interface com.install4j.api.context.Context
UpdateChecker - Class in com.install4j.api.update
Utility class to download an update descriptor programmatically from a given URL.
UpdateChecker() - Constructor for class com.install4j.api.update.UpdateChecker
 
UpdateCheckRequest - Class in com.install4j.api.update
UpdateCheckRequest(String) - Constructor for class com.install4j.api.update.UpdateCheckRequest
Constructs an update check request instance.
UpdateDescriptor - Interface in com.install4j.api.update
Contains information about available updates.
UpdateDescriptorEntry - Interface in com.install4j.api.update
Contains information about a single media file available for update.
UpdateSchedule - Enum in com.install4j.api.update
Enumeration class that represents the different update schedules.
UpdateScheduleRegistry - Class in com.install4j.api.update
Administrates an update schedule for your application.
urlSpec(String) - Method in class com.install4j.api.update.UpdateCheckRequest
Sets the URL from which the updates.xml file can be downloaded.
USE_EXISTING - com.install4j.api.windows.WinUser.GroupCreationMode
The new user should be added to an existing group.
UserCanceledException - Exception in com.install4j.api.context
Installation methods throw this exception if the user cancels an operation.
UserCanceledException() - Constructor for exception com.install4j.api.context.UserCanceledException
Initializes a new instance.
UserCanceledException(String) - Constructor for exception com.install4j.api.context.UserCanceledException
Initializes a new instance with a message.
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

validateAction(Action, List<String>) - Method in interface com.install4j.api.beaninfo.ActionValidator
Called by the install4j GUI at design-time to check the validity of the bean properties.
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.
valueOf(String) - Static method in enum com.install4j.api.beaninfo.ActionElevationType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.beaninfo.CustomizerPlacement
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.beaninfo.FailureStrategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.beaninfo.FileContentType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.beaninfo.FileSelectionMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.beans.Anchor
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.beans.ErrorHandlingMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.beans.ReplacementMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.beans.VariableErrorHandling
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.context.ControlButtonType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.context.LauncherType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.context.OverwriteMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.context.UninstallMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.events.EventType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.formcomponents.GroupType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.launcher.ApplicationLauncher.WindowMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.update.ApplicationDisplayMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.update.UpdateSchedule
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.windows.DriveType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.windows.ElevationState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.windows.RegistryRoot
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.windows.RegistryView
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.windows.service.ServiceAccount
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.windows.service.ServiceStartType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.windows.ShowCommand
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.windows.SpecialFolder
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.windows.WinUser.AddUserResultType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.install4j.api.windows.WinUser.GroupCreationMode
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.install4j.api.beaninfo.ActionElevationType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.beaninfo.CustomizerPlacement
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.beaninfo.FailureStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.beaninfo.FileContentType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.beaninfo.FileSelectionMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.beans.Anchor
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.beans.ErrorHandlingMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.beans.ReplacementMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.beans.VariableErrorHandling
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.context.ControlButtonType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.context.LauncherType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.context.OverwriteMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.context.UninstallMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.events.EventType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.formcomponents.GroupType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.launcher.ApplicationLauncher.WindowMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.update.ApplicationDisplayMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.update.UpdateSchedule
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.windows.DriveType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.windows.ElevationState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.windows.RegistryRoot
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.windows.RegistryView
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.windows.service.ServiceAccount
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.windows.service.ServiceStartType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.windows.ShowCommand
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.windows.SpecialFolder
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.windows.WinUser.AddUserResultType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.install4j.api.windows.WinUser.GroupCreationMode
Returns an array containing the constants of this enum type, in the order they are declared.
VARIABLE_CHANGED - com.install4j.api.events.EventType
Fired after a variable has been set.
VariableErrorHandling - Enum in com.install4j.api.beans
Used in VariableErrorHandlingDescriptor to configure the error handling for a single variable type.
VariableErrorHandlingDescriptor - Class in com.install4j.api.beans
Specifies the error handling for variable replacements.
VariableErrorHandlingDescriptor(VariableErrorHandling, VariableErrorHandling, VariableErrorHandling) - Constructor for class com.install4j.api.beans.VariableErrorHandlingDescriptor
VariableErrorHandlingDescriptor(VariableErrorHandling, VariableErrorHandling, VariableErrorHandling, VariableErrorHandling) - Constructor for class com.install4j.api.beans.VariableErrorHandlingDescriptor
Construct a custom variable error handling
Variables - Class in com.install4j.api.launcher
This class provides methods to access compiler and installer variables from your launchers.
VERTICAL - com.install4j.api.formcomponents.GroupType
Vertical layout group
VisibilityDiscriminator - Interface in com.install4j.api.beaninfo
Interface for controlling the visibility of child properties based on the value of the parent property.
VisualContainerBean - Interface in com.install4j.api.beans
Implemented by beans that contain visual components.

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.
waitForInProcessApplication(long, TimeUnit) - Static method in class com.install4j.api.launcher.ApplicationLauncher
Causes the current thread to wait until the currently running in process installer application has been finished.
waitForMaximizableWindow(File, long, TimeUnit) - Static method in class com.install4j.api.windows.WindowInfo
Wait until a process with the given path displays a maximizable window.
wasSuccessful() - Method in class com.install4j.api.events.InstallerEvent
Return whether the operation associated with the event was successful
WEEKLY - com.install4j.api.update.UpdateSchedule
UpdateScheduleRegistry.checkAndReset() always returns true after more than one week has passed since the last update
WEST - com.install4j.api.beans.Anchor
 
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.
willActivate() - Method in class com.install4j.api.styles.AbstractStyle
 
willActivate() - Method in interface com.install4j.api.styles.Style
This method is called by the framework just before a screen with this style is activated.
willActivate() - Method in class com.install4j.api.styles.WrapperStyle
 
willActivate(Style) - Method in interface com.install4j.api.styles.StyleManager
Notify a nested style that it will be activated.
WinAssociations - Class in com.install4j.api.windows
Collection of static methods to create and remove file associations on Microsoft Windows.
WindowInfo - Class in com.install4j.api.windows
Collection of methods to retrieve information about windows 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.
WinProcesses - Class in com.install4j.api.windows
Collection of static methods to check for running processes on Windows and terminate them.
WinProcesses() - Constructor for class com.install4j.api.windows.WinProcesses
 
WinProcesses.Info - Class in com.install4j.api.windows
Class that holds information about running Windows processes.
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.
WinServices - Class in com.install4j.api.windows.service
Collection of static methods to manipulate Windows services
WinServices() - Constructor for class com.install4j.api.windows.service.WinServices
 
WinUser - Class in com.install4j.api.windows
Collection of static methods to create or delete users and local groups on Windows.
WinUser() - Constructor for class com.install4j.api.windows.WinUser
 
WinUser.AddUserResult - Class in com.install4j.api.windows
WinUser.AddUserResultType - Enum in com.install4j.api.windows
WinUser.GroupCreationMode - Enum in com.install4j.api.windows
The group creation mode.
WizardContext - Interface in com.install4j.api.context
The wizard context allows you to modify the GUI installer or uninstaller.
WizardIndex - Class in com.install4j.api.context
A wizard index is used to configure a display of overall installation progress on the left side of the wizard.
WizardIndex(String[]) - Constructor for class com.install4j.api.context.WizardIndex
Construct a wizard index with the specified step names and auto-generate the index keys to the strings "1", "2", "3", and so on.
WizardIndex(String[], String[]) - Constructor for class com.install4j.api.context.WizardIndex
Construct a wizard index with the specified step names and index keys.
WrapperStyle - Class in com.install4j.api.styles
Abstract base class for a style that wraps a single user-selectable style.
WrapperStyle() - Constructor for class com.install4j.api.styles.WrapperStyle
 
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 
All Classes All Packages