We need you!

Icon

The IzPack documentation needs work, and you are invited to edit it!

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 21 Next »

GUI Preferences - <guiprefs>

This <guiprefs> element allows you to set the layout and behavior of the GUI when the installer runs. This information will not have any effect on the command-line installers that will be available in future versions of IzPack.The attributes that can be specified are:

Attribute NameDescriptionDefault Value
resizableIndicates whether the window size can be changed or not.false
widthSets the initial window width in pixels.600
heightSets the initial window height in pixels.480

Example:

 

Nested Elements

<modify> - Modifying the GUI

There are some options to modify the graphic user interface. Most of them are managed with key/value pairs of the element '<modifier>' which will be located in the element '<guiprefs>' in the installation description file.

Example:

Modifying the Language Selection Dialog

The language selection dialog appears at the start of an installer before the first panel occurs.

Additionally to the picture in the language selection dialog, it is possible to modify flags and the way the language name is shown:

  • 'useFlags': possible are "yes" or "no". Default is "yes". If it is set to "no", no flag will be displayed in the language selection dialog. For "no" it is recommended to define also 'langDisplayType' other then "iso3".
  • 'langDisplayType': possible are "iso3", "native" and "default". Default is "iso3". With "iso3" the text for a language will be displayed as ISO 639-2:1998 code. With "native" the notation of the language will be used if possible, else the notation of the default locale. Using "default" will be presented the language in the notation of the default locale of the VM.

Modifying IzPack Panels

There are some graphic elements and behavior which are preferred by some people and deprecate by other. The following keys are related to the whole installation (all panels).

  • 'useButtonIcons': possible are "yes" or "no". Default is "yes". If it is set to "no", all buttons which are created via the ButtonFactory contains no icon also a icon id was submitted. Directly created buttons are not affected.
  • 'useLabelIcons': possible are "yes" or "no". Default is "yes". If it is set to "no", all labels which are created via the LabelFactory contains no icon also a icon id was submitted. Directly created labels are not affected.
  • 'labelFontSize': A float value used as a multiplier for the font size on labels created via the LabelFactory and IzPanel. Directly created labels are not affected.
  • 'layoutAnchor':layout anchor for IzPanels. Valid are "NORTH", "NORTHWEST", "SOUTHWEST", "SOUTH" and "CENTER". Only panels which are using the layout helper of IzPanels are supported. These are not all standard panels. At developing custom panels it is recommended to use the layout helper with an IzPanelLayout. Note: The anchor definition will be used for all panels!
  • Gaps: there are defined different gaps between different components of a IzPanel if using IzPanelLayout. The gaps can be set also via the element '<modifier>' of '<guiprefs>'. It is possible to declare different values for X and Y axis. This will be determined in the key word name. X Gaps are insert after Y gaps under the control for which the gap was declared. Following key words are defined:
    • 'labelXGap | labelYGap': gap in pixel between two labels in X or Y direction.
    • 'textXGap | textYGap': gap in pixel between two text fields.
    • 'controlXGap | controlYGap': gap in pixel between two controls other than label or textfield.
    • 'paragraphYGap': gap in pixel for a paragraph. A paragraph will be created in the panel source for controls which should be separated. paragraphXGap is declared, but not used.
    • 'labelToTextXGap | labelToTextYGap': gap in pixel between a label (left or top) and a text field (right or bottom).
    • 'labelToControlXGap | labelToControlYGap': gap in pixel between a label (left or top) and a control other than a label or a textfield.
    • 'textToLabelXGap | textToLabelYGap': gap in pixel between a text field (left or top) and a label.
    • 'controlToLabelXGap | controlToLabelYGap': gap in pixel between a control other than a label or a text field and a label.
    • 'controlToTextXGap | controlToTextYGap': gap in pixel between a control other than a label or a text field and a text field.
    • 'textToControlXGap | textToControlYGap': gap in pixel between a text field and a control other than a label or a text field .
    • 'firstYGap': gap in pixel between the top border and the first control.
    • 'fillerNXGap | fillerNYGap': gap in pixel created by the layout manager. Filler are used by some panels. N is a number between 1 and 5 to allow to use different filler e.g. filler3XGap or filler1YGap.
    • 'allXGap | allYGap': gap in pixel between all controls in X or Y direction. If this is declared all gaps for which no own declaration exists gets this value. If a gap has an own declaration this will be used instead.
  • 'layoutYStretchType | layoutXStretchType': the IzPanelLayout manager allows to declare stretch factors for controls. This means, that a control will be stretched if there is place in the line. The amount of stretching will be determined by the stretch factor. But what to do if the hole stretch factor for a line or column is not 1.0? To determine this these settings are exist. Valid values are "RELATIVE", "ABSOLUTE" and "NO". With "NO" no stretch will be performed. with "RELATIVE" the values are normalized, with "ABSOLUTE" the values will be used as they are (may be a part will be clipped if the sum is greater than 1.0).
  • 'layoutFullLineStretch | layoutFullColumnStretch': as described there are controls which should be stretched. Beside fixed values there are the symbolic values FULL_LINE_STRETCH and FULL_COLUMN_STRETCH which are computed at layout. E.g. MultiLineLabels has this stretch factor for x direction. But what to do if a centered layout is chosen? With a control like this the lines will be stretch to the hole size. With this settings it can be changed. E.g. a factor of 0.7 creates a nice centered layout. The default is 1.0, valid are 0.0 up to 1.0.

