1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>JGoodies Forms :: Reference :: Layout Variables</title>
<link rel="stylesheet" type="text/css" href="../style.css" >
<meta name="description" content="The JGoodies Forms helps you layout and implement elegant Panel quickly and consistently.">
<meta name="author" content="Karsten Lentzsch">
<meta name="keywords" content="JGoodies Forms Java Layout Swing UI Design Usability Lentzsch Kiel">
<meta name="robots" content="index, follow">
<meta name="date" content="2003-07-31">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body bgcolor="#FFFFFF" leftmargin="0" marginheight="0" marginwidth="0" topmargin="0" bottommargin="0" >
<table border="0" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td colspan="3" bgcolor="DDDCDC"><a href="../../README.html"><img
src="../images/banner.gif" width="436" height="46" alt=":: JGOODIES :: Forms" border="0"></a></td>
</tr>
<tr>
<td colspan="3" height="1" bgcolor="C9C8C8"></td>
</tr>
<tr>
<td width="160" height="500" valign="top" bgcolor="F4f3f3" class="nav" nowrap="nowrap">
<div style="margin-left: 17px; margin-top: 17px; margin-right: 10px; ; margin-bottom: 17px; line-height: 18px;">
<!-- ************ Anfang der Seitennavigation **************************** -->
<b>General</b>
<br>:: <a class="nav" href="../../README.html">Readme</a>
<br>:: <a class="nav" href="../../RELEASE-NOTES.txt">Release Notes</a>
<br>:: <a class="nav" href="../../LICENSE.txt">License</a>
<br>:: <a class="nav" href="../whitepaper.pdf">Whitepaper</a>
<br>:: <a class="nav" href="../visualbuilders.html">Visual Builders</a>
<br>:: <a class="nav" href="../references.html">References</a>
<br>:: <a class="nav" href="../tips.html">Tips & Tricks</a>
<br>:: <a class="nav" href="https://forms.dev.java.net/faq.html">FAQ</a>
<p>
<b>Tutorial</b>
<br>:: <a class="nav" href="../tutorial/introduction.html">Introduction</a>
<br>:: <a class="nav" href="../tutorial/quickstart.html">Quick Start</a>
<br>:: <a class="nav" href="../tutorial/basics.html">Basics</a>
<br>:: <a class="nav" href="../tutorial/building.html">Building</a>
<br>:: <a class="nav" href="../tutorial/factories.html">Factories</a>
<p>
<b>Reference</b>
<br>:: <a class="nav" href="alignments.html">Alignments</a>
<br>:: <a class="nav" href="constantsizes.html">Constant Sizes</a>
<br>:: <a class="nav" href="componentsizes.html">Component Sizes</a>
<br>:: <a class="nav" href="boundedsizes.html">Bounded Sizes</a>
<br>:: <a class="nav" href="colsandrows.html">Cols & Rows</a>
<br>:: <a class="nav" href="cells.html">Cell Constraints</a>
<br>:: <a class="nav" href="groups.html">Groups</a>
<br>:: <a class="nav" href="variables.html"><b>Layout Variables</b></a>
<p>
<a class="nav" href="../api/index.html"><b>API Docs</b></a>
<p>
<b>Web Pages</b>
<br>:: <a class="nav" href="http://forms.dev.java.net/">Project Home</a>
<br>:: <a class="nav" href="http://www.jgoodies.com/downloads/libraries.html">Downloads</a>
<br>:: <a class="nav" href="http://forms.dev.java.net/servlets/ProjectNewsList">Announcements</a>
<br>:: <a class="nav" href="http://forms.dev.java.net/servlets/ProjectMailingListList">Mailing Lists</a>
<br>:: <a class="nav" href="http://forms.dev.java.net/servlets/ProjectIssues">Issue Tracker</a>
<br>:: <a class="nav" href="http://www.jgoodies.com/freeware/">More Examples</a>
<!-- *********** Ende der Seitennavigation ******************************* -->
</div>
</td>
<td width="1" bgcolor="E7E5E5"><img src="/images/banner.gif" width="1" height="1" alt=""></td>
<td width="90%" valign="top" >
<div style="margin-left: 20px; margin-top: 17px; margin-bottom: 17px">
<!-- ************ Anfang des Inhalts ***************************************** -->
<table width="530" border="0" cellspacing="0" cellpadding="0">
<tr>
<td>
<h1>:: Reference :: Layout Variables ::</h1>
Layout variables are used to use improve the design consistency.
<p>
Predefined and custom variables start with a dollar sign ($)
and can be surrounded by braces ({ … }). For example <tt>$lcgap</tt>,
<tt>${label-component-gap}</tt>, <tt>$myvariable1</tt>,
<tt>${myvariable1}</tt>, <tt>${my variable with white space}</tt>.
If surrounded by braces the variable name can contain hyphens
and white-space.
<pre>
variable ::= $<alphanumeric> | ${<string>}
</pre>
<h2>Predefined Variables</h2>
Predefined variables provide access to
<a href="constantsizes.html">logical sizes</a> in the Forms' string
language. Their values are requested from the current <i>Layout Style</i>.
<pre>
columnVariable ::= ${label-component-gap} | $lcgap | $lcg
${related-gap} | $rgap | $rg
${unrelated-gap} | $ugap | $ug
$button | $b
${growing-button} | $gb
${dialog-margin} | $dmargin | $dm
${tabbed-dialog-margin} | $tdmargin | $tdm
$glue
rowVariable ::= ${related-gap} | $rgap | $rg
${unrelated-gap} | $ugap | $ug
${narrow-line-gap} | $nlgap | $nlg
${line-gap} | $lgap | $lg
${paragaph-gap} | $pgap | $pg
${dialog-margin} | $dmargin | $dm
${tabbed-dialog-margin} | $tdmargin | $tdm
$button | $b
$glue
</pre>
<h2>Custom Variables</h2>
Custom variables further reduce the costs to achieve
consistent design in teams and when implementing many screens.
Let's say you want right-aligned labels in all your screens.
You would repeat <tt>"right:pref</tt>" in every individual
FormLayout construction.
If you introduce a custom variable <tt>$label</tt> by
setting it in the shared root <tt>LayoutMap</tt> you could
later refer to it in the FormLayout constructor
<pre>
LayoutMap.getRoot().columnPut("label", "right:pref");
new FormLayout("$label, $lcgap, pref", …);
</pre>
If you setup custom variables, you can honor the platform,
locale, and other context information. Let's say you want
to ensure a consistent width of all label columns using
<tt>"right:[85dlu,pref]"</tt>. The <tt>85dlu</tt> will likely
waste space in Chinese.
<pre>
String width = <compute width per Locale>; // e.g. "85dlu" vs. "25dlu"
LayoutMap.getRoot().columnPut("label", "right:[" + width + ", pref]");
</pre>
<h2>Overriding and Changing Variable Values</h2>
You can change a predefined variable value globally or locally.
Layout variable values are requested from LayoutMaps. There's
a shared root LayoutMap available via <tt>LayoutMap.getRoot()</tt>
that is used by default by the FormLayout constructor and other
methods that use encoded column and row specifications.
<p>
If you re-define a variable value in the root LayoutMap,
the change will affect all layouts that use the default LayoutMap.
For example: <tt>LayoutMap.getRoot().columnPut("lcgap", "1dlu");</tt>.
<p>
As an alternative you can create a child LayoutMap and use this
change locally.<pre>
LayoutMap childMap = new LayoutMap(); // has the root map as parent
childMap.columnPut("lcgap", "1dlu");
new FormLayout("&hellip", "&hellip", childMap); // uses the child map</pre>
<h2>Examples</h2>
<pre>
LayoutMap map = LayoutMap.getRoot();
map.columnPut("label", "right:[85dlu,pref]");
map.rowPut ("table", "fill:100dlu:grow");
new FormLayout("right:[85dlu,pref], 3dlu, pref, 3dlu, 50dlu", // no var
"p, 3dlu, p, 3dlu, fill:100dlu:grow");
new FormLayout("right:[85dlu,pref], $lcgap, pref, $rgap, $button", // vars
"p, $lgap, p, $lgap, fill:100dlu:grow");
new FormLayout("right:[85dlu,pref], $lcg, pref, $rg, $b", // short
"p, $lg, p, $lg, fill:100dlu:grow");
new FormLayout("$label, $lcgap, pref, $rgap, $button", // custom vars
"p, $lgap, p, $lgap, $table");
</pre>
</td>
</tr>
</table>
<!-- ************ Ende des Inhalts ************************************** -->
</div>
</td>
</tr>
<tr>
<td nowrap="nowrap" bgcolor="F4f3f3">
<div style="font-size: 10px; margin-left: 17px; margin-top: 20px; margin-right: 10px; margin-bottom: 4px;">
(c) 2009 JGoodies
</div>
</td>
<td width="1" bgcolor="E7E5E5"></td>
<td> </td>
</tr>
<tr>
<td colspan="2" height="1" bgcolor="E7E5E5"></td>
<td></td>
</tr>
</table>
</body>
</html>
|
