Installer - Available Screens

## Installer - Available Screens |

| Category: Customizable screens
Banner screen
A screen that has a banner on the left side and some text on white background on the right side. Banner screens are suitable for start and finish screens.
Applies to: Installer, Uninstaller
Properties:
Background color for banner If you specify a custom banner, you might want to adjust the background color of the banner panel, the default value is suitable for the standard banner. Set to "None" in order to reset to the default value. Image for banner Specify a PNG or GIF image file for your custom banner. Clear to reset to the default banner. Image anchor The anchor where the image will be fixed in the banner panel. Screen title [Messages] The title of the screen, shown in a bold and larger font. Should be a concise subject. This question is also used by the console installer for presenting the screen. Info text [Messages] A paragraph that explains to the user what this screen is about. This message is shown in the body of the screen.
Directory selection
A screen that asks the user to select a directory. All displayed messages are configurable.
Applies to: Installer, Uninstaller
Properties:
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 directory manually in the text field. Otherwise, the text field is disabled. Initial directory The initially selected directory. Can be empty if no directory should be initially selected. Standard directory A directory name that should be appended to the user selection in the directory browser. Should be empty if an existing directory has to be selected. Screen title [Messages] The title of the screen, shown in a bold and larger font. Should be a concise subject. Screen subtitle [Messages] The subtitle of the screen, shown below the title in a normal font. Should be a short question. This question is also used by the console installer for presenting the screen. Info text [Messages] A paragraph that explains to the user what this screen is about. This message is shown in the body of the screen. Directory description [Messages] The description of the kind of directory that use should select in a few words, e.g. "ABC directory". 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 no work on Unix if installed to a path that contains spaces, so spaces are disallowed by default. Variable name for selection [User input] The name of the variable to which the selected directory is saved when the user advances to the next screen. Only accept writable directories [User input] If selected, non-writable directories will be rejected. Validation script [User input] The script that is executed when the directory is selected with the chooser button. If the script returns true, the selection is accepted, if it returns false, the selection is discarded.
Display PDF document
Displays a PDF in an embedded cross-platform viewer.
Applies to: Installer, Uninstaller
Properties:
PDF file The PDF file to display. Show navigation toolbar Displays a toolbar with button to browse page backward/forward Show matrix toolbar Displays a toolbar that controls the page layout Show zoom toolbar Displays a toolbar that shows zoom controls and page rotation Screen title [Messages] The title of the screen, shown in a bold and larger font. Should be a concise subject. Screen subtitle [Messages] The subtitle of the screen, shown below the title in a normal font. Should be a short question. This question is also used by the console installer for presenting the screen.
Display progress
A screen that displays a progress bar with a status line capturing the progress information of associated actions. The associated actions are executed immediately when the screen is activated. All displayed messages are configurable.
Applies to: Installer, Uninstaller
Properties:
Cancel enabled If the cancel button should be enabled. Screen title [Messages] The title of the screen, shown in a bold and larger font. Should be a concise subject. Screen subtitle [Messages] The subtitle of the screen, shown below the title in a normal font. Should be a short question. This question is also used by the console installer for presenting the screen. Initial status message [Messages] The initial status message displayed by the progress screen. You can change this message with "Set messages" actions or by invoking `Context.getProgressInterface().setStatusMessage("...")`.
Display text
A screen that displays text to the user, either plain text or HTML. All displayed messages are configurable.
Applies to: Installer, Uninstaller
Properties:
Text source The source from which the text is loaded. For multi-language installers, the "File" source is recommended since it is more easily localizable than the direct entry. Text file The file from which the text is loaded. Note: This property is only visible if "Text source" is set to "File". Text The text that is displayed in the screen, either plain text or HTML. For HTML, the value should start with , otherwise the plain text will be displayed. The text is displayed in a scrollable text area. Note: This property is only visible if "Text source" is set to "Direct". Variable name Optionally, you can save the actually displayed text to a variable. Enter the variable name without the installer prefix and the percent signs. This is useful if you have a localized license text and want to save the actually displayed text with a "Write text to a file" action later on. Screen title [Messages] The title of the screen, shown in a bold and larger font. Should be a concise subject. Screen subtitle [Messages] The subtitle of the screen, shown below the title in a normal font. Should be a short question. This question is also used by the console installer for presenting the screen. Info text [Messages] A paragraph that explains to the user what this screen is about. This message is shown in the body of the screen.
Program group selection
A screen that allows the user to select a program group on Microsoft Windows. All displayed messages are configurable.
Applies to: Installer, Uninstaller
Properties:
Variable name for selection The name of the variable to which the selected program group is saved when the user advances to the next screen. Initial program group The initially selected program group. Can be empty if no program group should be initially selected. Program groups for all users If selected, the program groups for all users are shown, otherwise the program groups for the current user are shown. Show warning if program group exists If selected, a warning will be shown if the selected program group already exists. Screen title [Messages] The title of the screen, shown in a bold and larger font. Should be a concise subject. Screen subtitle [Messages] The subtitle of the screen, shown below the title in a normal font. Should be a short question. This question is also used by the console installer for presenting the screen. Info text [Messages] A paragraph that explains to the user what this screen is about. This message is shown in the body of the screen.

