All Classes and Interfaces (install4j API)
Description: class index

# All Classes and Interfaces

Class
Description
AbstractBean
Common base class for all abstract superclasses for beans that are handled by install4j.
AbstractFormComponent
Abstract base class for form components.
AbstractInstallAction
Abstract base class for install actions.
AbstractInstallerOrUninstallerScreen
Abstract base class for screens that can be used in the installer or uninstaller.
AbstractInstallerScreen
Abstract base class for installer screens.
AbstractInstallOrUninstallAction
Abstract base class for actions that can be used for installation or uninstallation.
AbstractStyle
Abstract base class for styles.
AbstractUninstallAction
Abstract base class for uninstall actions.
AbstractUninstallerScreen
Abstract base class for uninstaller screens.
Action
The base interface for all actions.
ActionBeanInfo
Base class for BeanInfos of actions classes.
ActionElevationType
Enumeration class for all possible elevation strategies for actions.
ActionInitializer
Interface for initializing actions that are associated with screens.
ActionList
Property type for a configurable list of actions.
ActionListInitializer
Interface for the `ActionBeanInfo.ATTRIBUTE_ACTION_LIST_INITIALIZER` value of a bean descriptor.
ActionListPropertyDescriptor
Property descriptor for properties that contain a list of configurable actions.
ActionValidator
Validates actions if the validation depends on a containing `ActionList` property.
Anchor
Property type for an anchor.
ApplicationDisplayMode
Enumeration class that represents the different display modes.
ApplicationLauncher
This class allows you to launch an installer application, such as an updater, from your own application.
ApplicationLauncher.Callback
You can implement this interface to receive notifications when the installer application exits or needs to shut down your application.
ApplicationLauncher.ProgressListener
You can implement this interface to receive progress information from the installer application.
ApplicationLauncher.ProgressListenerAdapter
Empty implementation of `ApplicationLauncher.ProgressListener`.
ApplicationLauncher.WindowMode
Window mode for starting the application in process.
ApplicationRegistry
The class provides information about applications installed with install4j.
ApplicationRegistry.ApplicationInfo
Provides information about an application installed by install4j.
AskUserFailureDefaults
Configuration class to set the default selection values of the possible answers for the "Ask user" failure strategy when configuring actions in the install4j IDE.
AutoUninstallAction
If you write an installation action that wants to be automatically invoked in the uninstaller to revert its changes, you can additionally implement this interface.
Bean
Common interface for all types of beans that are handled by install4j.
BeanInitializer
Interface for the `Install4JBeanInfo.ATTRIBUTE_BEAN_INITIALIZER` value of a bean descriptor.
BeanValidationException
Exception for notifying the user that a property value of a bean is not valid.
BeanValidator
Interface for the `Install4JBeanInfo.ATTRIBUTE_BEAN_VALIDATOR` value of a bean descriptor.
ComponentTuple
Represents the created GUI components for a form component.
Console
A `Console` object allows you to display information to the user and request input when the installer or uninstaller is running in console mode.
Context
Base class for installation and uninstallation context.
ControlButton
Implemented by form components that want to handle navigation functionality for a style.
ControlButtonContainer
Implemented by objects that handle navigation functionality.
ControlButtonType
Types of navigation buttons in the user interface.
CustomizerCallback
Extended design-time services for customizers.
CustomizerPlacement
Enumeration class for all possible placements of the customizer in the install4j GUI.
DefaultUnattendedProgressInterface
Default implementation of `UnattendedProgressInterface`.
DriveType
Enumeration class for the different drive types a file can be located on.
Elevation
Collection of methods regarding the UAC elevation state on Windows Vista or higher.
ElevationState
Enumeration class for the different elevation states the current process can be in.
EnumerationMapEntry
Entry in an enumeration defined by `EnumerationMapper`.
EnumerationMapper
Interface for mapping values and descriptions of enumerated properties.
ErrorHandlingCallback
Callback for deciding how an error should be handled.
ErrorHandlingMode
Indicates the action that should be taken after an error has occurred.
EventType
Enumeration class that represents all different event types for instances of `InstallerEvent`.
ExternalFile
Property type for files from outside the distribution tree to be used in beans.
FailureStrategy
Enumeration class for all possible failure strategies of actions.
FileContentType
Enumeration class for all possible file content types for file property descriptors.
FileInfo
Provides information about a file in the distribution tree.
FileOptions
An object that contains options for the installation and uninstallation of a file.
FilePropertyDescriptor
Property descriptor for properties that contain one or several file.
FileSelectionMode
Enumeration class for all possible file selection modes for file property descriptors.
FileSetSetup
This interface provides information about file sets.
FormComponent
All form components must implement this interface.
FormComponentBeanInfo
Base class for form component bean infos.
FormEnvironment
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
Any screen can have a form panel, just like the "Additional confirmations" screen or the "Configurable form" screen.
GroupType
Type of a layout group.
IndeterminateStateComponent
Interface that must be implemented by a tri-state check box.
Install4JBeanInfo
Base class for bean infos.
Install4JPropertyDescriptor
Property descriptor for use in instances of `Install4JBeanInfo`.
InstallAction
All install actions must implement this interface.
InstallationComponentSetup
This interface provides information about installation components.
InstallerActionEvent
The event object that is passed to installer event listeners after an action has been executed.
InstallerContext
The context provided by the installer.
InstallerDirectoryEvent
The event object that is passed to installer event listeners for the directory creation event.
InstallerDownloadEvent
The event object that is passed to installer event listeners for download events types.
InstallerDownloadEvent.DownloadProgressListener
A listener that is informed about the progress of a download.
InstallerEvent
The event object that is passed to installer event listeners.
InstallerEventListener
The interface that must be implemented by classes who are interested in installer events.
InstallerFileEvent
The event object that is passed to installer event listeners for single file installation events types.
InstallerFileInstallationEvent
The event object that is passed to installer event listeners when the file installation is started.
InstallerScreen
All installer screens must implement this interface.
InstallerVariableEvent
The event object that is passed to installer event listeners for the variable change event type.
JVMSelector
With this class, you can retrieve the installed JVMs on Windows, Linux and Unix systems.
JVMSelector.JVMLocation
The interface providing information about a JVM.
LauncherSetup
This interface provides information about launchers.
LauncherType
Enumeration class that represents the different types of launchers.
LayoutGroup
Represents a layout group for form components.
LocalizedExternalFile
Container for a set of localized files that represent a single `ExternalFile` with textual content.
LookAndFeelEnhancer
The look and feel enhancer helps screens, form components and styles with specific aspects of creating the UI.
LookAndFeelHandler
A look and feel handler can apply a look and feel.
MacProcesses
Collection of static methods to check for running processes on macOS and terminate them.
MacProcesses.Info
Class that holds information about running macOS processes.
MacServiceManagement
Methods for controlling helper executables that live inside an app’s main bundle on macOS.
MacServiceManagement.AppServiceStatus
Enumeration representing the possible statuses of an application service or process.
MacServiceManagement.ServiceManagementResult
Result of a service management operation.
MessageStatus
Status of a console message, used by `Console.println(Object, MessageStatus)` to color the output in consoles that support styling.
NestedStyleContainer
Implemented by styles that contain nested styles.
NotSupportedInElevationException
Exception that is thrown if a method is called that is not supported for elevated actions.
OverwriteMode
Enumeration class that represents the different ways how install4j can react if asked to install a file over an already existing file.
ProcessInfo
Represents a running process on Windows and macOS.
ProgressInterface
The user notification interface during installation.
ProjectReportProperty
A project report element contributed by a customizer.
PropertyConverter
A property converter translates between a string representation and the actual object state and provides an optional `property customizer`.
PropertyCustomizer
Customizer component for a property that is used in a dialog.
PropertyFilter
A filter interface that can be used to determine whether a property should be included or not.
PropertyLoggingInterceptor
Interceptor interface for beans to modify property values that are written to the installer log file.
RegistryRoot
Enumeration class for the different registry roots in the Microsoft Windows registry.
RegistryView
Enumeration class for the different views of the Microsoft Windows registry on 64-bit systems.
RemoteCallable
On macOS and Windows Vista and higher, the 'require admin user' action can spawn additional installation processes that have full admin rights.
ReplacementMode
Variable replacement mode for string properties that are used in regular expressions.
Screen
The base interface for all screens.
ScreenBeanInfo
Base class for screen bean infos.
ScriptParameter
Descriptor for script parameters of script properties defined with a `ScriptPropertyDescriptor`.
ScriptProperty
Property type for script properties to be used in beans.
ScriptPropertyDescriptor
Property descriptor for properties of type `ScriptProperty`.
SequenceValidator
Interface for controlling insertion and reordering of beans at design-time.
SerializableEnum
Support class for old-style enums that work with Java 1.4 and are serializable.
ServiceAccessException
This exception is thrown when a call to `WinServices` was made with insufficient privileges.
ServiceAccount
An enum to specify service accounts.
ServiceConfiguration
The service configuration passed to `WinServices`.
ServiceException
The base exception type used by `WinServices`.
ServiceInfo
Provides information about services created with install4j.
ServiceNotFoundException
This exception is thrown when a call to `WinServices` was made with a non-existing service name.
ServiceStartType
The start types of Windows services
ShowCommand
The show command for a shell link.
SpecialFolder
Enumeration class for the different special system folders in Microsoft Windows.
SplashScreen
This class allows you to control the splash screen of an install4j launcher from your Java code.
SplashScreen.ConnectionException
The exception thrown by methods of the `SplashScreen` class to indicate that a splash screen operation was not successful.
StartupNotification
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.Listener
The interface for startup events in single instance mode or for open file events on macOS.
Style
All styles must implement this interface.
StyleContext
Context object that gives access to the style-relevant properties of a screen and its content component that should be embedded into the screen style component.
StyleContextReceiver
Implemented by objects that handle screen style context changes.
StyleManager
Helper for working with nested styles.
SystemInfo
The class contains utility functions to get information about the current system that is not available via the Java API.
UiUtil
This class contains methods that deal with global properties of the installer application GUI.
UnattendedProgressInterface
The user notification interface during unattended installations.
UndefinedVariableException
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`.
UninstallAction
All uninstall actions must implement this interface.
UninstallerContext
The context provided by the uninstaller.
UninstallerScreen
All uninstaller screens must implement this interface.
UninstallMode
Enumeration class that represents the different ways how install4j can handle the uninstallation of a file.
UnixFileSystem
Collection of static methods to access Unix-specific file operations and information.
UnixFileSystem.FileInformation
Holds Unix-specific information about a file.
UpdateChecker
Utility class to download an update descriptor programmatically from a given URL.
UpdateCheckRequest
An update check request for `UpdateChecker.getUpdateDescriptor(UpdateCheckRequest)`.
UpdateDescriptor
Contains information about available updates.
UpdateDescriptorEntry
Contains information about a single media file available for update.
UpdateSchedule
Enumeration class that represents the different update schedules.
UpdateScheduleRegistry
Administrates an update schedule for your application.
UserCanceledException
Installation methods throw this exception if the user cancels an operation.
Util
The class contains various utility functions to be used by script properties, custom actions and custom screens.
VariableErrorHandling
Used in `VariableErrorHandlingDescriptor` to configure the error handling for a single variable type.
VariableErrorHandlingDescriptor
Specifies the error handling for variable replacements.
Variables
This class provides methods to access compiler and installer variables from your launchers.
VisibilityDiscriminator
Interface for controlling the visibility of child properties based on the value of the parent property.
VisualContainerBean
Implemented by beans that contain visual components.
WidgetStyleHandler
With the widget style handler, you can apply a widget style to certain Swing components.
WinAssociations
Collection of static methods to create and remove file associations on Microsoft Windows.
WindowInfo
Collection of methods to retrieve information about windows on Microsoft Windows.
WinEnvVars
Collection of static methods to get and modify environment variables on Windows.
WinFileSystem
Collection of static methods to access Microsoft Windows-specific folder locations and to execute native file system operations.
WinFirewall
Collection of static methods to add and delete Windows firewall rules.
WinFirewall.AccessDeniedException
Thrown if a modification cannot be performed because the calling process does not have administrative rights.
WinFirewall.FirewallException
Thrown if an error other than missing access rights is encountered.
WinFirewall.NetworkProtocol
The network protocol for a Windows firewall rule.
WinFirewall.ProfileType
The Windows firewall profiles.
WinFirewall.Rule
A Windows firewall rule.
WinFirewall.RuleDirection
The direction of a Windows firewall rule.
WinProcesses
Collection of static methods to check for running processes on Windows and terminate them.
WinProcesses.Info
Class that holds information about running Windows processes.
WinRegistry
Collection of static methods to access the Microsoft Windows registry.
WinRegistry.ExpandString
Class to represent Strings with type REG_EXPAND_SZ.
WinServices
Collection of static methods to manipulate Windows services
WinUser
Collection of static methods to create or delete users and local groups on Windows.
WinUser.AddUserResult
The class of the objects returned by `WinUser.addUser(java.lang.String, java.lang.String, java.lang.String, com.install4j.api.windows.WinUser.GroupCreationMode, java.lang.String, java.lang.String)`.
WinUser.AddUserResultType
The type of result returned by `WinUser.addUser(java.lang.String, java.lang.String, java.lang.String, com.install4j.api.windows.WinUser.GroupCreationMode, java.lang.String, java.lang.String)`
WinUser.GroupCreationMode
The group creation mode.
WizardContext
The wizard context allows you to modify the GUI installer or uninstaller.
WizardIndex
A wizard index is used to configure a display of overall installation progress on the left side of the wizard.
WrapperStyle
Abstract base class for a screen style that wraps a single user-selectable style.