Installer - Available Form Components

## Installer - Available Form Components |

| Category: Action components
Button
A standard button with an optional leading label. When the user clicks on the button, an action script is executed.
Properties:
Action script The script that is executed when the button is clicked by the user. The return type is void. Button icon The icon displayed on the button. Can be empty if the button text is set. Button text The text that is displayed on the button. Can be empty if the button icon is set. Icon-text gap The gap between the label icon and the label text in pixels. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty.
Hyperlink URL label
A label that displays a hyperlink. When the user clicks on the hyperlink, the appropriate action is performed, depending on the protocol of the URL.
Properties:
Hyperlink text The text that is displayed on the hyperlink label. Icon-text gap The gap between the label icon and the label text in pixels. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. URL The URL for the hyperlink. For example http://www.ej-technologies.com
Hyperlink action label
A label that displays a hyperlink. When the user clicks on the hyperlink, an action script is executed
Properties:
Action script The script that is executed when the hyperlink is clicked by the user. The return type is void. Hyperlink text The text that is displayed on the hyperlink label. Icon-text gap The gap between the label icon and the label text in pixels. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty.

| Category: Labels and spacers
Horizontal separator
A horizontal separator with an optional label.
Properties:
Icon-text gap The gap between the label icon and the label text in pixels. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Use special title font If selected, a special font and color are used for the separator label. The actual font depends on the look and feel. This setting overrides all other font settings for the label.
Key value pair label
A pair of labels. The first ('key') label aligns with other leading labels on the form, the second ('value') label consumes the remaining horizontal space,
Properties:
Icon-text gap The gap between the key label icon and the key label text in pixels. Font color The color of the key label font. If empty, the default color will be used. Font The font of the key label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the key label. Can be empty. Text The text of the key label. Can be empty. Icon-text gap The gap between the value label icon and the value label text in pixels. Font color The color of the value label font. If empty, the default color will be used. Font The font of the value label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the value label. Can be empty. Text The text of the value label. Can be empty.
Label
A single label.
Properties:
Icon-text gap The gap between the label icon and the label text in pixels. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty.
Multi-line HTML label
A multi-line label that wraps text as needed and displays simple HTML. In particular you can include HTML links that open a browser.
Properties:
HTML The HTML for the label. The value should start with <html>, otherwise the plain text will be displayed. You can include HTML links that open a browser when clicked by the user. URLs in <a href="..."> links should start with http:// or file://.
Multi-line label
A multi-line label that wraps text as needed.
Properties:
Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Text The text of the label.
Vertical spacer
An invisible vertical spacer of configurable height.
Properties:
Spacer height The height of the spacer in pixels. The spacer itself is invisible.