| Category: Free forms
Configurable banner form
A screen where form elements can be configured along the vertical axis. Most types of information that you would like to query from a user during the installation can be easily expressed with this screen. The screen has a banner on the left side and a white background on the right side. Banner screens are suitable for start and finish screens.
Applies to: Installer, Uninstaller
Properties:
Background color for banner If you specify a custom banner, you might want to adjust the background color of the banner panel, the default value is suitable for the standard banner. Set to "None" in order to reset to the default value. Image for banner Specify a PNG or GIF image file for your custom banner. Clear to reset to the default banner. Image anchor The anchor where the image will be fixed in the banner panel. Fill horizontally [Form] If set, the form will fill the entire horizontal extent of the screen. Otherwise, it will be centered horizontally and all form components will not be wider than their preferred widths. Fill vertically [Form] If set, the form will fill the entire vertical extent of the screen. Otherwise, it will be centered vertically. Note that form components always have their preferred heights when the "Scrollable" property is selected. If "Fill vertically" is selected, the form starts at the top and any remaining space is empty. Scrollable [Form] If set, the form will be wrapped in a scroll pane. If not set, certain form components which can grow in the vertical direction (like the text area form component) can claim remaining vertical space. Please note that those components have to be configured accordingly. Screen title [Messages] The title of the screen, shown in a bold and larger font. Should be a concise subject. This question is also used by the console installer for presenting the screen. Info text [Messages] A paragraph that explains to the user what this screen is about. This message is shown in the body of the screen.
Configurable form
A screen where form elements can be configured along the vertical axis. Most types of information that you would like to query from a user during the installation can be easily expressed with this screen.
Applies to: Installer, Uninstaller
Properties:
Fill horizontally [Form] If set, the form will fill the entire horizontal extent of the screen. Otherwise, it will be centered horizontally and all form components will not be wider than their preferred widths. Fill vertically [Form] If set, the form will fill the entire vertical extent of the screen. Otherwise, it will be centered vertically. Note that form components always have their preferred heights when the "Scrollable" property is selected. If "Fill vertically" is selected, the form starts at the top and any remaining space is empty. Scrollable [Form] If set, the form will be wrapped in a scroll pane. If not set, certain form components which can grow in the vertical direction (like the text area form component) can claim remaining vertical space. Please note that those components have to be configured accordingly. Screen title [Messages] The title of the screen, shown in a bold and larger font. Should be a concise subject. Screen subtitle [Messages] The subtitle of the screen, shown below the title in a normal font. Should be a short question. This question is also used by the console installer for presenting the screen.

