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.

...

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

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, evaluated to true in order for this panel to appear If this attribute is not specified. 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

...

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 valueattribute

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.

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

...