Message-ID: <145671011.92007.1397854862395.JavaMail.firstname.lastname@example.org> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_92006_1314835003.1397854862395" ------=_Part_92006_1314835003.1397854862395 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
GUI Pr= eferences - <guiprefs>
fs> element allows you to set the l=
ayout and behavior of the GUI when the installer runs. This information wil=
l not have any effect on the command-line installers that will be available=
in future versions of IzPack.The attributes th=
at can be specified are:
|Attribute Name||Description||Default Value|
||Indicates whether the window size can be c= hanged or not.||no|
||Sets the initial window width in pixels.||600|
||Sets the initial window height in pixels.||480|
There are some options to modify the graphic user interface. Most of the=
m are managed with key/value pairs of the
t; element which is a child of the
fs> element in the installation description file.=
Modifying the Language Selection Dialog
The language selection dialog appears at the start of the installation b= efore the first panel occurs.
In additional to the picture in the language selection dialog, it is pos= sible to modify flags and the way the language name is shown:
useFlagsPossible 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&q= uot; it is recommended to define also 'langDisplayType' other then "is= o3".
langDisplayTypePossible values are "= ;iso3", "native" and "default". Default is "i= so3". With "iso3" the text for a language will be displayed = as ISO 639-2:1998 code. With "native" the notation of the languag= e will be used if possible, else the notation of the default locale. Using = "default" will be presented the language in the notation of the d= efault locale of the VM.
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&qu= ot; or "no". Default is "yes". If it is set to "no= ", all buttons which are created via the ButtonFactory contains no ico= n also a icon id was submitted. Directly created buttons are not affected.<= /li>
useLabelIconsPossible are "yes"= ; or "no". Default is "yes". If it is set to "no&q= uot;, all labels which are created via the LabelFactory contains no icon al= so a icon id was submitted. Directly created labels are not affected.
labelFontSizeA float value used as a mul= tiplier for the font size on labels created via the LabelFactory and IzPane= l. Directly created labels are not affected.
layoutAnchorThis is the layout anchor fo= r IzPanels. Valid are "NORTH", "NORTHWEST", "SOUTH= WEST", "SOUTH" and "CENTER". Only panels which are= using the layout helper of IzPanels are supported. These are not all stand= ard 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!
labelXGap | labelYGapTh= e gap in pixels between two labels in X or Y direction.
textXGap | textYGapThe gap in pixels bet= ween two text fields.
controlXGap | controlYGapThe gap in pixe= ls between two controls other than label or textfield.
paragraphYGapThe gap in pixels for a par= agraph. A paragraph will be created in the panel source for controls which = should be separated. paragraphXGap is = declared, but not used.???
labelToTextXGap | labelToTextYGapThe gap= in pixels between a label (left or top) and a text field (right or bottom)= .
labelToControlXGap | labelToControlYGapT= he gap in pixels between a label (left or top) and a control other than a l= abel or a textfield.
textToLabelXGap | textToLabelYGapThe gap= in pixels between a text field (left or top) and a label.
controlToLabelXGap | controlToLabelYGapT= he gap in pixels between a control other than a label or a text field and a= label.
controlToTextXGap | controlToTextYGapThe= gap in pixels between a control other than a label or a text field and a t= ext field.
textToControlXGap | textToControlYGapThe= gap in pixels between a text field and a control other than a label or a t= ext field .
firstYGapThe gap in pixels between the t= op border and the first control.
fillerNXGap | filler<= a class=3D"createlink" href=3D"http://docs.codehaus.org/pages/createpage.ac= tion?spaceKey=3DIZPACK&title=3DN&linkCreation=3Dtrue&fromPageId= =3D142803058" rel=3D"nofollow">NYGapThe gap in pixels = created by the layout manager to do wh= at???. Fillers are used by some panels. N is a number between 1 and 5 to specify a different fill= er e.g. filler3XGap or filler1YGap.
allXGap | allYGapThe gap in pixels betwe= en all controls in X or Y direction. If this is declared, this is the defau= lt for all gaps for which no own declaration has been defined.
RELATIVEThe values will be normalized
ABSOLUTEThe values will be used as= they are. A part of the line will be clipped if the sum is greater than 1.= 0.
NONo stretch will be performed.
layoutFullLineStretch | layoutFullColumnStretch<= /code> There are controls which should be stretched. Beside fixed values th= ere 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 center= ed layout is chosen? With a control like this the lines will be stre= tch to the hole size. With this settings it can be changed. E.g. a factor o= f 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 alternative frame title. Normally the title is &qu=
ot;IzPack - Installation of " + '$APP_NAME'. If the langpack key
installer.reversetitle is defined, the value of that key will be used instead of th=
installer.title. There is no string add=
ed, but it is possible to use IzPack variables. The third heading example contains such a alternatively fr=
ame 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 co=
mmon to use the name of the installation toolkit in the frame title.=
Some standard panels have headings (e.g. ShortcutPanel). These headings = are integrated in the IzPanel. In oppo= site to this following heading will be displayed in a separated panel poten= tial for all panels with the same design.(not parsable in English) T= here is no need to modify existing Java classes. The declaration of some ke= y/value pairs is enough.
There can be one real head and zero or more info lines. The headline wil= l be written bold, the font size can be changed. Info lines will be indente= d and written with the normal used font. The heading message has to be writ= ten into the langpack (or custom langpack) file with the key '<panel cla= ss 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 l= ines 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 beh= avior 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 m= essages for panels which are shown more than one time (e.g. the UserInputPa= nel. In this case the key for heading is
<panel class name>.headline.<panelid>=
and for info line= s
p;name>.headinfo<info line number>.<panelid&g=
Panel IDs are declared in the
<panel> element. The sta=
ndard strings are declared in the standard langpack file. For customized pa=
nels it is common to declare text in the custom language pack.
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 le= ft side). To do this a simple resource entry will be needed:
There are some
useHeadingPanelGeneral switch for headin= g. If this key does not exist or does not have the value "yes" no= heading panel will be shown.
headingImageOnLeftOption to allow displa= ying the heading image on the left of the header instead of the default (ri= ght side). Only valid if heading panel is used.
useHeadingForSummaryIn the language file= s there are entries for the heading text ('Panel name.headline') and the summary caption ('Panel name.summaryCaption'). If this modifie= r is set to "yes", the text of the heading will be also used for = the summary caption.
headingLineCountNumber of heading lines.= If no info lines should be shown the value should be one (not zero).
headingFontSizeA float value used as mul= tiplier for the standard font size.
headingBackgroundColorBackground color o= f the heading panel as integer. Often used is 0x00ffffff (white).
headingForegroundColorFont color of the = heading panel as integer. Often used is 0x00ffffff (white).
headingPanelCounterDraw a panel counting= . Possible values are "text" or "progressbar". inHeadin= g the progressbar will be not the best choice.
headingPanelCounterPosDeclares where the= counter will be shown. Possible are "inHeading" or "inNavig= ationPanel". If "inNavigationPanel" is chosen, the panel cou= nter can be used also no heading was selected.
Example: Modifiers to create an IzPack installation with heading, no b= utton and label icons and a panel text counter in the heading panel:=
Example:<= /strong> Changed resources and langpack keys to create IzPack installation = with an alternative frame title, a heading, no button and label icons and a= text counter in the heading panel.
In the resource f=
<ISO3>.xml or '
Example: Changed key/value pairs to create IzPack installation with he= ading, no button and label icons and a panel progressbar counter in the nav= igation panel.
The PacksPanel dialog supports the modifier doNotShowPackSi=
set to true, the third column will not be shown. This does not=
affect the display of the required size of all packs.
The required size can be hidden by setting the
quiredSize to true.
The PacksPanel wi= ll not show the column with the sizes of each pack, but will show the total= required space.
The cancel dialog will be shown if the cancel button or= the close button of the frame is pushed.
In the standard dialog, the title contains the question and the confirma= tion message.
Often, in other dialogs, the title is a common heading and the question =
will be called in the dialog as a message. The standard behavior will be mo=
dified if the messages
In the resource files
<splash> element sp=
ecifies 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 su= ch as png, jpg, jpeg, gif or bmp.
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. T=
o do that, you have to add some <laf> child elements=
: This tag specifies a look and feel. It has a
/code> attribute that defines the look and feel name.
code> element needs at least one
code> element can also contain any number of
code> elements to customize a look and feel. A
elements has two attribues:
value. The valid names and values wi=
ll depend on the laf being described.
The available look and f= eels are:
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 O= S X and Metal on the Unix-like variants.
The Liquid Look and Feel supports the following
yes means that it will render=
the frames in Liquid style
yes means that it will rende=
r the dialogs in Liquid style
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:
The Substance look and feel toned-down themes can be s=
pecified using the
variant parameter, with the value being one=
|Attribute||PushingPixels Theme Name|
The Substance web site has been taken off line but is still available in= the Substance project source code found at.http://java.net/projects/substance/sources/svn/show/trunk/www.=
To view the gallery of the different toned-down themes, you need to chec=
k out the source code and then navigate to the
neddown.html file from your browser..
<laf> element can be restri=
cted 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 deta=