| Category: Option selectors
Check box
A check box with an optional leading label. The user selection (Boolean.TRUE or Boolean.FALSE) is saved to a variable.
Properties:
Text The text of the check box. Can be empty. Coupled components You can select other components on the same form screen which are enabled only if the check box is selected. Icon-text gap The gap between the label icon and the label text in pixels. Initially selected If set, the check box is initially selected Inverse coupling If set, the coupling of other form components will be inverted with respect to the selection state of the check box. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Variable name The name of the variable to which the user input is assigned. The variable value will be one of java.lang.Boolean.TRUE or java.lang.Boolean.FALSE, depending on the user selection.
Combo box
A combo box with an optional leading label. The user can enter arbitrary text into the combo box. The user selection (the selected item as a string) is saved to a variable.
Properties:
Fill horizontal space If set, the combo box will fill all the available horizontal space, otherwise it will be as wide as required for the the widest item. Icon-text gap The gap between the label icon and the label text in pixels. Initially selected index The zero-based index of the initially selected item in the combo box. Input validation expression An expression or script that validates the user input when the combo box loses the focus. If the expression returns false, the focus remains in the combo box. In that case you should display an error message. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Combo box entries The items in the combo box as a list separated by semicolons. The items in the list must be separated by semicolons. If you click on the edit button in the property editor, you can enter one item per line in a separate dialog. Items that are installer variables with array values (e.g. String[] or Object[]) are expanded as separate items, this allows you to build a variable length list of items at runtime. Selection change script A script that is executed when the selection is changed by the user. This script is only required for advanced customizations of the form screen. The return type is void. Variable name The name of the variable to which the user input is assigned. The variable value will be the selected item string.
Drop-down list
A drop-down list with an optional leading label. The user selection (the selected index as a java.lang.Integer) is saved to a variable.
Properties:
Fill horizontal space If set, the drop-down list will fill all the available horizontal space, otherwise it will be as wide as required for the the widest item. Icon-text gap The gap between the label icon and the label text in pixels. Initially selected index The zero-based index of the initially selected item in the drop-down list. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Drop-down list entries The items in the drop-down list as a list separated by semicolons. The items in the list must be separated by semicolons. If you click on the edit button in the property editor, you can enter one item per line in a separate dialog. Items that are installer variables with array values (e.g. String[] or Object[]) are expanded as separate items, this allows you to build a variable length list of items at runtime. Selection change script A script that is executed when the selection is changed by the user. This script is only required for advanced customizations of the form screen. The return type is void. Variable name The name of the variable to which the user input is assigned. The variable value will be the index of the selected item as a java.lang.Integer.
List
A list with an optional leading label. The user selection (the selected indices) is saved to a variable.
Properties:
Fill horizontal space If set, the list will fill all the available horizontal space, otherwise it will be as wide as required for the the widest item. Fill extra vertical space If set, the component will expand to fill remaining vertical space. Extra vertical space is only available, if the form is not scrollable. Custom form screens have a "Scrollable" property, which must be set to false. Icon-text gap The gap between the label icon and the label text in pixels. Initially selected index The zero-based index of the initially selected item in the list. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. List entries The items in the list as a list separated by semicolons. The items in the list must be separated by semicolons. If you click on the edit button in the property editor, you can enter one item per line in a separate dialog. Items that are installer variables with array values (e.g. String[] or Object[]) are expanded as separate items, this allows you to build a variable length list of items at runtime. Multi-selection If set, the user can select multiple entries at the same time. Scrollable If set, the list will be wrapped in a scroll pane. Selection change script A script that is executed when the selection is changed by the user. This script is only required for advanced customizations of the form screen. The return type is void. Variable name The name of the variable to which the user input is assigned. If multiple items can be selected, the variable value will be an int array with the selected indices, otherwise the variable value will be the index of the selected item as a java.lang.Integer Visible rows If the list is scrollable, this property determines the height of the list.
Radio button group
A number of radio buttons in a common button group with an optional leading label. The user selection (the selected index as a java.lang.Integer) is saved to a variable.
Properties:
Axis The direction along which the radio buttons will be laid out. Icon-text gap The gap between the label icon and the label text in pixels. Initially selected index The zero-based index of the initially selected radio button. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Radio button labels The labels of all the radio buttons as a list separated by semicolons. Variable name The name of the variable to which the user input is assigned. The variable value will be the index of the selected radio button as a java.lang.Integer.
Single radio button
A single radio button with an optional leading label. If selected, a specified string is saved to a variable. If you place multiple instances of this form component on a form screen and give them the same variable name, they will form a radio button group.
Properties:
Coupled components You can select other components on the same form screen which are enabled only if the radio button is selected. Icon-text gap The gap between the label icon and the label text in pixels. Initially selected If selected, the radio button will be initially selected. Inverse coupling If set, the coupling of other form components will be inverted with respect to the selection state of the radio button. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Radio button label The text of the radio button. Variable name The name of the variable to which the user input is assigned. The variable value will be the string defined below. Variable value The value that should be witten to the variable if this radio button is selected.

| Category: Sliders and spinners
Slider
A slider with an optional leading label. The user input (a java.lang.Integer) is saved to a variable.
Properties:
Icon-text gap The gap between the label icon and the label text in pixels. Initial value The initial value of the slider. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Major tick spacing The spacing between major ticks expressed as a value. Maximum value The maximum value on the right side of the slider. Minimum value The minimum value on the left side of the slider. Minor tick spacing The spacing between minor ticks expressed as a value. Snap to ticks If set, the user selection is snapped to the closest tick value. Variable name The name of the variable to which the user input is assigned. The type of the variable value is java.lang.Integer.
Spinner of dates
A spinner with date and time values with an optional leading label. The user input is saved to a variable.
Minimum Java requirement: 1.4
Properties:
Date format pattern A pattern to format dates for display and input as described in the javadoc of java.text.SimpleDateFormat. An example is "yyyy.MM.dd 'at' HH:mm:ss z". If empty, a locale-dependent default pattern with date and time components will be used. Icon-text gap The gap between the label icon and the label text in pixels. Initial value The initial value of the spinner. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Variable name The name of the variable to which the user input is assigned. The type of the variable value is java.util.Date.
Spinner of enumerated values
A spinner with enumerated values with an optional leading label. The user input is saved to a variable.
Minimum Java requirement: 1.4
Properties:
Icon-text gap The gap between the label icon and the label text in pixels. Initially selected index The zero-based index of the initially selected item in the spinner. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. List entries The items in the spinner. The items in the list must be separated by semicolons. If you click on the edit button in the property editor, you can enter one item per line in a separate dialog. List items that are installer variables with array values (e.g. String[] or Object[]) are expanded as separate list items, this allows you to build a variable length list of list items at runtime. Variable name The name of the variable to which the user input is assigned. The type of the variable value is java.lang.String.
Spinner of integer values
A spinner with integer values with an optional leading label. The user input is saved to a variable.
Minimum Java requirement: 1.4
Properties:
Icon-text gap The gap between the label icon and the label text in pixels. Initial value The initial value of the spinner. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Maximum value The maximum value on the right side of the spinner. Minimum value The minimum value on the left side of the spinner. Step size The step size for the spinner. Variable name The name of the variable to which the user input is assigned. The type of the variable value is java.lang.Integer.

