We need you!
The IzPack documentation needs work, and you are invited to edit it!
Skip to end of metadata
Go to start of metadata

Dynamic Installer Requirements - <dynamicinstallerrequirements>

Introduced in IzPack 5.0, the <dynamicinstallerrequirements>  element is used to enhance the "classic" installer requirement checking that IzPack does at the beginning of an installation process. This stops the installation unless a certain condition is met.

With the dynamicinstallerrequirements element, you can check a certain set of conditions on each panel change, using a panel data validator to check if the required conditions are met.

Common Example

If a condition applies, a messagebox is shown with the appropriate content from translation. Depending on the value of severity attribute the installation might be continued or is aborted:

  • "error"
    The messagebox is shown and the installation aborts.
  • "warning"
    The messagebox is shown and the installation can continue after the OK button is pressed.

A more detailed example:

On each panel with a DynamicInstallerRequirementValidator assigned will be evaluated according to the requirements given as nested elements in <dynamicinstallerrequirements>.

<installerrequirement> - Attributes

AttributeDescriptionDefaultRequired
severity

The severity the validator should apply in case of the condition gets true.

Possible values: "warning" | "error"

  •  "warning"
    Shows a warning message but does not abort.
  • "error"
    Shows a message and aborts the installation.
noneyes
condition
A valid condition ID defined within the <conditions/> element.noneyes
messageid
A valid message ID from the appropriate translation file. If it can't be found the mentioned ID itself is displayed instead of the translated text.noneyes
Labels
  • None