Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added a real example of a customicons.xml file since.

...

This defines alternative icons for IzPack GUI components, such as installer buttons and decorations.

AttributeDescriptionRequired
resPath within the installer JAR where the icon file is stored. May be absolute (e.g. /resources/icon.png) or relative to the IzPack class file com.izforge.izpack.installer.gui.InstallerFrameYes
idThe ID of the standard IzPack icon to replace. See the list of standard icons, below.Yes

sysicon

This defines alternative icons for Java Swing components, such as the buttons and decorations on built-in dialog boxes.

AttributeDescriptionRequired
resPath within the installer JAR where the icon file is stored. May be absolute (e.g. /resources/icon.png) or relative to the IzPack class file com.izforge.izpack.installer.gui.InstallerFrame.Yes
idThe name of the icon-type Swing component property to replace. See the component properties documentation in the Java API for a full list of customisable properties (any property with type Icon can be specified). The icons replaced as standard by IzPack's default behaviour are listed below in the list of alternative Swing icons.Yes

 

Here is an example of a customicons.xml file :

Code Block
<izpack:icons version="5.0"
              xmlns:izpack="http://izpack.org/schema/icons"
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              xsi:schemaLocation="http://izpack.org/schema/icons http://izpack.org/schema/5.0/izpack-icons-5.0.xsd">
    <icon res="/resources/JFrameIcon" id="JFrameIcon"/>
    <icon res="/resources/next" id="stepforward"/>
    <icon res="/resources/previous" id="stepback"/>
</izpack:icons>

Resources 

One way to provide the icon files themselves, is to include them as resources in the <resources> section of the install spec. In this case, the res attribute for the icon spec in customicons.xml must be specified as "/resources/resource-id"

...

This section lists and displays all standard IzPack icons that are used by default, along with the icon ID (which is needed for defining custom icons), and a brief description of where it's used. Replace these using an <icon> tag in customicons.xml.

ImageIDUsageSize
Image Modified
JFrameIconWindow icon for installer and language selection dialog.16x16
Image Modified
bookmarkApplication URL on Hello Panel.16x16
Image Modified
checkSuccessful installation on Finish Panels.32x32
Image Modified
doneExit button for successful installation.16x16
Image Modified
editAutomated script button on Finish Panel; description of Info Panels.16x16
Image Modified
emptyBlank spacer on Finish Panels and Hello Panel.16x16
Image Modified
helpPanel Help button.16x16
Image Modified
historyDescription of Licence Panels and Installation Type Panel.16x16
Image Modified
home 16x16
Image Modified
hostWelcome message on Hello Panel.16x16
Image Modified
import 16x16
Image Modified
informationProduct information on Hello Panel.16x16
Image Modified
link16x16Shortcut Panel header.16x16
Image Modified
openBrowse button for Path Panels and multi-volume installers.16x16
Image Modified
preferencesDescription of Packs Panels; progress description on Install Panel; success description on Finish Panels.16x16
Image Modified
refresh_cycle 16x16
Image Modified
stepbackPrevious button.16x16
Image Modified
stepforwardNext button.16x16
Image Modified
stopQuit button (installer and uninstaller); exit button for failed installation.16x16
Image Modified
tipInfo text on Packs Panels and Sudo Panel; progress description on Compile Panel.16x16

List of alternative Swing icons

This table lists all built-in Java Swing component icons replaced by default in a standard IzPack installer. Replace these (or any other Icon-type Swing component property) using a <sysicon> tag in customicons.xml.

ImageIDUsageSize
Image Modified
FileChooser.homeFolderIconHome directory button in File Chooser.16x16
Image Modified
FileChooser.newFolderIconNew directory button in File Chooser.16x16
Image Modified
FileChooser.upFolderIconUp directory (i.e. ..) button in File Chooser.16x16
Image Modified
FileView.computerIconIcon for directories representing the computer.16x16
Image Modified
FileView.directoryIconIcon for regular directories.16x16
Image Modified
FileView.fileIconIcon for files.16x16
Image Modified
FileView.floppyDriveIconIcon for floppy drives.16x16
Image Modified
FileView.hardDriveIconIcon for hard drives.16x16
Image Modified
OptionPane.errorIconError message dialog.32x32
Image Modified
OptionPane.informationIconInformation message dialog.32x32
Image Modified
OptionPane.questionIconQuestion message dialog.32x32
Image Modified
OptionPane.warningIconWarning message dialog.32x32