| Category: Special selectors and displays
Directory chooser
A directory chooser with an optional leading label. The user selection is saved to a variable.
Properties:
Allow spaces in directory name If selected, spaces are valid characters in the selected directory name for Unix/Linux installers, otherwise an error message is displayed if the user chooses a directory with spaces in it. Icon-text gap The gap between the label icon and the label text in pixels. Initial directory The initially selected directory. Can be empty. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Manual entry allowed If selected, the user can enter the directory manually in the text field. Otherwise, the text field is disabled. Variable name The name of the variable to which the user input is assigned. The type of the variable value is java.lang.String.
File chooser
A file chooser with an optional leading label. The user selection is saved to a variable.
Properties:
File filter name The name of the file filter. If empty, all files are selectable. Filtered file extension The list of the filtered file extension. If empty, all files are selectable. Icon-text gap The gap between the label icon and the label text in pixels. Initial file The initially selected file. Can be empty. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Manual entry allowed If selected, the user can enter the file manually in the text field. Otherwise, the text field is disabled. Variable name The name of the variable to which the user input is assigned. The type of the variable value is java.lang.String.
Progress display
An progress display that can show the progress of the actions attached to the containing screen.
Properties:
Detail line visible If selected, the detail line is visible. Hide initially If selected, the progress bar is hidden when the form is shown. When the actions attached to the screen are executed, the progrss bar is made visible. Status line visible If selected, the status line is visible.
Update schedule selector
Drop-down box that lets the user select an update schedule for your application. You can use the com.install4j.api.update.UpdateScheduleRegistry class in your application to check if you should launch an updater. Please see the Javadoc for more information. Please note that simply adding this form component does not automatically launch an updater at regular intervals.
Properties:
Icon-text gap The gap between the label icon and the label text in pixels. Initial update schedule The initially selected update schedule. If the user has already installed the application before, the currently active selection by the user will be selected and this value will be ignored. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty.

