...
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 fulfilled to show this panel (otherwise, 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 |
...
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 both a name and a value attribute.
| Warning | ||
|---|---|---|
| ||
The specification of a configuration |
Help
Specifies an optional help file for a panel. The content 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 |
...
Specifies one or more optional panel life-cycle actions. See the section Panel Actions.
Examples
| Code Block | ||||
|---|---|---|---|---|
| ||||
<panel classname="HelloPanel">
<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.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<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 | ||||
|---|---|---|---|---|
| Code Block | ||||
| ||||
<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> |