| Category: Standard screens
Welcome | |
A screen that welcomes the user to the installation of your application. This screen should be placed at the beginning of the installation | Applies to: Installer | Properties: | |
|
Display license agreement | |
A screen that displays a license agreement to the user, either plain text or HTML. The license agreement must be accepted before the installation continues. | Applies to: Installer | Properties: | |
|
Installation location | |
The screen that asks the user where to install the application. This determines the principal installation directory. | Applies to: Installer | Properties: | - Suggest application directory [Application ID]
When the user chooses a directory, always append the default application directory configured in the media file wizard. You should only switch this off if you substitute a different installation directory in the screen validation. - Existing directory warning [Application ID]
Ask the user whether to install the application in the selected directory if it already exists and the installation is not an update. - Check if directory is writable [Application ID]
Check if the directory is writable with the currently available privileges and show a warning message if it is not. If you deselect this option, and the directory is not writable, you should execute a "Request privileges" action before installing files to the installation directory. - Allow new folder creation [Chooser Dialog]
If selected, the directory chooser that is displayed with the chooser button will feature a button to create new directories. - Manual entry allowed [Chooser Dialog]
If selected, the user can enter the installation directory manually in the text field. Otherwise, the text field is disabled. - Insufficient disk space warning [Disk Space]
Show a warning message if there is not sufficient disk space for the installation on the selected target drive. - Show required disk space [Disk Space]
Show the disk space that is required for the installation. You should switch this off if your installation includes other data sources. - Show free disk space [Disk Space]
Show the disk space that is available on the selected drive or partition. This setting is only effective for Windows, macOS and Linux. - Allow spaces in directory name [Unix]
If selected, spaces are valid characters in the installation directory name for Unix/Linux installers, otherwise an error message is displayed if the user chooses a directory with spaces in it. Some JREs do not work on Unix if installed to a path that contains spaces, so spaces are disallowed by default. - Validation script [User input]
The script that is executed when the installation directory is selected with the chooser button and when the user clicks on the Next button of the screen. If the script returns true, the selection is accepted, if it returns false, the selection is discarded. - Standard validation [User input]
If selected, the standard validation for well-formed directory names will be performed. This validation is performed before the validation script and will canonicalize the directory name before passing it to the validation script.
|
|
Installation type | |
A screen that displays a list of installation types that correspond to configurable component sets. The default types "Full","Standard" and "Customize" are provided by default. The "Installation components" screen may be hidden by this screen, depending on the installation type selected by the user. This screen will not be shown if no installation components are defined. | Applies to: Installer | Properties: | - Installation types
Installation types are principally defined by a configurable set of components. The first installation type is selected by default in the installer. Each installation type has the following configurable properties: - A name for the installation type. This name is presented to the user
- An optional description of the installation type. This description is displayed below the name and can be shown or hidden by the user
- If the description is displayed by default or not
- If the installation type is customizable or not. If the user-selected installation type is customizable, the "Installation components" screen will be shown if present, otherwise that screen will be skipped.
- A set of installation components. Installation components are configured in the install4j IDE on the Files->Installation Components tab.You can choose between the options of installing all defined components, the default selected components as configured on the Files->Installation Components tab, or directly select a number of installation components in a check tree.
By default, 3 universally usable installation types are added whose names and descriptions are internationalized. You can change or delete the default installation types as well as add new ones. - Bold font [Description]
Use a bold font for the descriptions - Italic font [Description]
Use an italic font for the descriptions - Smaller font [Description]
Use a smaller font for the descriptions
|
|
Installation components | |
A screen that displays all installation components and asks the user which components should be installed. This screen will not be shown if no installation components are defined. | Applies to: Installer | Properties: | - Show installation directory chooser
Show the installation directory chooser below the component selector. - Show required disk space [Disk Space]
Show the disk space that is required for the installation. You should switch this off if your installation includes other data sources.Note: This property is only visible if "Show installation directory chooser" is selected. - Show free disk space [Disk Space]
Show the disk space that is available on the selected drive or partition. This setting is only effective for Windows, macOS and Linux.Note: This property is only visible if "Show installation directory chooser" is selected. - Suggest application directory [Application ID]
When the user chooses a directory, always append the default application directory configured in the media file wizard. You should only switch this off if you substitute a different installation directory in the screen validation.Note: This property is only visible if "Show installation directory chooser" is selected. - Existing directory warning [Application ID]
Ask the user whether to install the application in the selected directory if it already exists and the installation is not an update.Note: This property is only visible if "Show installation directory chooser" is selected. - Check if directory is writable [Application ID]
Check if the directory is writable with the currently available privileges and show a warning message if it is not. If you deselect this option, and the directory is not writable, you should execute a "Request privileges" action before installing files to the installation directory.Note: This property is only visible if "Show installation directory chooser" is selected. - Allow spaces in directory name [Unix]
If selected, spaces are valid characters in the installation directory name for Unix/Linux installers, otherwise an error message is displayed if the user chooses a directory with spaces in it. Some JREs do not work on Unix if installed to a path that contains spaces, so spaces are disallowed by default.Note: This property is only visible if "Show installation directory chooser" is selected. - Allow new folder creation [Chooser Dialog]
If selected, the directory chooser that is displayed with the chooser button will feature a button to create new directories.Note: This property is only visible if "Show installation directory chooser" is selected. - Manual entry allowed [Chooser Dialog]
If selected, the user can enter the installation directory manually in the text field. Otherwise, the text field is disabled.Note: This property is only visible if "Show installation directory chooser" is selected. - Validation script [User input]
The script that is executed when the installation directory is selected with the chooser button and when the user clicks on the Next button of the screen. If the script returns true, the selection is accepted, if it returns false, the selection is discarded.Note: This property is only visible if "Show installation directory chooser" is selected. - Standard validation [User input]
If selected, the standard validation for well-formed directory names will be performed. This validation is performed before the validation script and will canonicalize the directory name before passing it to the validation script.Note: This property is only visible if "Show installation directory chooser" is selected. - Selection change script
A script that is invoked each time the selection state of a component is changed. If a component has dependencies that are changed as well, or if entire folders are toggled, this script will be called repeatedly, once for each installation component whose selection state is changed. If the dependency parameter is false, this tells you that the corresponding installation component belongs to the node that the user has actually toggled. If a folder is toggled, dependency will be true for all installation components. - Bold font [Description]
Use a bold font for the descriptions - Italic font [Description]
Use an italic font for the descriptions - Smaller font [Description]
Use a smaller font for the descriptions - Insufficient disk space warning [Disk Space]
Show a warning message if there is not sufficient disk space for the installation on the selected target drive.
|
|
Create program group | |
A screen that allows the user to select the default program group. Under Windows, this screen sets installer variables that influence "Create program group" and "Create start menu entry" entry actions. Under Unix, the screen asks the user whether and where symbolic links to launchers should to be created. Under macOS, the screen is not shown. | Applies to: Installer | Properties: | - User can disable creation [General]
If the user can disable all program group actions that rely on a default program group, such as the "Create standard program group action". If the user disables program group creation, the variable sys.programGroupDisabled will be set to Boolean.TRUE. - Initially enabled
If the check box for enabling program group or launcher link creation should be selected by default.Note: This property is only visible if "User can disable creation" is selected. - Create symlinks [Unix]
If symbolic links for all relevant launchers (those with "menu integration" enabled) should be created on UNIX. If this property is deselected, the variable sys.programGroupDisabled will be set to Boolean.TRUE in Linux/Unix installers. - Directory for links
The default value for the directory in which links for all relevant launchers (those with "menu integration" enabled) will be created on UNIX. The user selection will be saved to the variable sys.symlinkDir.Note: This property is only visible if "Create symlinks" is selected. - Program group name [Windows]
The default value for the program group where entries for all relevant launchers (those with "menu integration" enabled) will be created. If the "Create program group" screen is present, the user can change this selection. If you leave this property empty, the links will be created at the top level. The user selection will be saved to the variable sys.programGroupName. - User can change "all users" [Windows]
If the user can override the default value of the "Create for all users" property in the "Create standard program group" action. The user selection will be saved to the variable sys.programGroupAllUsers. - Initially selected
If the "Create for all users" check box be selected by default.Note: This property is only visible if "User can change "all users"" is selected. - Show warning if program group exists [Windows]
If selected, a warning will be shown if the selected program group already exists.
|
|
File associations | |
A screen that displays a list of all subsequent file association actions and asks the user which associations should be made. This screen will not be shown if there are no corresponding file association actions after this screen. | Applies to: Installer | Properties: | - Show selection buttons
If selected, the screen will show buttons for selecting and deselecting all file associations.
|
|
Additional confirmations | |
A screen that displays a list of confirmations as check boxes whose results can be used in condition expressions for actions. While other types of form components can be added to this screen, only check boxes and other simple elements are consistent with the displayed text. For arbitrary forms, use the "Configurable form" screen instead. | Applies to: Installer, Uninstaller |
|
Installation | |
The screen that displays displays the installation progress. Where possible, installation actions should be added to this screen. | Applies to: Installer | Properties: | - Cancel enabled
If the cancel button should be enabled.
|
|
Display information | |
A screen that displays text to the user, either plain text or HTML. In contrast to the "Display text" screen, all messages on this screen are pre-defined and localized. | Applies to: Installer, Uninstaller | Properties: | |
|
Finish | |
A screen that tells the user that the installation is finished. This screen should be placed at the end of the installation. | Applies to: Installer | Properties: | |
|
Uninstall Welcome | |
A screen that welcomes the user to the uninstallation of your application. This screen should be placed at the beginning of the uninstallation. | Applies to: Uninstaller | Properties: | |
|
Uninstallation | |
The screen that displays displays the uninstallation progress. Where possible, uninstallation actions should be added to this screen. | Applies to: Uninstaller |
|
Uninstallation failure | |
The screen that is displayed if the uninstallation was not completed successfully. Further information regarding the uninstallation problems is displayed to the user. This screen is not shown if the uninstallation was completed successfully or if it is placed before the uninstallation screen. The uninstaller will terminate after showing this screen in case of failure. | Applies to: Uninstaller | Properties: | - Show directories [General]
Also show initially created directories that could not be deleted. If unchecked, only undeleted files will be shown.
|
|
Uninstallation success | |
The screen that is displayed if the uninstallation was completed successfully. | Applies to: Uninstaller | Properties: | |
|
|