We need you!

Icon

The IzPack documentation needs work, and you are invited to edit it!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Copied across the element descriptions from the old documentation, formatting attributes in tables and listing examples at the end. Unreleased functionality from IZPACK-796 is also included.

Panels

This section 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 in their own sub section by name.  The , and the panels are listed by their class name . This (this is the name that must be used with the classname attribute. Please be aware that the classname is Case-Sensitive). 

Parameters

AttributeDescriptionRequired
classnameThe 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 IllegalArgumentExceptionYes
idA unique identifier for a panel which can be used e.g. for referencing in userinput panel definitions.No
conditionThe id of a condition that has to be fulfilled to show this panel (otherwise, the panel is always shown).No
jarThe 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 the attributes name and value

Warning
titleUnreleased Functionality

The specification of a configuration <param> element using name and value attributes will only take effect in IzPack 5.0.0-beta11. Until then, you must use nested <key> and <value> elements, as in IzPack 4.3.x.

Help

Specifies an optional help file for a panel. The content of the help file is shown in a small window on the panel, when the user clicks on the Help button. The button is only shown when a help in the language exists.

AttributeDescriptionRequired
iso3The ISO3 representation of the language in which the help is written.Yes
srcThe 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. 

Code Block
languagehtml/xml
<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.

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