Installer - Available Screens

 Empty form
     
An empty form to which form components can be added. By default, form components are layouted along the vertical axis, but you can use layout groups for greater flexibility. Form components with user input are bound to installer variables that can by referenced by other elements in the installer, for example by actions.
Applies to: Installer, Uninstaller
Properties:
  • Screen can be reached [Control Flow]
    Determines if the the screen will be shown when the user reaches this screen by clicking the "Next" or the "Back" button. If "Only with Next button" is selected, the screen is not added to the screen history. If "Only with Back button" is selected, the screen is only added to the screen history, but is not shown for the forward traversal.
  • Fill horizontal space [Form]
    If set, the form will fill the entire horizontal extent of the screen. Otherwise, it will be added at the selected anchor and all form components will not be wider than their preferred widths.
  • Horizontal anchor
    If "Fill horizontal space" is not selected, the form can be placed at different locations in the available space.

    Note: This property is only visible if "Fill horizontal space" is selected.

  • Fill vertical space [Form]
    If set, the form will fill the entire vertical extent of the screen. Otherwise, it will be at the selected anchor. Note that form components always have their preferred heights when the "Scrollable" property is selected. If "Fill vertical space" is selected, the form starts at the top and any remaining space is empty.
  • Vertical anchor
    If "Fill vertical space" is not selected, the form can be placed at different locations in the available space.

    Note: This property is only visible if "Fill vertical space" is selected.

  • 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.
  • 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: Form templates
 
 Banner with header at the top
     
A form that has "Banner" as the default style and a configurable header label at the top.
Applies to: Installer, Uninstaller
Properties:
  • Screen can be reached [Control Flow]
    Determines if the the screen will be shown when the user reaches this screen by clicking the "Next" or the "Back" button. If "Only with Next button" is selected, the screen is not added to the screen history. If "Only with Back button" is selected, the screen is only added to the screen history, but is not shown for the forward traversal.
  • Fill horizontal space [Form]
    If set, the form will fill the entire horizontal extent of the screen. Otherwise, it will be added at the selected anchor and all form components will not be wider than their preferred widths.
  • Horizontal anchor
    If "Fill horizontal space" is not selected, the form can be placed at different locations in the available space.

    Note: This property is only visible if "Fill horizontal space" is selected.

  • Fill vertical space [Form]
    If set, the form will fill the entire vertical extent of the screen. Otherwise, it will be at the selected anchor. Note that form components always have their preferred heights when the "Scrollable" property is selected. If "Fill vertical space" is selected, the form starts at the top and any remaining space is empty.
  • Vertical anchor
    If "Fill vertical space" is not selected, the form can be placed at different locations in the available space.

    Note: This property is only visible if "Fill vertical space" is selected.

  • 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.
  • 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.
 Directory selection
     
A form that asks the user to select a directory. All displayed messages are configurable.
Applies to: Installer, Uninstaller
Properties:
  • Screen can be reached [Control Flow]
    Determines if the the screen will be shown when the user reaches this screen by clicking the "Next" or the "Back" button. If "Only with Next button" is selected, the screen is not added to the screen history. If "Only with Back button" is selected, the screen is only added to the screen history, but is not shown for the forward traversal.
  • Fill horizontal space [Form]
    If set, the form will fill the entire horizontal extent of the screen. Otherwise, it will be added at the selected anchor and all form components will not be wider than their preferred widths.
  • Horizontal anchor
    If "Fill horizontal space" is not selected, the form can be placed at different locations in the available space.

    Note: This property is only visible if "Fill horizontal space" is selected.

  • Fill vertical space [Form]
    If set, the form will fill the entire vertical extent of the screen. Otherwise, it will be at the selected anchor. Note that form components always have their preferred heights when the "Scrollable" property is selected. If "Fill vertical space" is selected, the form starts at the top and any remaining space is empty.
  • Vertical anchor
    If "Fill vertical space" is not selected, the form can be placed at different locations in the available space.

    Note: This property is only visible if "Fill vertical space" is selected.

  • 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.
  • 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 PDF file
     
