Versions Compared

Old Version 6

changes.mady.by.user mwa (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user mwa (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A custom User Input Panel is an xml file and commonly named userInputSpec.xml.

More information

Step 1 - Introduce the custom panel

...

This xml code should be put in the userINputSpecuserInputSpec.xml file. This is the skeleton description of a custom user input panel.

XML TagDescription
<userInput>
Root xml tag
<panel>
Definition of a panel; You can have multiple panels defined in the <userInput>Multiple panels possible
<field>

Definiton of a gui element; One gui elemen element per <field > tag

 

Step 3 - Supported

...

gui elements

The following description should be considered as an introduction of available gui elements of IzPack. Detailed information can be found in the official (but an old) IzPack documentation.

User Input Elements

codecodecodecode Directory Description
ElementCodeScreenshot
Text Input 
Code Block
themeEclipse
languagehtml/xml
<field type="text" variable="textInput">
  <description align="left" txt="A description for a text input field"
      id="description.text"/>
  <spec txt="Enter some text:" id="text.label" size="15" set="some text"/>
</field>
Combo Box 
Code Block
themeEclipse
languagehtml/xml
<field type="combo" variable="radioSelection">
  <description align="left" txt="This is a description for radio buttons"
            id="description.radio"/>
  <spec>
          <choice txt="the first choice" id="radio.label.1" value="1 selected" />
          <choice txt="the second choice" id="radio.label.2" value="2 selected" set="true" />
          <choice txt="the third choice" id="radio.label.3" value="3 selected" />
          <choice txt="the fourth choice" id="radio.label.4" value="4 selected" />
  </spec>
Radio Buttons 
Code Blockcode
themeEclipse
languagehtml/xml
<field type="radio" variable="radioSelection">
  <description align="left" txt="This is a description for radio buttons"
            id="description.radio"/>
  <spec>
          <choice txt="the first choice" id="radio.label.1" value="1 selected" />
          <choice txt="the second choice" id="radio.label.2" value="2 selected" set="true" />
          <choice txt="the third choice" id="radio.label.3" value="3 selected" />
          <choice txt="the fourth choice" id="radio.label.4" value="4 selected" />
  </spec>
</field>
Check Box 
Code Blockcode
themeEclipse
languagehtml/xml
 <field type="check" variable="checkSelection.1">
  <description align="left" txt="This is a description for a check box"
            id="description.check.1"/>
  <spec txt="check box 1" id="check.label.1" true="on" false="off"
      set="false"/>
</field>
Password 
Code Block
themeEclipse
languagehtml/xml
<field type="password" align="left" variable="the.password">
  <spec>
    <pwd txt="The Password:" size="25" set=""/>
    <pwd txt="Retype Password:" size="25" set=""/>
  </spec>
</field>
File 
Code Block
themeEclipse
languagehtml/xml
<field type="file" align="left" variable="the.file">
  <spec txt="" size="25" set=""/>
</field>
Code Block
themeEclipse
languagehtml/xml
<field type="staticText" align="left" txt="Existing SSL keystore to import:"/>
 <field type="file" align="left" variable="existing.ssl.keystore">
   <spec txt="" size="25" set="$myconfig" />
 </field>

 

 

Multiple filessee documentation. 
Directory 
Code Block
theme
Eclipse
code
language
html/xml
<field type="dir" align="left" variable="existing.jboss.home">
  <spec txt="" size="25" set="$INSTALL_PATH$FILE_SEPARATOR${jboss.version}" mustExist="false" />
</field>
Rule Input Field  see documentation 
Search Field   Element
Code Block
themeEclipse
languagehtml/xml
<field type="search" variable="java_sdk_home">
  <description align="left"
               txt="This is a description for a search input field."
               id="description.java_sdk_home"/>
  <spec txt="Path to Java Compiler:" checkfilename="/bin/javac"
        type="file" result="directory">
  </spec>
</field>
Image Added

 

Visual Elements

codecode
ElementCodeScreenshot
Static Text 
Code Blockcode
themeEclipse
languagehtml/xml
<field type="staticText" align="left"
       txt="This is just some simple static text with variable substitution in here: $myvariable."
       id="staticText.text"/>
Title 
Code Blockcode
themeEclipse
languagehtml/xml
<field type="title" txt="This is my title" id="mytitle"/>
Space 
Code Block
themeEclipse
languagehtml/xml
<field type="space" />
 
Divider 
Code Block
themeEclipse
languagehtml/xml
<field type="divider" />