| 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:
Background color for banner If you specify a custom banner, you might want to adjust the background color of the banner panel, the default value is suitable for the standard banner. Set to "None" in order to reset to the default value. Image for banner Specify a PNG or GIF image file for your custom banner. Clear to reset to the default banner. Image anchor The anchor where the image will be fixed in the banner panel. Alert for update installation If selected, the installer will check if a previous installation can be found by calling `context.isUpdateInstallation()`. In this case, the user will be presented with the choice to update the existing installation or select a new installation directory. If the update is selected, the installer variable `sys.confirmedUpdateInstallation` will be set to `Boolean.TRUE`. The default condition expressions on the "Installation location" screen and the "Create program group" screen are set so that the screen is skipped in that case. Note that this only works if "Detect previous installation directory" is selected on the "Installer->Update Options" tab.
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:
Text source The source from which the license is loaded. For multi-language installers, the "File" source is recommended since it is more easily localizable than the direct entry. License file The file from which the license is loaded. Note: This property is only visible if "Text source" is set to "File". License The license that is displayed in the screen, either plain text or HTML. For HTML, the value should start with , otherwise the plain text will be displayed. The text is displayed in a scrollable text area. Note: This property is only visible if "Text source" is set to "Direct". Initially accepted If selected, the "Accept" radio button is initially selected. User must scroll to bottom If selected, the user can only accept the license if the text area with the license text has been previously scrolled to the bottom. Has no effect if the "Initially selected" property is selected. Variable name Optionally, you can save the actually displayed text to a variable. Enter the variable name without the installer prefix and the percent signs. This is useful if you have a localized license text and want to save the actually displayed text with a "Write text to a file" action later on.
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. Validate application id [Application ID] Check if another application is installed in the selected directory or if the application is not the correct target for an add-on installer. 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, Mac OS X 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 no 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. If the script returns true, the selection is accepted, if it returns false, the selection is discarded.
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, Mac OS X 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. Validate application id [Application ID] Check if another application is installed in the selected directory or if the application is not the correct target for an add-on installer. 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 no 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. 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. 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. This screen sets installer variables that influence "Create program group" and "Create start menu entry" entry actions.
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:
Text source The source from which the text is loaded. For multi-language installers, the "File" source is recommended since it is more easily localizable than the direct entry. Text file The file from which the text is loaded. Note: This property is only visible if "Text source" is set to "File". Text The text that is displayed in the screen, either plain text or HTML. For HTML, the value should start with , otherwise the plain text will be displayed. The text is displayed in a scrollable text area. Note: This property is only visible if "Text source" is set to "Direct". Variable name Optionally, you can save the actually displayed text to a variable. Enter the variable name without the installer prefix and the percent signs. This is useful if you have a localized license text and want to save the actually displayed text with a "Write text to a file" action later on.
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:
Background color for banner If you specify a custom banner, you might want to adjust the background color of the banner panel, the default value is suitable for the standard banner. Set to "None" in order to reset to the default value. Image for banner Specify a PNG or GIF image file for your custom banner. Clear to reset to the default banner. Image anchor The anchor where the image will be fixed in the banner panel.
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:
Background color for banner If you specify a custom banner, you might want to adjust the background color of the banner panel, the default value is suitable for the standard banner. Set to "None" in order to reset to the default value. Image for banner Specify a PNG or GIF image file for your custom banner. Clear to reset to the default banner. Image anchor The anchor where the image will be fixed in the banner panel.
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
Uninstallation success
The screen that is displayed if the uninstallation was completed successfully.
Applies to: Uninstaller
Properties:
Background color for banner If you specify a custom banner, you might want to adjust the background color of the banner panel, the default value is suitable for the standard banner. Set to "None" in order to reset to the default value. Image for banner Specify a PNG or GIF image file for your custom banner. Clear to reset to the default banner. Image anchor The anchor where the image will be fixed in the banner panel.