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

<panels>
  <panel classname="HTMLHelloPanel"/>
  <panel classname="HTMLInfoPanel"/>
  <panel classname="HTMLLicencePanel"/>
  <panel classname="TargetPanel"/>
  <panel classname="PacksPanel"/>
  <panel classname="InstallPanel"/>
  <panel classname="ShortcutPanel"/>
  <panel classname="SimpleFinishPanel" allowClose="true"/>
</panels>

Nested Elements 

Configuration

...

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 text can contain text that is formated using HTML elements(<p>,<h1>,<ul>,<li>, etc.) to specify the format.

The button is only shown when a help for the language exists.

Validator

Specifies an optional panel data validator. See the section Panel Data Validators.

Actions

Specifies one or more optional panel life-cycle actions.  See the section Panel Actions.

...

<panel classname="HelloPanel" id="hello"  condition="verbosemode">
  <help iso3="deu" src="HelloPanelHelp_deu.html" />
  <help iso3="eng" src="HelloPanelHelp_eng.html" />
</panel>

A basic typical selection of panels, including a conditional panel with a condition and a panel invoking custom panel code contained in a jar file, with a custom configuration providing parameters to the "finishPanel" class. 

<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>

A installation file showing the <panels> section in context.

<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:

• headline
• headinfo<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:
1. If a panel ID is defined:
   <Fully_qualified_panel_classname>.<panelId>.<subKey>
2. If a panel ID is defined:
   <Simple_panel_classname>.<panelId>.<subKey>
3. If no panel ID is defined:
   <Fully_qualified_panel_classname>.<subkey>
4. 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>

...