| Category: Text fields
Password field
A password text field with an optional leading label. The user input is displayed with '*' characters. The user input is saved to a variable.
Properties:
Text field columns The width of the text field, expressed as a multiple of the width of the character 'm'. If zero, the text field will fill the entire horizontal space. Icon-text gap The gap between the label icon and the label text in pixels. Initial text The initial text in the text field. Can be empty. Input validation expression An expression or script that validates the user input when the password field loses the focus. If the expression returns false, the focus remains in the password field. In that case you should display an error message. Key validation expression An expression or script that validates each key that is pressed in this component by the user. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Font The font of the text field. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Variable name The name of the variable to which the user input is assigned. Write encoded value to response file Write an encoded value of the entered password to the response file. Note that the encoding only prevents casual observation of the password. Do not enable if you require strict security for the password.
Text area
A text area with an optional leading label. The user input is saved to a variable.
Properties:
Text area columns The width of the text area, expressed as a multiple of the width of the character 'm'. If zero, the text area will fill the entire horizontal space. Fill extra vertical space If set, the component will expand to fill remaining vertical space. Extra vertical space is only available, if the form is not scrollable. Custom form screens have a "Scrollable" property, which must be set to false. Icon-text gap The gap between the label icon and the label text in pixels. Initial text The initial text in the text field. Can be empty. Input validation expression An expression or script that validates the user input when the text area loses the focus. If the expression returns false, the focus remains in the text area. In that case you should display an error message. Key validation expression An expression or script that validates each key that is pressed in this component by the user. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Wrap lines If set, lines will wrap at the end of the text area. Otherwise a horizontal scroll bar will be show when needed. Text area rows The height of the text area, expressed as a multiple of line heights. Must be greater than zero. Font The font of the text field. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Use label font If set, the default label font is used and other font settings are ignored. Variable name The name of the variable to which the user input is assigned. Wrap entire words This property is only relevant when lines are wrapped. If set, lines will wrap on word boundaries if possible.
Text field
A text field with an optional leading label. The user input is saved to a variable.
Properties:
Text field columns The width of the text field, expressed as a multiple of the width of the character 'm'. If zero, the text field will fill the entire horizontal space. Icon-text gap The gap between the label icon and the label text in pixels. Initial text The initial text in the text field. Can be empty. Input validation expression An expression or script that validates the user input when the text field loses the focus. If the expression returns false, the focus remains in the text field. In that case you should display an error message. Key validation expression An expression or script that validates each key that is pressed in this component by the user. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Font The font of the text field. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Variable name The name of the variable to which the user input is assigned.
Text field with date format
A text field with an optional leading label and a date format. The user input (a java.util.Date) is saved to a variable.
Minimum Java requirement: 1.4
Properties:
Text field columns The width of the text field, expressed as a multiple of the width of the character 'm'. If zero, the text field will fill the entire horizontal space. Date display style The date display style specifies the verbosity of the date component. Date format The date format specifies the components of the date that should be editable, i.e. date, time or date and time. Icon-text gap The gap between the label icon and the label text in pixels. Initial value The initial date in the text field. Input validation expression An expression or script that validates the user input when the text field loses the focus. If the expression returns false, the focus remains in the text field. In that case you should display an error message. Key validation expression An expression or script that validates each key that is pressed in this component by the user. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Font The font of the text field. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Time display style The time display style specifies the verbosity of the time component. Variable name The name of the variable to which the user input is assigned. The type of the variable value is java.util.Date.
Text field with format mask
A text field with an optional leading label and an arbitrary format mask. The user input is saved to a variable. The default mask is that of an SSN. For more information, please see the javadoc of javax.swing.text.MaskFormatter.
Minimum Java requirement: 1.4
Properties:
Allow invalid input If set, invalid input will be allowed during editing. When the text field loses focus, invalid input will not be accepted, so the final value is guaranteed to be valid in any case. Text field columns The width of the text field, expressed as a multiple of the width of the character 'm'. If zero, the text field will fill the entire horizontal space. Icon-text gap The gap between the label icon and the label text in pixels. Initial text The initial text in the text field. Can be empty. Input mask The input mask as defined be the javadoc of javax.swing.text.MaskFormatter. Input validation expression An expression or script that validates the user input when the text field loses the focus. If the expression returns false, the focus remains in the text field. In that case you should display an error message. Invalid characters If not empty, this string defines the characters that are invalid for user input. Key validation expression An expression or script that validates each key that is pressed in this component by the user. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Placeholder character The character that is displayed for empty characters of the input mask that still have to be filled out by the user. Font The font of the text field. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Valid characters If not empty, this string defines the characters that are valid for user input. Return literal characters If set, the value that is saved to the variable contains literal characters defined in the input mask. Variable name The name of the variable to which the user input is assigned. The type of the variable value is java.lang.String.
Text field with integer format
A text field with an optional leading label and an integer format. The user input is saved to a variable with type java.lang.Long.
Minimum Java requirement: 1.4
Properties:
Allow invalid input If set, invalid input will be allowed during editing. When the text field loses focus, invalid input will not be accepted, so the final value is guaranteed to be valid in any case. Text field columns The width of the text field, expressed as a multiple of the width of the character 'm'. If zero, the text field will fill the entire horizontal space. Icon-text gap The gap between the label icon and the label text in pixels. Initial text The initial text in the text field. Can be empty. Input validation expression An expression or script that validates the user input when the text field loses the focus. If the expression returns false, the focus remains in the text field. In that case you should display an error message. Key validation expression An expression or script that validates each key that is pressed in this component by the user. Font color The color of the label font. If empty, the default color will be used. Font The font of the label. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Icon An image file with an icon for the label. Can be empty. Text The text of the label. Can be empty. Maximum number of digits The maximum number of digits that are acceptable for user input. If zero, there is on limit. Minimum number of digits The minimum number of digits that are acceptable for user input. Font The font of the text field. If empty, the default font is used. Use the font name "dialog" for the default label font and a "0" size value for the default size. Use grouping separator If set, a locale-dependent grouping separator is displayed. Variable name The name of the variable to which the user input is assigned. The type of the variable value is java.lang.Long.