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 e.g. for referencing in userinput panel definitions.	No
`condition`	The id of a condition that has to be evaluated 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

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

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 in 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 Data Validators.

Actions

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

Examples

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>

A panel with help files in German and English.

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