/usr/share/doc/libswing-layout-java/api/org/jdesktop/layout/LayoutStyle.html is in libswing-layout-java-doc 1.0.4-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_21) on Mon May 27 23:52:05 UTC 2013 -->
<title>LayoutStyle</title>
<meta name="date" content="2013-05-27">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="LayoutStyle";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../org/jdesktop/layout/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/LayoutStyle.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/jdesktop/layout/GroupLayout.SequentialGroup.html" title="class in org.jdesktop.layout"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jdesktop/layout/LayoutStyle.html" target="_top">Frames</a></li>
<li><a href="LayoutStyle.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.jdesktop.layout</div>
<h2 title="Class LayoutStyle" class="title">Class LayoutStyle</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.jdesktop.layout.LayoutStyle</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">LayoutStyle</span>
extends java.lang.Object</pre>
<div class="block">LayoutStyle is used to determine how much space to place between components
during layout. LayoutStyle can be obtained for two components, or for
a component relative to an edge of a parent container. The amount of
space can vary depending upon whether or not the components are
logically grouped together (<code>RELATED</code>).
<p>
This class is primarily useful for JREs prior to 1.6. In 1.6 API for this
was added to Swing. When run on a JRE of 1.6 or greater this will call into
the appropriate methods in Swing.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdesktop/layout/LayoutStyle.html#INDENT">INDENT</a></strong></code>
<div class="block">Possible argument to getPreferredGap.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdesktop/layout/LayoutStyle.html#RELATED">RELATED</a></strong></code>
<div class="block">Possible argument to getPreferredGap.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdesktop/layout/LayoutStyle.html#UNRELATED">UNRELATED</a></strong></code>
<div class="block">Possible argument to getPreferredGap.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/jdesktop/layout/LayoutStyle.html#LayoutStyle()">LayoutStyle</a></strong>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdesktop/layout/LayoutStyle.html#getContainerGap(javax.swing.JComponent, int, java.awt.Container)">getContainerGap</a></strong>(javax.swing.JComponent component,
int position,
java.awt.Container parent)</code>
<div class="block">Returns the amount of space to position a component inside its
parent.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdesktop/layout/LayoutStyle.html#getPreferredGap(javax.swing.JComponent, javax.swing.JComponent, int, int, java.awt.Container)">getPreferredGap</a></strong>(javax.swing.JComponent component1,
javax.swing.JComponent component2,
int type,
int position,
java.awt.Container parent)</code>
<div class="block">Returns the amount of space to use between two components.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/jdesktop/layout/LayoutStyle.html" title="class in org.jdesktop.layout">LayoutStyle</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdesktop/layout/LayoutStyle.html#getSharedInstance()">getSharedInstance</a></strong>()</code>
<div class="block">Factory methods for obtaining the current <code>LayoutStyle</code>
object appropriate for the current look and feel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdesktop/layout/LayoutStyle.html#setSharedInstance(org.jdesktop.layout.LayoutStyle)">setSharedInstance</a></strong>(<a href="../../../org/jdesktop/layout/LayoutStyle.html" title="class in org.jdesktop.layout">LayoutStyle</a> layoutStyle)</code>
<div class="block">Sets the LayoutStyle instance to use for this look and feel.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="RELATED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RELATED</h4>
<pre>public static final int RELATED</pre>
<div class="block">Possible argument to getPreferredGap. Used to indicate the two componets
are grouped together.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.jdesktop.layout.LayoutStyle.RELATED">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="UNRELATED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNRELATED</h4>
<pre>public static final int UNRELATED</pre>
<div class="block">Possible argument to getPreferredGap. Used to indicate the two componets
are not grouped together.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.jdesktop.layout.LayoutStyle.UNRELATED">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="INDENT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>INDENT</h4>
<pre>public static final int INDENT</pre>
<div class="block">Possible argument to getPreferredGap. Used to indicate the distance
to indent a component is being requested. To visually indicate
a set of related components they will often times be horizontally
indented, the <code>INDENT</code> constant for this.
For example, to indent a check box relative to a label use this
constant to <code>getPreferredGap</code>.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.jdesktop.layout.LayoutStyle.INDENT">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="LayoutStyle()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LayoutStyle</h4>
<pre>public LayoutStyle()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setSharedInstance(org.jdesktop.layout.LayoutStyle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSharedInstance</h4>
<pre>public static void setSharedInstance(<a href="../../../org/jdesktop/layout/LayoutStyle.html" title="class in org.jdesktop.layout">LayoutStyle</a> layoutStyle)</pre>
<div class="block">Sets the LayoutStyle instance to use for this look and feel.
You generally don't need to invoke this, instead use the getter which
will return the LayoutStyle appropriate for the current look and feel.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>layoutStyle</code> - the LayoutStyle to use; a value of null indicates
the default should be used</dd></dl>
</li>
</ul>
<a name="getSharedInstance()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSharedInstance</h4>
<pre>public static <a href="../../../org/jdesktop/layout/LayoutStyle.html" title="class in org.jdesktop.layout">LayoutStyle</a> getSharedInstance()</pre>
<div class="block">Factory methods for obtaining the current <code>LayoutStyle</code>
object appropriate for the current look and feel.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current LayoutStyle instance</dd></dl>
</li>
</ul>
<a name="getPreferredGap(javax.swing.JComponent, javax.swing.JComponent, int, int, java.awt.Container)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPreferredGap</h4>
<pre>public int getPreferredGap(javax.swing.JComponent component1,
javax.swing.JComponent component2,
int type,
int position,
java.awt.Container parent)</pre>
<div class="block">Returns the amount of space to use between two components.
The return value indicates the distance to place
<code>component2</code> relative to <code>component1</code>.
For example, the following returns the amount of space to place
between <code>component2</code> and <code>component1</code>
when <code>component2</code> is placed vertically above
<code>component1</code>:
<pre>
int gap = getPreferredGap(component1, component2,
LayoutStyle.RELATED,
SwingConstants.NORTH, parent);
</pre>
The <code>type</code> parameter indicates the type
of gap being requested. It can be one of the following values:
<table>
<tr><td><code>RELATED</code>
<td>If the two components will be contained in
the same parent and are showing similar logically related
items, use <code>RELATED</code>.
<tr><td><code>UNRELATED</code>
<td>If the two components will be
contained in the same parent but show logically unrelated items
use <code>UNRELATED</code>.
<tr><td><code>INDENT</code>
<td>Used to obtain the preferred distance to indent a component
relative to another. For example, if you want to horizontally
indent a JCheckBox relative to a JLabel use <code>INDENT</code>.
This is only useful for the horizontal axis.
</table>
<p>
It's important to note that some look and feels may not distinguish
between <code>RELATED</code> and <code>UNRELATED</code>.
<p>
The return value is not intended to take into account the
current size and position of <code>component2</code> or
<code>component1</code>. The return value may take into
consideration various properties of the components. For
example, the space may vary based on font size, or the preferred
size of the component.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>component1</code> - the <code>JComponent</code>
<code>component2</code> is being placed relative to</dd><dd><code>component2</code> - the <code>JComponent</code> being placed</dd><dd><code>type</code> - how the two components are being placed</dd><dd><code>position</code> - the position <code>component2</code> is being placed
relative to <code>component1</code>; one of
<code>SwingConstants.NORTH</code>,
<code>SwingConstants.SOUTH</code>,
<code>SwingConstants.EAST</code> or
<code>SwingConstants.WEST</code></dd><dd><code>parent</code> - the parent of <code>component2</code>; this may differ
from the actual parent and may be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the amount of space to place between the two components</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>position</code> is not
one of <code>SwingConstants.NORTH</code>,
<code>SwingConstants.SOUTH</code>,
<code>SwingConstants.EAST</code> or
<code>SwingConstants.WEST</code>; <code>type</code> not one
of <code>INDENT</code>, <code>RELATED</code>
or <code>UNRELATED</code>; or <code>component1</code> or
<code>component2</code> is null</dd></dl>
</li>
</ul>
<a name="getContainerGap(javax.swing.JComponent, int, java.awt.Container)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getContainerGap</h4>
<pre>public int getContainerGap(javax.swing.JComponent component,
int position,
java.awt.Container parent)</pre>
<div class="block">Returns the amount of space to position a component inside its
parent.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>component</code> - the <code>Component</code> being positioned</dd><dd><code>position</code> - the position <code>component</code> is being placed
relative to its parent; one of
<code>SwingConstants.NORTH</code>,
<code>SwingConstants.SOUTH</code>,
<code>SwingConstants.EAST</code> or
<code>SwingConstants.WEST</code></dd><dd><code>parent</code> - the parent of <code>component</code>; this may differ
from the actual parent and may be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the amount of space to place between the component and specified
edge</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>position</code> is not
one of <code>SwingConstants.NORTH</code>,
<code>SwingConstants.SOUTH</code>,
<code>SwingConstants.EAST</code> or
<code>SwingConstants.WEST</code>;
or <code>component</code> is null</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../org/jdesktop/layout/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/LayoutStyle.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/jdesktop/layout/GroupLayout.SequentialGroup.html" title="class in org.jdesktop.layout"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jdesktop/layout/LayoutStyle.html" target="_top">Frames</a></li>
<li><a href="LayoutStyle.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|