Usage

The UserPathPanel allows the user to select a path similar to the installation path. Like the installation path, this panel will allow the directory to be created if it does not already exist. It can also be pre-loaded with a path and set to only display if a certain pack is selected using the following variables:

Example

<variable name="UserPathPanelVariable" value="@{default.dest.dir.sql}"/>
<variable name="UserPathPanelDependsName" value="Install Database Server"/>

Once chosen, the IzPack variable UserPathPanelVariable is set to the user's choice.

Translations

The text for these keys is specified in language resource files as described in the section on Internationalizing resources.

Key	Default (English)	Description

Key	Default (English)	Description
`UserPathPanel.headline`	Target Path	The headline of the panel (the one with the white background). GUI only: This is a standard translation for all type of graphical panels, if the <guiprefs> modifier useHeadingForSummary is set "yes".This has no effect on console installations.
`UserPathPanel.summaryCaption`	Installation Path	The summary caption text of the panel. GUI only: This is a standard translation for all type of graphical panels, if the <guiprefs> modifier useHeadingForSummary is not set or different to "yes". This has no effect on console installations.
`UserPathPanel.info`	Select the path:	The label text above the directory edit field.
`UserPathPanel.browse`	Browse...	The label text of the directory chooser button.
`UserPathPanel.exists_warn`	The directory already exists! Are you sure you want to install here and possibly overwrite existing files?	Warning message if the directory specified already exists.
`UserPathPanel.empty_target`	You have not specified a target location! Is this correct?	Warning message given when the user has not selected a target but has pressed OK.
`UserPathPanel.notwritable`	This directory can not be written! Please choose another directory!	Warning that IzPack can not create files in the selected location.
`UserPathPanel.createdir`	The target directory will be created:
`UserPathPanel.nodir`	This file is not a directory! Please choose a directory!
`UserPathPanel.intro`		Intro text with an explanation, rarely used, is empty by default. Does not work, refer to IZPACK-1731.
`UserPathPanel.extendedIntro`		Mult-line intro text with an explanation, rarely used, not set by default. Does not work, refer to IZPACK-1731.
`UserPathPanel.required`	The chosen directory should exist.

Messages for the UserPathPanel can be customized by creating a custom lang pack and overriding the values (attribute values wrapped for readability):

To change the text "Select the data path: " to "Select the folder where My Application should store it data: ", UserPathPanel.info should be specified in a language resource file for each language supported.

install.xml

<resources>

<res id="UserPathPanelText.xml" src="UserPathPanelText.xml"/>

<res id="UserPathPanelText.xml_fra" src="UserPathPanelText.xml_fra"/>

</resources>

The UserPathPanelText.xml file which is the default language resource, should look something like this:

UserPathPanelText.xml

<langpack>

<str id="UserPathPanel.info" txt="Select the folder where $APP_NAME should store its data: "/>

</langpack>

A similar UserPathPanelText.xml.fra file needs to be created to specify the French translation.

Configuration

The following nested configuration options are possible against the panel definition:

Parameter Name	Description	Default Value

Parameter Name	Description	Default Value
`mustExist`	Whether the path given by the user must exist before leaving the panel	false

Example

<configuration>
  <param name="mustExist" value="true"/>
</configuration>