- AbstractBean - Class in com.install4j.api.beans
-
Common base class for all abstract super-classes for beans that are handled by install4j.
- AbstractBean() - Constructor for class com.install4j.api.beans.AbstractBean
-
- AbstractFormComponent - Class in com.install4j.api.formcomponents
-
Abstract base class for form components.
- AbstractFormComponent() - Constructor for class com.install4j.api.formcomponents.AbstractFormComponent
-
- AbstractInstallAction - Class in com.install4j.api.actions
-
Abstract base class for install actions.
- AbstractInstallAction() - Constructor for class com.install4j.api.actions.AbstractInstallAction
-
- AbstractInstallerOrUninstallerScreen - Class in com.install4j.api.screens
-
Abstract base class for screens that can be used in the installer or uninstaller.
- AbstractInstallerOrUninstallerScreen() - Constructor for class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
-
- AbstractInstallerScreen - Class in com.install4j.api.screens
-
Abstract base class for installer screens.
- AbstractInstallerScreen() - Constructor for class com.install4j.api.screens.AbstractInstallerScreen
-
- AbstractInstallOrUninstallAction - Class in com.install4j.api.actions
-
Abstract base class for actions that can be used for installation or uninstallation.
- AbstractInstallOrUninstallAction() - Constructor for class com.install4j.api.actions.AbstractInstallOrUninstallAction
-
- AbstractUninstallAction - Class in com.install4j.api.actions
-
Abstract base class for uninstall actions.
- AbstractUninstallAction() - Constructor for class com.install4j.api.actions.AbstractUninstallAction
-
- AbstractUninstallerScreen - Class in com.install4j.api.screens
-
Abstract base class for uninstaller screens.
- AbstractUninstallerScreen() - Constructor for class com.install4j.api.screens.AbstractUninstallerScreen
-
- 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>, Class) - Constructor for class com.install4j.api.beaninfo.ActionBeanInfo
-
- ActionBeanInfo(String, String, String, boolean, boolean, Integer, Class<? extends Action>) - 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
-
- 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.
- 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.
- ALL_VALUES - Static variable in enum com.install4j.api.update.UpdateSchedule
-
Deprecated.
- 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.
- 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 - Enum in com.install4j.api.update
-
Enumeration class that represents the different display modes.
- applicationDisplayMode(ApplicationDisplayMode) - Method in class com.install4j.api.update.UpdateCheckRequest
-
Sets the display mode that should be used if proxy information should be required
- 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.
- 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_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_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_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_VISIBILITY_SCRIPT - Static variable in class com.install4j.api.beaninfo.FormComponentBeanInfo
-
- ATTRIBUTE_ENUMERATION_MAPPERS - Static variable in class com.install4j.api.beaninfo.Install4JBeanInfo
-
- 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
-
- 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_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
-
- 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.
- cancel() - Method in interface com.install4j.api.beaninfo.PropertyCustomizer
-
Called if the property customizer dialog is exited with the Cancel button.
- 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.
- CATEGORY_CONFIGURATION - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
-
Default category used by install4j.
- 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 versions set in this update
descriptor entry.
- clearInstallerVariablesCache() - Static method in class com.install4j.api.launcher.Variables
-
Clear the cache of read installer variables.
- closeProcesses(int[], int) - Static method in class com.install4j.api.windows.WinProcesses
-
Tries to close the processes with the given ids by sending a VM_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.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.
- 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.
- 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
-
- 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
-
- CONTEXT_SERVICE_LAUNCHER_ID - Static variable in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
-
- 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_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 a installer variable name.
- create(String, Class, String, String) - Static method in class com.install4j.api.beaninfo.ActionListPropertyDescriptor
-
- 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(String, Class, String, String) - Static method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
-
- create(String, Class, String, String, String) - Static method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
-
- create(String, Class, String, String, Class, ScriptParameter[]) - Static method in class com.install4j.api.beaninfo.ScriptPropertyDescriptor
-
- create(String, String, File, File) - Static method in class com.install4j.api.windows.WinAssociations
-
Creates a file association.
- createCenterComponent() - Method in interface com.install4j.api.formcomponents.FormComponent
-
Create the main component in the center.
- createComponent() - Method in interface com.install4j.api.screens.Screen
-
Return the visual component that is displayed for the screen.
- createKey(RegistryRoot, String) - Static method in class com.install4j.api.windows.WinRegistry
-
Creates a registry key.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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
-
- 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.
- 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.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
-
- 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
.
- 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(File) - Method in interface com.install4j.api.context.Context
-
Get the location where the installer will install a file in the distribution tree.
- getDestinationFile(String) - Method in interface com.install4j.api.context.Context
-
Same as getDestinationFile
, only with a path argument.
- getDestinationFile() - Method in interface com.install4j.api.context.FileInfo
-
Get the actual installation location of the file.
- getDestinationFile() - Method in class com.install4j.api.events.InstallerFileEvent
-
Get the installed file location that is associated with this event.
- getDestinationFileInfo(String) - Method in interface com.install4j.api.context.Context
-
Analyze a path in the distribution tree.
- 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(String) - Static method in class com.install4j.api.windows.WinEnvVars
-
Returns a single environment variable.
- getenv() - Static method in class com.install4j.api.windows.WinEnvVars
-
Returns all environment variables.
- getErrorHandlingCallback() - Method in class com.install4j.api.update.UpdateCheckRequest
-
- 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.
- 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 of a certain ID.
- getFormComponents() - Method in interface com.install4j.api.formcomponents.FormEnvironment
-
Returns all form components that are contained in the same form.
- 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
-
- 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
- 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(FormComponent) - Method in interface com.install4j.api.formcomponents.FormEnvironment
-
Get the ID that the framework associates with a form component.
- 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
.
- 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) - 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
-
- getLastUpdateCheckDate() - Static method in class com.install4j.api.update.UpdateScheduleRegistry
-
- 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.
- 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.
- getMaxWidth() - Method in class com.install4j.api.context.WizardIndex
-
Returns the maximum width of the index panel
- 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.
- 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
- getParentWindow() - Static method in class com.install4j.api.Util
-
Get the window of the installer.
- getPercentCompleted() - Method in class com.install4j.api.context.DefaultUnattendedProgressInterface
-
- 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
-
- 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
-
- 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.
- 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.
- 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.
- getStepNames() - Method in class com.install4j.api.context.WizardIndex
-
Returns the step names
- 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.
- 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.
- 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.
- 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(String, ApplicationDisplayMode) - Static method in class com.install4j.api.update.UpdateChecker
-
- getUpdateDescriptor(String, ApplicationDisplayMode, ErrorHandlingCallback) - Static method in class com.install4j.api.update.UpdateChecker
-
- 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.
- 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
-
- 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(int) - Static method in class com.install4j.api.windows.WinProcesses
-
Get the title of one of the visible top-level windows of this process.
- getWindowTitle() - Method in class com.install4j.api.windows.WinProcesses.Info
-
- 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.
- GroupType - Enum in com.install4j.api.formcomponents
-
Type of a layout group.
- Info(int, String, String, String, boolean) - Constructor for class com.install4j.api.macos.MacProcesses.Info
-
Called by the framework.
- Info(int, String) - Constructor for class com.install4j.api.windows.WinProcesses.Info
-
Called by the framework.
- 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
-
The name of this method has changed to "initialize"
- 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.
- Install4JBeanInfo - Class in com.install4j.api.beaninfo
-
Base class for bean infos.
- Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class<? extends Bean>, Class<?>) - Constructor for class com.install4j.api.beaninfo.Install4JBeanInfo
-
Constructor.
- Install4JBeanInfo(String, String, String, boolean, boolean, Integer, Class<? extends Bean>) - Constructor for class com.install4j.api.beaninfo.Install4JBeanInfo
-
- Install4JPropertyDescriptor - Class in com.install4j.api.beaninfo
-
- 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.
- 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, long) - 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 - Class in com.install4j.api.events
-
The event object that is passed to installer event listeners.
- InstallerEvent(Object, Context, EventType, boolean) - Constructor for class com.install4j.api.events.InstallerEvent
-
The constructor is called by the framework.
- InstallerEvent(Object, Context, EventType) - Constructor for class com.install4j.api.events.InstallerEvent
-
The constructor is called by the framework.
- installerEvent(InstallerEvent) - Method in interface com.install4j.api.events.InstallerEventListener
-
Called when an installer event is fired.
- installerEvent(InstallerEvent) - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
-
- installerEvent(InstallerEvent) - Method in class com.install4j.api.screens.AbstractUninstallerScreen
-
- InstallerEventListener - Interface in com.install4j.api.events
-
The interface that must be implemented by classes who are interested in installer events.
- InstallerFileEvent - Class in com.install4j.api.events
-
The event object that is passed to installer event listeners for 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
-
- 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
-
- 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.
- 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.
- 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.screens.Screen
-
Returns whether this screen wants to grow in the horizontal direction.
- isFillVertical() - Method in interface com.install4j.api.screens.Screen
-
Returns whether this screen wants to grow in the vertical direction.
- isGroupCreated() - Method in class com.install4j.api.windows.WinUser.AddUserResult
-
Check if the local group was newly created
- 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.
- 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.
- 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.
- 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.
- isShowIndex() - Method in class com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
-
- isShowIndex() - Method in class com.install4j.api.screens.AbstractInstallerScreen
-
- isShowIndex() - Method in class com.install4j.api.screens.AbstractUninstallerScreen
-
- isShowIndex() - Method in interface com.install4j.api.screens.Screen
-
This method is called by the framework to determine if an active
WizardIndex
that has been set via the API should be shown for this screen.
- isShowProxyOnErrorCode() - Method in class com.install4j.api.update.UpdateCheckRequest
-
- isSolaris() - Static method in class com.install4j.api.Util
-
Returns whether the platform is Solaris.
- isUnattended() - Method in interface com.install4j.api.context.Context
-
Returns whether the installer or uninstaller is running in unattended mode.
- isUninstaller() - Method in interface com.install4j.api.context.LauncherSetup
-
Returns whether the launcher is the uninstaller.
- isUninstallForUpgrade() - Method in interface com.install4j.api.context.UninstallerContext
-
Returns whether the uninstaller is running as part of an upgrade.
- isUnixInstaller() - Static method in class com.install4j.api.Util
-
Returns whether the installer is a Unix installer
- isUpdateDirectory(File) - Static method in class com.install4j.api.ApplicationRegistry
-
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.
- 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.
- 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.
- 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.
- 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
-
- 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.
- 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>, Class) - Constructor for class com.install4j.api.beaninfo.ScreenBeanInfo
-
- ScreenBeanInfo(String, String, String, boolean, boolean, Integer, Class<? extends Screen>) - Constructor for class com.install4j.api.beaninfo.ScreenBeanInfo
-
- ScriptParameter - Class in com.install4j.api.beaninfo
-
- ScriptParameter(String, Class) - Constructor for class com.install4j.api.beaninfo.ScriptParameter
-
Create a script parameter.
- ScriptProperty - Class in com.install4j.api.beans
-
Property type for script properties to be used in beans.
- ScriptProperty() - Constructor for class com.install4j.api.beans.ScriptProperty
-
The constructor is called by the framework.
- ScriptProperty(String) - Constructor for class com.install4j.api.beans.ScriptProperty
-
The constructor is called by the framework.
- ScriptPropertyDescriptor - Class in com.install4j.api.beaninfo
-
- 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
-
- ServiceInfo - Class in com.install4j.api
-
Provides information about services created with install4j.
- ServiceInfo() - Constructor for class com.install4j.api.ServiceInfo
-
- set(String, String) - Static method in class com.install4j.api.windows.WinEnvVars
-
Sets a global environment variable.
- 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.
- 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
-
Change the enabled status of the "Back" button at the bottom of the current screen.
- setBackButtonVisible(boolean) - Method in interface com.install4j.api.context.WizardContext
-
Change the visibility of the "Back" button at the bottom of the current screen.
- setBeanInitializer(BeanInitializer) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
-
Configures a bean initializer.
- setBeanValidator(BeanValidator) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
-
Configures a bean validator.
- 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
-
Change the enabled status of the "Cancel" button at the bottom of the current screen.
- setCancelButtonText(String) - Method in interface com.install4j.api.context.WizardContext
-
Set the text on the "Cancel" button.
- 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
-
Change the visibility of the "Cancel" button at the bottom of the current screen.
- 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.
- setContext(String) - Method in class com.install4j.api.beaninfo.Install4JPropertyDescriptor
-
Set the context for the property.
- 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.
- 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.
- 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.
- 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
-
- 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
.
- 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
-
Configures the placement of the form component customizer for form screens.
- setFormEnvironment(FormEnvironment) - Method in class com.install4j.api.formcomponents.AbstractFormComponent
-
- setFormEnvironment(FormEnvironment) - Method in interface com.install4j.api.formcomponents.FormComponent
-
At runtime, this method is called twice by the framework.
- setFormPanel(JPanel, FormEnvironment) - Method in interface com.install4j.api.screens.FormPanelContainer
-
This method is called by the framework to pass the form panel to this screen.
- 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
-
- setMinimumJavaVersion(String) - Method in class com.install4j.api.beaninfo.Install4JBeanInfo
-
Sets the minimum Java version that this bean will work with.
- setMode(int) - Method in class com.install4j.api.context.FileOptions
-
Sets the unix file mode as an integer.
- setMode(String) - Method in class com.install4j.api.context.FileOptions
-
Sets the unix file mode as an octal string.
- setMode(int, File) - Static method in class com.install4j.api.unix.UnixFileSystem
-
Set the Unix file mode for a file.
- setMode(String, File) - Static method in class com.install4j.api.unix.UnixFileSystem
-
Set the Unix file mode for a file.
- setNextButtonEnabled(boolean) - Method in interface com.install4j.api.context.WizardContext
-
Change the enabled status of the "Next" button at the bottom of the current screen.
- setNextButtonText(String) - Method in interface com.install4j.api.context.WizardContext
-
Set the text on the "Next" button.
- setNextButtonVisible(boolean) - Method in interface com.install4j.api.context.WizardContext
-
Change the visibility of the "Next" button at the bottom of the current screen.
- 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
-
Set the text on the "Previous" button.
- 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.
- 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(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.
- 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.
- 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
-
- 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.
- 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.
- 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, int) - Static method in class com.install4j.api.Util
-
Show a message dialog.
- showMessage(String) - Static method in class com.install4j.api.Util
-
Show a message dialog.
- showOptionDialog(String, String[], int) - Static method in class com.install4j.api.Util
-
Show an options dialog.
- 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.
- 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.
- STARTUP_SEQUENCE - Static variable in class com.install4j.api.beaninfo.ActionBeanInfo
-
- 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.
- 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.
- 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
-
- 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.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.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.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.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.
- VariableErrorHandling - Enum in com.install4j.api.beans
-
- 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
-
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.
- VisibilityDiscriminator - Interface in com.install4j.api.beaninfo
-
Interface for controlling the visibility of child properties based on the value of the parent property.