A form that displays a PDF file in an embedded cross-platform PDF viewer.
Applies to: Installer, Uninstaller
Properties:
  • Screen can be reached [Control Flow]
    Determines if the the screen will be shown when the user reaches this screen by clicking the "Next" or the "Back" button. If "Only with Next button" is selected, the screen is not added to the screen history. If "Only with Back button" is selected, the screen is only added to the screen history, but is not shown for the forward traversal.
  • Fill horizontal space [Form]
    If set, the form will fill the entire horizontal extent of the screen. Otherwise, it will be added at the selected anchor and all form components will not be wider than their preferred widths.
  • Horizontal anchor
    If "Fill horizontal space" is not selected, the form can be placed at different locations in the available space.

    Note: This property is only visible if "Fill horizontal space" is selected.

  • Fill vertical space [Form]
    If set, the form will fill the entire vertical extent of the screen. Otherwise, it will be at the selected anchor. Note that form components always have their preferred heights when the "Scrollable" property is selected. If "Fill vertical space" is selected, the form starts at the top and any remaining space is empty.
  • Vertical anchor
    If "Fill vertical space" is not selected, the form can be placed at different locations in the available space.

    Note: This property is only visible if "Fill vertical space" is selected.

  • 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.
  • 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 form that displays a progress bar with a status line capturing the progress information of associated actions. The default post-activation script executes any associated actions immediately when the screen is activated. All displayed messages are configurable.
Applies to: Installer, Uninstaller
Properties:
  • Screen can be reached [Control Flow]
    Determines if the the screen will be shown when the user reaches this screen by clicking the "Next" or the "Back" button. If "Only with Next button" is selected, the screen is not added to the screen history. If "Only with Back button" is selected, the screen is only added to the screen history, but is not shown for the forward traversal.
  • Fill horizontal space [Form]
    If set, the form will fill the entire horizontal extent of the screen. Otherwise, it will be added at the selected anchor and all form components will not be wider than their preferred widths.
  • Horizontal anchor
    If "Fill horizontal space" is not selected, the form can be placed at different locations in the available space.

    Note: This property is only visible if "Fill horizontal space" is selected.

  • Fill vertical space [Form]
    If set, the form will fill the entire vertical extent of the screen. Otherwise, it will be at the selected anchor. Note that form components always have their preferred heights when the "Scrollable" property is selected. If "Fill vertical space" is selected, the form starts at the top and any remaining space is empty.
  • Vertical anchor
    If "Fill vertical space" is not selected, the form can be placed at different locations in the available space.

    Note: This property is only visible if "Fill vertical space" is selected.

  • 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.
  • 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 text
     
A form that displays text to the user, either plain text or HTML. All displayed messages are configurable.
Applies to: Installer, Uninstaller
Properties:
  • Screen can be reached [Control Flow]
    Determines if the the screen will be shown when the user reaches this screen by clicking the "Next" or the "Back" button. If "Only with Next button" is selected, the screen is not added to the screen history. If "Only with Back button" is selected, the screen is only added to the screen history, but is not shown for the forward traversal.
  • Fill horizontal space [Form]
    If set, the form will fill the entire horizontal extent of the screen. Otherwise, it will be added at the selected anchor and all form components will not be wider than their preferred widths.
  • Horizontal anchor
    If "Fill horizontal space" is not selected, the form can be placed at different locations in the available space.

    Note: This property is only visible if "Fill horizontal space" is selected.

  • Fill vertical space [Form]
    If set, the form will fill the entire vertical extent of the screen. Otherwise, it will be at the selected anchor. Note that form components always have their preferred heights when the "Scrollable" property is selected. If "Fill vertical space" is selected, the form starts at the top and any remaining space is empty.
  • Vertical anchor
    If "Fill vertical space" is not selected, the form can be placed at different locations in the available space.

    Note: This property is only visible if "Fill vertical space" is selected.

  • 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.
  • 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.
 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:
  • Screen can be reached [Control Flow]
    Determines if the the screen will be shown when the user reaches this screen by clicking the "Next" or the "Back" button. If "Only with Next button" is selected, the screen is not added to the screen history. If "Only with Back button" is selected, the screen is only added to the screen history, but is not shown for the forward traversal.
  • Fill horizontal space [Form]
    If set, the form will fill the entire horizontal extent of the screen. Otherwise, it will be added at the selected anchor and all form components will not be wider than their preferred widths.
  • Horizontal anchor
    If "Fill horizontal space" is not selected, the form can be placed at different locations in the available space.

    Note: This property is only visible if "Fill horizontal space" is selected.

  • Fill vertical space [Form]
    If set, the form will fill the entire vertical extent of the screen. Otherwise, it will be at the selected anchor. Note that form components always have their preferred heights when the "Scrollable" property is selected. If "Fill vertical space" is selected, the form starts at the top and any remaining space is empty.
  • Vertical anchor
    If "Fill vertical space" is not selected, the form can be placed at different locations in the available space.

    Note: This property is only visible if "Fill vertical space" is selected.

  • 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.
  • 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
 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
 Installation location
     
The screen that asks the user where to install the application. This determines the principal installation directory.
Applies to: 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:
  • 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 userAn optional description of the installation type. This description is displayed below the name and can be shown or hidden by the userIf the description is displayed by default or notIf 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
 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
 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" form template, all messages on this screen are pre-defined and localized.
Applies to: Installer, Uninstaller
 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
 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
 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