Package com.install4j.api.context
This package contains classes that allow you to interact with the installer and its environment.
See the API overview for general remarks on how to use the install4j API.
The Context
interface contains all methods that are available in both installer and uninstaller.
Concrete interfaces are InstallerContext
and UninstallerContext
.
Context objects are available as parameters in all script/expression properties in the install4j GUI.
Context objects are passed to the install
and uninstall
methods of
actions.
Screens and
form components
receive an appropriate context via a setter method after they are constructed.
-
Interface Summary Interface Description Context Base class for installation and uninstallation context.FileInfo Provides information about a file in the distribution tree.FileSetSetup This interface provides information about file sets.InstallationComponentSetup This interface provides information about installation components.InstallerContext The context provided by the installer.LauncherSetup This interface provides information about launchers.ProgressInterface The user notification interface during installation.RemoteCallable On macOS and Windows Vista and higher, the 'require admin user' action can spawn additional installation processes that have full admin rights.UnattendedProgressInterface The user notification interface during unattended installations.UninstallerContext The context provided by the uninstaller.WizardContext The wizard context allows you to modify the GUI installer or uninstaller. -
Class Summary Class Description DefaultUnattendedProgressInterface Default implementation ofUnattendedProgressInterface
.FileOptions An object that contains options for the installation and uninstallation of a file.WizardIndex A wizard index is used to configure a display of overall installation progress on the left side of the wizard. -
Enum Summary Enum Description ControlButtonType Types of navigations buttons in the user interface.LauncherType Enumeration class that represents the different types of launchers.OverwriteMode Enumeration class that represents the different ways how install4j can react if asked to install a file over an already existing file.UninstallMode Enumeration class that represents the different ways how install4j can handle the uninstallation of a file. -
Exception Summary Exception Description NotSupportedInElevationException Exception that is thrown if a method is called that is not supported for elevated actions.UserCanceledException Installation methods throw this exception if the user cancels an operation.