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. Info text A paragraph that explains to the user what this screen is about. This message is shown in the body of the screen. Screen title 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.
Directory selection
A screen that asks the user to select a directory. All displayed messages are configurable.
Applies to: Installer, Uninstaller
Properties:
Allow spaces in directory name If selected, spaces are valid characters in the directory name for Unix/Linux installers, otherwise an error message is displayed if the user chooses a directory with spaces in it. Directory description The description of the kind of directory that use should select in a few words, e.g. "ABC directory". Info text A paragraph that explains to the user what this screen is about. This message is shown in the body of the screen. Initial directory The initially selected directory. Can be empty if no directory should be initially selected. Only accept writable directories If selected, non-writable directories will be rejected. 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 subtitle 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. Screen title The title of the screen, shown in a bold and larger font. Should be a concise subject. Variable name for selection The name of the variable to which the selected directory is saved when the user advances to the next 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. Initial status message The initial status message displayed by the progress screen. You can change this message with "Set messages" actions or by invoking Context.getProgressInterface().setStatusMessage("..."). Screen subtitle 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. Screen title The title of the screen, shown in a bold and larger font. Should be a concise subject.
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:
Displayed text The text that is displayed in the screen, either plain text or HTML. For HTML, the value should start with <html>, otherwise the plain text will be displayed. The text is displayed in a scrollable text area. Load displayed text from file Same as the "Displayed text" property, only that the text is loaded from a file. This property is only used if the "Displayed text" property is empty. You can also specify a zip file containing files named after the ISO language code (i.e. en.txt, de.txt or en.html). The text will then be chosen automatically depending on the installer language. Info text A paragraph that explains to the user what this screen is about. This message is shown in the body of the screen. Screen subtitle 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. Screen title The title of the screen, shown in a bold and larger font. Should be a concise subject.
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:
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. Info text A paragraph that explains to the user what this screen is about. This message is shown in the body of the screen. Initial program group The initially selected program group. Can be empty if no program group should be initially selected. Screen subtitle 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. Screen title The title of the screen, shown in a bold and larger font. Should be a concise subject. 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.

| 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. Fill horizontally 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 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. Info text A paragraph that explains to the user what this screen is about. This message is shown in the body of the screen. Scrollable 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 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.
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 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 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 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 subtitle 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. Screen title The title of the screen, shown in a bold and larger font. Should be a concise subject.

| 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.
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:
Initially accepted If selected, the "Accept" radio button is initially selected. Displayed license The license that is displayed in the screen, either plain text or HTML. For HTML, the value should start with <html>, otherwise the plain text will be displayed. The text is displayed in a scrollable text area. Load displayed license from file Same as the "Displayed license" property, only that the text is loaded from a file. This property is only used if the "Displayed license" property is empty. You can also specify a zip file containing files named after the ISO language code (i.e. en.txt, de.txt or en.html). The text will then be chosen automatically depending on the installer language. 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.
Installation location
The screen that asks the user where to install the application. This determines the principal installation directory.
Applies to: Installer
Properties:
Allow spaces in directory name 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. Insufficient disk space warning Show a warning message if there is not sufficent disk space for the installation on the selected target drive. Existing directory warning Ask the user whether to install the application in the selected directory if it already exists and the installation is not an update. Show free 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. Show required disk space Show the disk space that is required for the installation. You should switch this off if your installation includes other data sources. Suggest application directory 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. Validate 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.
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:
Bold font Use a bold font for the descriptions 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 useable 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. Italic font Use an italic font for the descriptions Smaller font 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:
Allow spaces in directory name 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. Bold font Use a bold font for the descriptions Insufficient disk space warning Show a warning message if there is not sufficent disk space for the installation on the selected target drive. Existing directory warning Ask the user whether to install the application in the selected directory if it already exists and the installation is not an update. Italic font Use an italic font for the descriptions Show free 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. Show installation directory chooser Show the installation directory chooser below the component selector. Show required disk space Show the disk space that is required for the installation. You should switch this off if your installation includes other data sources. Smaller font Use a smaller font for the descriptions Suggest application directory 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. Validate 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.
Create program group
A screen that allows the user to select the default program group. The "Create standard program group" action is bound to this selection, other program group actions are bound to this selection if their program group property is empty. This screen will not be shown if the "Create standard program group" is not present.
Applies to: Installer
Properties:
User can change "all users" If the user can change the default value of the "All users" property in the "Create standard program group action". This change affects all program group actions that rely on a default program group. User can disable creation If the user can disable all program group actions that rely on a default program group, such as the "Create standard program group action".
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 unselecting all file associations.
Services
A screen that allows the user to select what services should be installed. This screen will not be shown if no service executables are installed after this screen.
Applies to: Installer
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:
Displayed text The text that is displayed in the screen, either plain text or HTML. For HTML, the value should start with <html>, otherwise the plain text will be displayed. The text is displayed in a scrollable text area. Load displayed text from file Same as the "Displayed text" property, only that the text is loaded from a file. This property is only used if the "Displayed text" property is empty. You can also specify a zip file containing files named after the ISO language code (i.e. en.txt, de.txt or en.html). The text will then be chosen automatically depending on the installer language.
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.
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.
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.