It is possible to use an alternatively frame title. Normally the title has the aspect "IzPack - Installation of " + '$APP_NAME'. If the langpack key 'installer.reversetitle' is defined, the value of that key will be used instead of the key 'installer.title'. There is no string added, but it is possible to use IzPack variables. The third heading example contains such a alternatively frame title. It is only possible to use predefined variables like '$APP_NAME' because the title will be created before the frame will be shown. It is common to use the name of the installation toolkit in the frame title.

Using a Separated Heading Panel

Some standard panels have headings (e.g. ShortcutPanel). These headings are integrated in the IzPanel. In opposite to this following heading will be displayed in a separated panel potential for all panels with the same design. There is no need to modify existent java classes else declaration of some key/value pairs are enough.

There can be one real head and zero or more info lines. The headline will be written bold, the font size can be changed. Info lines will be indented and written with the normal used font. The heading message has to be written into the langpack (or custom langpack) file with the key '<panel class name>.headline'. Examples can be seen in eng.xml. May be the entries for standard panels are not present in other languages. Messages for info lines have the key '<panel class name>.headinfo<info line number>'. First info line has number zero. If no or empty headline messages will be declared in the chosen language no heading panel will be shown. This behavior can be used to suppress heading for special panels.

It is also possible to declare head and info lines additional dependent on the 'panelid'. The result is, that it is possible to declare different messages for panels which are shown more than one time (e.g. the UserInputPanel. In this case the key for heading is

<panel class name>.headline.<panelid>

and for info lines

<panel class name>.headinfo<info line number>.<panelid>

Panel IDs are declared in the <panel> element. The standard strings are declared in the standard langpack file. For customized panels it is common to declare text in the custom language pack.

Example:

Then the messages can be declared in 'CustomLangpack.xml_eng' like this:

It is possible to place an icon on the right side of the heading (see below to display on left side). To do this a simple resource entry will be needed:

 

There are some guiprefs modifier keys to use and modify heading (see above). Additionally it is possible to count the general not hidden panels in the heading or navigation panel.

  • 'useHeadingPanel': General switch for heading. If this key does not exist or does not have the value "yes" no heading panel will be shown.
  • 'headingImageOnLeft': Option to allow displaying the heading image on the left of the header instead of the default (right side). Only valid if heading panel is used.
  • 'useHeadingForSummary': In the language files there are entries for the heading text ('Panel name.headline') and the summary caption ('Panel name.summaryCaption'). If this modifier is set to "yes", the text of the heading will be also used for the summary caption.
  • 'headingLineCount': Number of heading lines. If no info lines should be shown the value should be one (not zero).
  • 'headingFontSize': A float value used as multiplier for the standard font size.
  • 'headingBackgroundColor': Background color of the heading panel as integer. Often used is 0x00ffffff (white).
  • 'headingForegroundColor': Font color of the heading panel as integer. Often used is 0x00ffffff (white).
  • 'headingPanelCounter': Draw a panel counting. Possible values are "text" or "progressbar". inHeading the progressbar will be not the best choice.
  • 'headingPanelCounterPos': Declares where the counter will be shown. Possible are "inHeading" or "inNavigationPanel". If "inNavigationPanel" is chosen, the panel counter can be used also no heading was selected.

Example: Modifiers to create an IzPack installation with heading, no button and label icons and a panel text counter in the heading panel:

Example: Changed resources and langpack keys to create IzPack installation with alternatively frame title, heading, no button and label icons and a text counter in the heading panel.

install.xml

In the resource file <ISO3>.xml or 'CustomLangpack.xml_<ISO3>, add:

 

Example: Changed key/value pairs to create IzPack installation with heading, no button and label icons and a panel progressbar counter in the navigation panel.

 

Example: Don't show pack size in PacksPanel.

The PacksPanel dialog supports the modifier doNotShowPackSizeColumn which hides the third column showing the size of each pack. With doNotShowPackSizeColumn set to true, the third column will not be shown. The required size of all packs is still shown with this setting. The required size can be hidden by setting thedoNotShowRequiredSize to true.

 

The PacksPanel will not show the column with the sizes of each pack, but will show the total required space.

Example: Alternative Cancel Dialog

The cancel dialog will be shown if the cancel button or the close button of the frame was pushed. In the standard dialog the title contains the question and the message an affirmation. In other dialogs often the title is a common heading and the question will be called in the dialog as message. The standard behavior will be modified if the messages 'installer.quit.reversemessage' and 'installer.quit.reversetitleare' declared.

In the resource files <ISO3>.xml or CustomLangpack.xml_<ISO3>, add

<splash> - Adding a Splash Page

The <splash> element specifies the path to the image to be used a a splash screen. The path is relative to the installation root.

The image can be any bitmap format such as png, jpg, jpeg, gif or bmp.

Sample IzPack installation description

<laf> - Look and Feel

 The look and feel can be specified on a per-OS basis. For instance you can use the native look and feels on Win32 and OS X but use a third-party one on Unix-like platforms. To do that, you have to add some <laf> child elements to the <guiprefs> element.:

 laf: This tag specifies a look and feel. It has a name attribute that defines the look and feel name.

 Each laf element needs at least one os child element.

 Each laf element can also contain any number of param elements to customize a look and feel. A param elements has two attribues: name and value. The valid names and values will depend on the laf being described.

 The available look and feels are:

  •  Kunststoff: kunststoff
  • Liquid: liquid
  • Metouia: metouia
  • JGoodies Looks: looks
  • Substance: substance
  • Windows: windows
  • Aqua: aqua
  • Metal: metal

 

If you don't specify a look and feel for a particular operating system, then the default native one will be used: Windows on Windows, Aqua on Mac OS X and Metal on the Unix-like variants.

Sample IzPack installation description

Liquid Look and Feel

The Liquid Look and Feel supports the following variant attributes:

decorate.frames: yes means that it will render the frames in Liquid style

decorate.dialogs: yes means that it will render the dialogs in Liquid style

JGoodies Looks

The JGoodies Looks look and feel can be specified by using the variant attributes. The values can be one of:

windows: use the Windows look

plastic: use the basic Plastic look

plastic3D: use the Plastic 3D look

plasticXP: use the Plastic XP look (default).

Here is a small sample:

Substance 6.1

The Substance look and feel toned-down themes can be specified using the variant parameter, with the value being one of:

AttributePushingPixels Theme Name

default

org.pushingpixels.substance.api.skin.SubstanceBusinessLookAndFeel
businessorg.pushingpixels.substance.api.skin.SubstanceBusinessLookAndFeel
saharaorg.pushingpixels.substance.api.skin.SubstanceSaharaLookAndFeel

business-blue 

org.pushingpixels.substance.api.skin.SubstanceBusinessBlueSteelLookAndFeel

business-black 

org.pushingpixels.substance.api.skin.SubstanceBusinessBlackSteelLookAndFeel

creme 

org.pushingpixels.substance.api.skin.SubstanceCremeLookAndFeel
creme-coffeeorg.pushingpixels.substance.api.skin.SubstanceCremeCoffeeLookAndFeel
graphiteorg.pushingpixels.substance.api.skin.SubstanceGraphiteLookAndFeel
moderateorg.pushingpixels.substance.api.skin.SubstanceModerateLookAndFeel

nebula

org.pushingpixels.substance.api.skin.SubstanceNebulaLookAndFeel
nebula-brick-wallorg.pushingpixels.substance.api.skin.SubstanceNebulaBrickWallLookAndFeel
autumnorg.pushingpixels.substance.api.skin.SubstanceAutumnLookAndFeel
mist-silverorg.pushingpixels.substance.api.skin.SubstanceMistSilverLookAndFeel
mist-aquaorg.pushingpixels.substance.api.skin.SubstanceMistAquaLookAndFeel
dustorg.pushingpixels.substance.api.skin.SubstanceDustLookAndFeel
dust-coffeeorg.pushingpixels.substance.api.skin.SubstanceDustCoffeeLookAndFeel
geminiorg.pushingpixels.substance.api.skin.SubstanceGeminiLookAndFeel
marinerorg.pushingpixels.substance.api.skin.SubstanceMarinerLookAndFeel
officesilverorg.pushingpixels.substance.api.skin.SubstanceOfficeSilver2007LookAndFeel
officeblueorg.pushingpixels.substance.api.skin.SubstanceOfficeBlue2007LookAndFeel
officeblackorg.pushingpixels.substance.api.skin.SubstanceOfficeBlack2007LookAndFeel

Please consult https://substance.dev.java.net/docs/skins/toneddown.html for a gallery of the different toned-down themes.

Operating System Restrictions

The <laf> element can be restricted to operating system conditions by a nested <os> element, in which case the look and feel applies only in case the OS conditions apply

See OS Restrictions describes the use of <os> in more detail.

  • No labels