Panels
Here you tell the compiler which panels you want to use. They will appear in the installer in the order in which they are listed in your XML installation file.
The section Built-in Panel Types introduces the various panels available in IzPack. The usage of each is described, and the panels are listed by their class name (this is the name that must be used with the classname attribute).
Attributes
| Attribute | Description | Required |
classname | The class name of the panel. The attribute value is case-sensitive, meaning that if the case in the installation file differs from the case in the class file, the compiler will throw an IllegalArgumentException. | Yes |
id | A unique identifier for a panel which can be used to reference this panel in userinput panel definitions. | No |
condition | The id of a condition that has to evaluate to true in order for this panel to appear. If this attribute is not specified. the panel is always shown. | No |
jar | The jar file where the classes for this panel can be found. If this attribute is empty or unspecified, the classes for this panel must be merged using the <jar> tag. | No |
| topBuffer | Represents the percentage of left over vertical space to place on top of the components. Setting topBuffer=0 is useful if you don't want your panel to be moved up or down during dynamic validation (showing and hiding components within the same panel). The topBuffer attribute may also represent the number of pixels to place on top of the components rather than the percentage of left over space if the rigid attribute is set to true. | No |
| rigid | When set to true, the topBuffer will represent the number of pixels to place on top of the components rather than a percentage. This is useful to avoid components moving up and down during dynamic validation (showing and hiding components within the same panel), and where you would still like a gap to be placed on top of the components. Default: false | No |
Nested Elements
Configuration
Specify optional, custom configuration parameters for a custom panel using the <configuration> element. Each parameter is specified using a nested <param> element, which must have both a name and a value attribute.
Help
Specifies an optional help file for a panel. The contents of the help file is shown in a small window on the panel, when the user clicks on the Help button.
The help file can contain text that is formated using HTML elements(<p>,<h1>,<ul>,<li>, etc.).
The button is only shown when a help for the language exists.
| Attribute | Description | Required |
|---|---|---|
iso3 | The ISO3 representation of the language in which the help is written. | Yes |
src | The path where the compiler will find the help file to display. | Yes |
Validator
Specifies an optional panel data validator. See the section Panel Validators.
Actions
Specifies one or more optional panel life-cycle actions. See the section Panel Actions.
Examples
<panel classname="HelloPanel" id="hello" condition="verbosemode"> <help iso3="deu" src="HelloPanelHelp_deu.html" /> <help iso3="eng" src="HelloPanelHelp_eng.html" /> </panel>
A basic selection of panels, including a conditional panel and a custom panel contained in a jar, with a custom configuration.
<panels>
<panel classname="HelloPanel">
<help iso3="deu" src="HelloPanelHelp_deu.html" />
<help iso3="eng" src="HelloPanelHelp_eng.html" />
</panel>
<panel classname="LicencePanel"/>
<panel classname="TargetPanel"/>
<panel classname="InstallPanel"/>
<panel classname="UserInputPanel" id="myuserinput" condition="pack2selected" />
<panel classname="FinishPanel" jar="MyFinishPanel.jar">
<configuration>
<param name="MyParam1" value="some value"/>
<param name="MyParam2" value="some other value"/>
</configuration>
</panel>
</panels>
<installation version="5.0"
xmlns:izpack="http://izpack.org/schema/installation"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://izpack.org/schema/installation http://izpack.org/schema/5.0/izpack-installation-5.0.xsd">
<info>
<appname>Test</appname>
<appversion>0.0</appversion>
<appsubpath>myapp</appsubpath>
<javaver sion>1.6</javaversion>
</info>
<resources>
<res id="InfoPanel.info" src="doc/readme.txt" parse="yes"/>
<res id="LicencePanel.licence" src="legal/License.txt"/>
</resources>
<guiprefs width="800" height="600" resizable="no">
<splash>images/peas_load.gif</splash>
<laf name="substance">
<os family="windows" />
<os family="unix" />
<param name="variant" value="mist-silver" />
</laf>
<laf name="substance">
<os family="mac" />
<param name="variant" value="mist-aqua" />
</laf>
<modifier key="useHeadingPanel" value="yes" />
</guiprefs>
<panels>
<panel classname="HelloPanel">
<help iso3="deu" src="HelloPanelHelp_deu.html" />
<help iso3="eng" src="HelloPanelHelp_eng.html" />
</panel>
<panel classname="LicencePanel"/>
<panel classname="TargetPanel"/>
<panel classname="InstallPanel"/>
<panel classname="UserInputPanel" id="myuserinput" condition="pack2selected" />
<panel classname="FinishPanel" jar="MyFinishPanel.jar">
<configuration>
<param name="MyParam1" value="some value"/>
<param name="MyParam2" value="some other value"/>
</configuration>
</panel>
</panels>
...
</installation>
Internationalization
The following key suffixes can be translated:
headlineheadinfo<number>
The built-in translation of these labels can be overridden in the following way:
- Add custom translations to a IzPack resource CustomLangPack.xml_<ISO3>
- The following translation keys and lookup order can be used:
- If a panel ID is defined:
<Fully_qualified_panel_classname>.<panelId>.<subKey> - If a panel ID is defined:
<Simple_panel_classname>.<panelId>.<subKey> - If no panel ID is defined:
<Fully_qualified_panel_classname>.<subkey> - If no panel ID is defined:
<Simple_panel_classname>.<subkey> (for compatibility with IzPack 4 translations)
Example 1:
<resources> <res id="CustomLangPack.xml_eng" src="i18n/CustomLangPack.xml_eng"/> </resources> <panels> <panel classname="TargetPanel"/> </panels>
<langpack> <str id="com.izforge.izpack.panels.target.TargetPanel.headline" txt="Please select the installation directory"/> </langpack>
Example 2:
<resources> <res id="CustomLangPack.xml_eng" src="i18n/CustomLangPack.xml_eng"/> </resources> <panels> <panel classname="TargetPanel" id="target.panel"/> </panels>
<langpack> <str id="TargetPanel.target.panel.headline" txt="Please select the installation directory"/> </langpack>