...
| 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 . The compiler will throw an IllegalArgumentException if the class can not be found.. | 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 | |||||||
allowClose | Determines whether confirmation is required when quitting the installer from this panel and panels defined before this panel. Set to " Set to " If there is no "allowClose" attribute IzPack will exhibit its classic behavior, which is to prompt for confirmation until the files are copied unless the Previous and Next buttons are both disabled. The above seems complex, but all that's required For example, to force confirmation when quitting from all but the last panel is to , specify
Default: unspecified Since: IzPack 5.0 RC5 | No |
...
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.
| 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 to the help file to displaybe displayed. | Yes |
Validator
Specifies an optional panel data validator. See the section Panel Validators.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<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.
| 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 installation file showing the <panels> section in context.
| 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> |