/usr/share/doc/libflexdock-java-doc/api/org/flexdock/util/DockingUtility.html is in libflexdock-java-doc 1.2.4-1.
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 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 | <!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_25) on Sun Sep 08 12:31:35 UTC 2013 -->
<title>DockingUtility</title>
<meta name="date" content="2013-09-08">
<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="DockingUtility";
}
//-->
</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="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.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/flexdock/util/ClassMapping.html" title="class in org.flexdock.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/flexdock/util/LookAndFeelSettings.html" title="class in org.flexdock.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/flexdock/util/DockingUtility.html" target="_top">Frames</a></li>
<li><a href="DockingUtility.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>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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.flexdock.util</div>
<h2 title="Class DockingUtility" class="title">Class DockingUtility</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.flexdock.util.DockingUtility</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../org/flexdock/docking/DockingConstants.html" title="interface in org.flexdock.docking">DockingConstants</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">DockingUtility</span>
extends java.lang.Object
implements <a href="../../../org/flexdock/docking/DockingConstants.html" title="interface in org.flexdock.docking">DockingConstants</a></pre>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Christopher Butler</dd></dl>
</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>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.flexdock.docking.DockingConstants">
<!-- -->
</a>
<h3>Fields inherited from interface org.flexdock.docking.<a href="../../../org/flexdock/docking/DockingConstants.html" title="interface in org.flexdock.docking">DockingConstants</a></h3>
<code><a href="../../../org/flexdock/docking/DockingConstants.html#ACTIVE_WINDOW">ACTIVE_WINDOW</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#BOTTOM">BOTTOM</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#CENTER">CENTER</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#CENTER_REGION">CENTER_REGION</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#CLOSE_ACTION">CLOSE_ACTION</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#DEFAULT_PERSISTENCE_KEY">DEFAULT_PERSISTENCE_KEY</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#DOCKING_ID">DOCKING_ID</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#EAST_REGION">EAST_REGION</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#HEAVYWEIGHT_DOCKABLES">HEAVYWEIGHT_DOCKABLES</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#HORIZONTAL">HORIZONTAL</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#LEFT">LEFT</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#MOUSE_PRESSED">MOUSE_PRESSED</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#NORTH_REGION">NORTH_REGION</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#PERMANENT_FOCUS_OWNER">PERMANENT_FOCUS_OWNER</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#PIN_ACTION">PIN_ACTION</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#REGION">REGION</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#RIGHT">RIGHT</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#SOUTH_REGION">SOUTH_REGION</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#TOP">TOP</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#UNINITIALIZED">UNINITIALIZED</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#UNINITIALIZED_RATIO">UNINITIALIZED_RATIO</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#UNKNOWN_REGION">UNKNOWN_REGION</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#UNSPECIFIED_SIBLING_PREF">UNSPECIFIED_SIBLING_PREF</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#VERTICAL">VERTICAL</a>, <a href="../../../org/flexdock/docking/DockingConstants.html#WEST_REGION">WEST_REGION</a></code></li>
</ul>
</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>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#dockRelative(org.flexdock.docking.Dockable, org.flexdock.docking.Dockable, java.lang.String)">dockRelative</a></strong>(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable,
<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> parent,
java.lang.String relativeRegion)</code>
<div class="block">Docks the specified <code>Dockable</code> relative to another already-docked
<code>Dockable</code> in the specified region.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#dockRelative(org.flexdock.docking.Dockable, org.flexdock.docking.Dockable, java.lang.String, float)">dockRelative</a></strong>(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable,
<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> parent,
java.lang.String relativeRegion,
float ratio)</code>
<div class="block">Docks the specified <code>Dockable</code> relative to another already-docked
<code>Dockable</code> in the specified region with the specified split
proportion.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/flexdock/docking/DockingPort.html" title="interface in org.flexdock.docking">DockingPort</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#findDockingPort(java.awt.Container, java.awt.Point)">findDockingPort</a></strong>(java.awt.Container container,
java.awt.Point location)</code>
<div class="block">Returns the deepest <code>DockingPort</code> within the specified
<code>Container</code> at the specified <code>location</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#flipRegion(java.lang.String)">flipRegion</a></strong>(java.lang.String region)</code>
<div class="block">Returns the opposite docking region of the specified <code>region</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#getAncestorDockable(java.awt.Component)">getAncestorDockable</a></strong>(java.awt.Component comp)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#getMinimizedConstraint(org.flexdock.docking.Dockable)">getMinimizedConstraint</a></strong>(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable)</code>
<div class="block">Returns an <code>int</code> value representing the current minimization
constraint for the specified <code>Dockable</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../org/flexdock/docking/DockingPort.html" title="interface in org.flexdock.docking">DockingPort</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#getParentDockingPort(java.awt.Component)">getParentDockingPort</a></strong>(java.awt.Component comp)</code>
<div class="block">Returns the <code>DockingPort</code> that contains the specified
<code>Component</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/flexdock/docking/DockingPort.html" title="interface in org.flexdock.docking">DockingPort</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#getParentDockingPort(org.flexdock.docking.Dockable)">getParentDockingPort</a></strong>(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> d)</code>
<div class="block">Returns the <code>DockingPort</code> that contains the specified
<code>Dockable</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#getRegion(int)">getRegion</a></strong>(int regionType)</code>
<div class="block">Returns the <code>String</code> docking region for the specified orientation
constant.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#getTabText(org.flexdock.docking.Dockable)">getTabText</a></strong>(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable)</code>
<div class="block">Returns the text to be used by a <code>Dockable</code> as a tab label within a
tabbed layout.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#isActive(org.flexdock.docking.Dockable)">isActive</a></strong>(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#isAxisEquivalent(java.lang.String, java.lang.String)">isAxisEquivalent</a></strong>(java.lang.String region,
java.lang.String otherRegion)</code>
<div class="block">Tests for region equivalency between the specified region parameters
across horizontal and vertical axes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#isDockable(java.lang.Object)">isDockable</a></strong>(java.lang.Object obj)</code>
<div class="block">Returns <code>true</code> if the specific <code>Object</code> is a <code>Dockable</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#isEmbedded(org.flexdock.docking.Dockable)">isEmbedded</a></strong>(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable)</code>
<div class="block">Returns <code>true</code> if the specified <code>Dockable</code> is currently
docked within a <code>DockingPort</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#isFloating(org.flexdock.docking.Dockable)">isFloating</a></strong>(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable)</code>
<div class="block">Returns <code>true</code> if the specified <code>Dockable</code> is currently
docked within a floating dialog.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#isMinimized(org.flexdock.docking.Dockable)">isMinimized</a></strong>(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable)</code>
<div class="block">Returns <code>true</code> if the specified <code>Dockable</code> is currently
minimized; <code>false</code> otherwise.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#isRegionTopLeft(java.lang.String)">isRegionTopLeft</a></strong>(java.lang.String region)</code>
<div class="block">Returns <code>true</code> if the specified <code>region</code> is equal to either
<code>NORTH_REGION</code> or <code>WEST_REGION</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#isSubport(org.flexdock.docking.DockingPort)">isSubport</a></strong>(<a href="../../../org/flexdock/docking/DockingPort.html" title="interface in org.flexdock.docking">DockingPort</a> dockingPort)</code>
<div class="block">Returns <code>true</code> if the specified <code>DockingPort</code> has an ancestor
<code>DockingPort</code>; <code>false</code> otherwise.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#setSplitProportion(org.flexdock.docking.Dockable, float)">setSplitProportion</a></strong>(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable,
float proportion)</code>
<div class="block">Sets the divider location of the split layout containing the specified
dockable <code>Component</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#setSplitProportion(org.flexdock.docking.DockingPort, float)">setSplitProportion</a></strong>(<a href="../../../org/flexdock/docking/DockingPort.html" title="interface in org.flexdock.docking">DockingPort</a> port,
float proportion)</code>
<div class="block">Sets the divider location of the split layout embedded within the
specified <code>DockingPort</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/flexdock/util/DockingUtility.html#translateRegionAxis(javax.swing.JSplitPane, java.lang.String)">translateRegionAxis</a></strong>(javax.swing.JSplitPane splitPane,
java.lang.String region)</code>
<div class="block">Returns the specified <code>region's</code> cross-axis equivalent region in
accordance with the orientation used by the specified <code>JSplitPane</code>.</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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getParentDockingPort(org.flexdock.docking.Dockable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParentDockingPort</h4>
<pre>public static <a href="../../../org/flexdock/docking/DockingPort.html" title="interface in org.flexdock.docking">DockingPort</a> getParentDockingPort(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> d)</pre>
<div class="block">Returns the <code>DockingPort</code> that contains the specified
<code>Dockable</code>. If the <code>Dockable</code> is <code>null</code>, then a
<code>null</code> reference is returned.
<p>
This method will only return the immediate parent <code>DockingPort</code> of
the specified <code>Dockable</code> This means that a check is performed for
the <code>Component</code> returned by the <code>Dockable's</code>
<code>getComponent()</code> method. The <code>DockingPort</code> returned by this
method will not only be an ancestor <code>Container</code> of this
<code>Component</code>, but invoking the <code>DockingPort's</code>
<code>isParentDockingPort(Component comp)</code> with the this
<code>Component</code> will also return <code>true</code>. If both of these
conditions cannot be satisfied, then this method returns a <code>null</code>
reference.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>d</code> - the <code>Dockable</code> whose parent <code>DockingPort</code> is to be
returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the imediate parent <code>DockingPort</code> that contains the
specified <code>Dockable</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/flexdock/util/DockingUtility.html#getParentDockingPort(java.awt.Component)"><code>getParentDockingPort(Component)</code></a></dd></dl>
</li>
</ul>
<a name="getParentDockingPort(java.awt.Component)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParentDockingPort</h4>
<pre>public static <a href="../../../org/flexdock/docking/DockingPort.html" title="interface in org.flexdock.docking">DockingPort</a> getParentDockingPort(java.awt.Component comp)</pre>
<div class="block">Returns the <code>DockingPort</code> that contains the specified
<code>Component</code>. If the <code>Component</code> is <code>null</code>, then a
<code>null</code> reference is returned.
<p>
This method will only return the immediate parent <code>DockingPort</code> of
the specified <code>Component</code> This means that the <code>DockingPort</code>
returned by this method will not only be an ancestor <code>Container</code> of
the specified <code>Component</code>, but invoking its
<code>isParentDockingPort(Component comp)</code> with the specified
<code>Component</code> will also return <code>true</code>. If both of these
conditions cannot be satisfied, then this method returns a <code>null</code>
reference.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comp</code> - the <code>Component</code> whose parent <code>DockingPort</code> is to
be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the immediate parent <code>DockingPort</code> that contains the
specified <code>Component</code>.</dd></dl>
</li>
</ul>
<a name="isSubport(org.flexdock.docking.DockingPort)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSubport</h4>
<pre>public static boolean isSubport(<a href="../../../org/flexdock/docking/DockingPort.html" title="interface in org.flexdock.docking">DockingPort</a> dockingPort)</pre>
<div class="block">Returns <code>true</code> if the specified <code>DockingPort</code> has an ancestor
<code>DockingPort</code>; <code>false</code> otherwise. If the specified
<code>DockingPort</code> is <code>null</code>, then this method returns
<code>false</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dockingPort</code> - the <code>DockingPort</code> to check for an ancestor port</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the specified <code>DockingPort</code> has an ancestor
<code>DockingPort</code>; <code>false</code> otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><code>SwingUtilities.getAncestorOfClass(java.lang.Class,
java.awt.Component)</code></dd></dl>
</li>
</ul>
<a name="findDockingPort(java.awt.Container, java.awt.Point)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findDockingPort</h4>
<pre>public static <a href="../../../org/flexdock/docking/DockingPort.html" title="interface in org.flexdock.docking">DockingPort</a> findDockingPort(java.awt.Container container,
java.awt.Point location)</pre>
<div class="block">Returns the deepest <code>DockingPort</code> within the specified
<code>Container</code> at the specified <code>location</code>. If either
<code>container</code> or <code>location</code> are <code>null</code>, then this method
returns <code>null</code>.
<p>
This method will find the deepest <code>Component</code> within the specified
container that the specified <code>Point</code> via
<code>SwingUtilities.getDeepestComponentAt(Component parent, int x, int y)</code>.
If no <code>Component</code> is resovled, then this method returns
<code>null</code>. If the resolved <code>Component</code> is a <code>DockingPort</code>,
then it is returned. Otherwise, the <code>Component's</code>
<code>DockingPort</code> ancestor is resovled and returned from
<code>SwingUtilities.getAncestorOfClass(Class c, Component comp)</code>,
passing <code>DockingPort.class</code> for the ancestor class parameter.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>container</code> - the <code>Container</code> within which to find a
<code>DockingPort</code>.</dd><dd><code>location</code> - the point within the specified <code>Container</code> at which to
search for a <code>DockingPort</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the deepest <code>DockingPort</code> within the specified
<code>Container</code> at the specified <code>location</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><code>SwingUtilities.getDeepestComponentAt(java.awt.Component, int, int)</code>,
<code>SwingUtilities.getAncestorOfClass(java.lang.Class,
java.awt.Component)</code></dd></dl>
</li>
</ul>
<a name="translateRegionAxis(javax.swing.JSplitPane, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>translateRegionAxis</h4>
<pre>public static java.lang.String translateRegionAxis(javax.swing.JSplitPane splitPane,
java.lang.String region)</pre>
<div class="block">Returns the specified <code>region's</code> cross-axis equivalent region in
accordance with the orientation used by the specified <code>JSplitPane</code>.
If the <code>JSplitPane</code> is <code>null</code>, or the specified
<code>region</code> is invalid according to
<code>DockingManager.isValidDockingRegion(String region)</code>, then this
method returns <code>null</code>.
<code>NORTH_REGION</code> and <code>SOUTH_REGION</code> are considered "vertical"
regions, while <code>WEST_REGION</code> and <code>EAST_REGION</code> are considered
horizontal regions. If the <code>JSplitPane</code> orientation matches the
specified <code>region</code> orientation, then the original <code>region</code>
value is returned. For instance, if the specified <code>region</code> is
<code>EAST_REGION</code>, and the <code>JSplitPane</code> is of a horizontal
orientation, then there is no need to translate the <code>region</code>
parameter across axes since its current axis is already horizontal. In
this case, <code>EAST_REGION</code> would be returned by this method.
<p>
If the axis of the specified <code>region</code> does not match the
orientation of the <code>JSplitPane</code>, then the region is translated to
its cross-axis equivalent and returns. In this case, <code>NORTH_REGION</code>
will be translated to <code>WEST_REGION</code>, <code>SOUTH_REGION</code> to
<code>EAST_REGION</code>, <code>WEST_REGION</code> to <code>NORTH_REGION</code>, and
<code>EAST_REGION</code> to <code>SOUTH_REGION</code>. <code>CENTER_REGION</code> is
never altered.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>splitPane</code> - the <code>JSplitPane</code> whose orientation is to be used as a
target axis</dd><dd><code>region</code> - the docking region to translate to the target axis</dd>
<dt><span class="strong">Returns:</span></dt><dd>the specified <code>region's</code> cross-axis equivalent region in
accordance with the orientation used by the specified
<code>JSplitPane</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/flexdock/docking/DockingManager.html#isValidDockingRegion(java.lang.String)"><code>DockingManager.isValidDockingRegion(String)</code></a>,
<code>JSplitPane.getOrientation()</code>,
<a href="../../../org/flexdock/util/DockingUtility.html#isAxisEquivalent(java.lang.String, java.lang.String)"><code>isAxisEquivalent(String, String)</code></a></dd></dl>
</li>
</ul>
<a name="flipRegion(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flipRegion</h4>
<pre>public static java.lang.String flipRegion(java.lang.String region)</pre>
<div class="block">Returns the opposite docking region of the specified <code>region</code>. For
<code>NORTH_REGION</code>, this method returns <code>SOUTH_REGION</code>. For
<code>SOUTH_REGION</code>, this method returns <code>NORTH_REGION</code>. For
<code>EAST_REGION</code>, this method returns <code>WEST_REGION</code>. For
<code>WEST_REGION</code>, this method returns <code>EAST_REGION</code>. For
<code>CENTER_REGION</code> or an invalid region, as specified by
<code>DockingManager.isValidDockingRegion(String region)</code>, this method
return <code>CENTER_REGION</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>region</code> - the region whose opposite is to be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the opposite docking region of the specified <code>region</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/flexdock/docking/DockingManager.html#isValidDockingRegion(java.lang.String)"><code>DockingManager.isValidDockingRegion(String)</code></a></dd></dl>
</li>
</ul>
<a name="isAxisEquivalent(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAxisEquivalent</h4>
<pre>public static boolean isAxisEquivalent(java.lang.String region,
java.lang.String otherRegion)</pre>
<div class="block">Tests for region equivalency between the specified region parameters
across horizontal and vertical axes. If either <code>region</code> or
<code>otherRegion</code> are <code>null</code> or invalid according to
<code>DockingManager.isValidDockingRegion(String region)</code>, then this
method returns <code>false</code>.
<p>
Equivalency within the same axis means that the two specified regions are
the same value, as each region is unique within its axis. Thus, this
method returns <code>true</code> if <code>region.equals(otherRegion)</code> returns
<code>true</code>. This includes <code>CENTER_REGION</code>, which is axis
independent.
<p>
<code>CENTER_REGION</code> is not an axis equivalent to any region other than
itself since it is the only docking region that does not correspond to a
horizontal or vertical axis. If either the specified <code>region</code> or
<code>otherRegion</code> is <code>CENTER_REGION</code> and the other is not, then
this method returns <code>false</code>.
<p>
Equivalancy across axes follows a top-to-left and bottom-to-right
mapping. In this fashion, <code>NORTH_REGION</code> and <code>WEST_REGION</code>
are equivalent and <code>SOUTH_REGION</code> and <code>EAST_REGION</code> are
equivalent. These combination will return <code>true</code> for this method.
All other region combinatinos will cause this method to return
<code>false</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>region</code> - the first region to check for equivalency</dd><dd><code>otherRegion</code> - the second region to check for equivalency</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the two specified regions are equal or cross-axis
equivalents, <code>false</code> otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/flexdock/docking/DockingManager.html#isValidDockingRegion(java.lang.String)"><code>DockingManager.isValidDockingRegion(String)</code></a></dd></dl>
</li>
</ul>
<a name="isRegionTopLeft(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRegionTopLeft</h4>
<pre>public static boolean isRegionTopLeft(java.lang.String region)</pre>
<div class="block">Returns <code>true</code> if the specified <code>region</code> is equal to either
<code>NORTH_REGION</code> or <code>WEST_REGION</code>. Returns <code>false</code>
otherwise.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>region</code> - the <code>region</code> to check for top or left equivalency</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the specified <code>region</code> is equal to either
<code>NORTH_REGION</code> or <code>WEST_REGION</code>; <code>false</code>
otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/flexdock/docking/DockingConstants.html#NORTH_REGION"><code>DockingConstants.NORTH_REGION</code></a>,
<a href="../../../org/flexdock/docking/DockingConstants.html#WEST_REGION"><code>DockingConstants.WEST_REGION</code></a></dd></dl>
</li>
</ul>
<a name="getRegion(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRegion</h4>
<pre>public static java.lang.String getRegion(int regionType)</pre>
<div class="block">Returns the <code>String</code> docking region for the specified orientation
constant. <code>LEFT</code> maps to <code>WEST_REGION</code>, <code>RIGHT</code> maps
to <code>EAST_REGION</code>, <code>TOP</code> maps to <code>NORTH_REGION</code>,
<code>BOTTOM</code> maps to <code>SOUTH_REGION</code>, and <code>CENTER</code> maps to
<code>CENTER_REGION</code>. All other integer values will cause this method
to return <code>UNKNOWN_REGION</code>.
<p>
All constants, both integer an <code>String</code> values, can be found on the
<code>DockingConstants</code> interface.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>regionType</code> - the orientation constant to translate into a docking region</dd>
<dt><span class="strong">Returns:</span></dt><dd>the <code>String</code> docking region for the specified orientation
constant.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/flexdock/docking/DockingConstants.html#LEFT"><code>DockingConstants.LEFT</code></a>,
<a href="../../../org/flexdock/docking/DockingConstants.html#RIGHT"><code>DockingConstants.RIGHT</code></a>,
<a href="../../../org/flexdock/docking/DockingConstants.html#TOP"><code>DockingConstants.TOP</code></a>,
<a href="../../../org/flexdock/docking/DockingConstants.html#BOTTOM"><code>DockingConstants.BOTTOM</code></a>,
<a href="../../../org/flexdock/docking/DockingConstants.html#CENTER"><code>DockingConstants.CENTER</code></a>,
<a href="../../../org/flexdock/docking/DockingConstants.html#WEST_REGION"><code>DockingConstants.WEST_REGION</code></a>,
<a href="../../../org/flexdock/docking/DockingConstants.html#EAST_REGION"><code>DockingConstants.EAST_REGION</code></a>,
<a href="../../../org/flexdock/docking/DockingConstants.html#NORTH_REGION"><code>DockingConstants.NORTH_REGION</code></a>,
<a href="../../../org/flexdock/docking/DockingConstants.html#SOUTH_REGION"><code>DockingConstants.SOUTH_REGION</code></a>,
<a href="../../../org/flexdock/docking/DockingConstants.html#CENTER_REGION"><code>DockingConstants.CENTER_REGION</code></a>,
<a href="../../../org/flexdock/docking/DockingConstants.html#UNKNOWN_REGION"><code>DockingConstants.UNKNOWN_REGION</code></a></dd></dl>
</li>
</ul>
<a name="isMinimized(org.flexdock.docking.Dockable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMinimized</h4>
<pre>public static boolean isMinimized(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable)</pre>
<div class="block">Returns <code>true</code> if the specified <code>Dockable</code> is currently
minimized; <code>false</code> otherwise. If the <code>Dockable</code> is
<code>null</code>, then this method returns <code>false</code>.
<p>
This method retrieves the current <code>DockingState</code> instance
associated with the <code>Dockable</code> and calls it's <code>isMinimized()</code>
method to return. <code>DockingState</code> for the specified <code>Dockable</code>
is queried by calling <code>getDockingState(Dockable dockable)</code> on the
<code>DockingManager's</code> currently installed <code>LayoutManager</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dockable</code> - the <code>Dockable</code> whose minimized state is to be returned</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the specified <code>Dockable</code> is currently
minimized; <code>false</code> otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/flexdock/docking/state/DockingState.html#isMinimized()"><code>DockingState.isMinimized()</code></a>,
<a href="../../../org/flexdock/docking/DockingManager.html#getLayoutManager()"><code>DockingManager.getLayoutManager()</code></a>,
<a href="../../../org/flexdock/docking/state/LayoutManager.html#getDockingState(org.flexdock.docking.Dockable)"><code>LayoutManager.getDockingState(Dockable)</code></a></dd></dl>
</li>
</ul>
<a name="getMinimizedConstraint(org.flexdock.docking.Dockable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinimizedConstraint</h4>
<pre>public static int getMinimizedConstraint(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable)</pre>
<div class="block">Returns an <code>int</code> value representing the current minimization
constraint for the specified <code>Dockable</code>. If the <code>Dockable</code>
is <code>null</code>, then this method returns
<code>MinimizationManager.UNSPECIFIED_LAYOUT_CONSTRAINT</code>.
<p>
This method retrieves the current <code>DockingState</code> instance
associated with the <code>Dockable</code> and calls it's
<code>getMinimizedConstraint()</code> method to return. <code>DockingState</code>
for the specified <code>Dockable</code> is queried by calling
<code>getDockingState(Dockable dockable)</code> on the
<code>DockingManager's</code> currently installed <code>LayoutManager</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dockable</code> - the <code>Dockable</code> whose minimized constraint is to be
returned</dd>
<dt><span class="strong">Returns:</span></dt><dd>an <code>int</code> value representing the current minimization
constraint for the specified <code>Dockable</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/flexdock/docking/state/MinimizationManager.html#UNSPECIFIED_LAYOUT_CONSTRAINT"><code>MinimizationManager.UNSPECIFIED_LAYOUT_CONSTRAINT</code></a>,
<a href="../../../org/flexdock/docking/state/DockingState.html#getMinimizedConstraint()"><code>DockingState.getMinimizedConstraint()()</code></a>,
<a href="../../../org/flexdock/docking/DockingManager.html#getLayoutManager()"><code>DockingManager.getLayoutManager()</code></a>,
<a href="../../../org/flexdock/docking/state/LayoutManager.html#getDockingState(org.flexdock.docking.Dockable)"><code>LayoutManager.getDockingState(Dockable)</code></a></dd></dl>
</li>
</ul>
<a name="dockRelative(org.flexdock.docking.Dockable, org.flexdock.docking.Dockable, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dockRelative</h4>
<pre>public static boolean dockRelative(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable,
<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> parent,
java.lang.String relativeRegion)</pre>
<div class="block">Docks the specified <code>Dockable</code> relative to another already-docked
<code>Dockable</code> in the specified region. The "parent" <code>Dockable</code>
must currently be docked. If not, this method will return <code>false</code>.
Otherwise, its parent <code>DockingPort</code> will be resolved and the new
<code>Dockable</code> will be docked into the <code>DockingPort</code> relative to
the "parent" <code>Dockable</code>. This method defers processing to
<code>dockRelative(Dockable dockable, Dockable parent, String relativeRegion, float ratio)</code>
passing <code>UNSPECIFIED_SIBLING_PREF</code> for the <code>ratio</code> parameter.
<p>
This method returns <code>false</code> if any of the input parameters are
<code>null</code> or if the specified <code>region</code> is invalid according to
<code>DockingManager.isValidDockingRegion(String region)</code>. If the
specified region is other than CENTER, then a split layout should result.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dockable</code> - the <code>Dockable</code> to be docked</dd><dd><code>parent</code> - the <code>Dockable</code> used as a reference point for docking</dd><dd><code>relativeRegion</code> - the docking region into which <code>dockable</code> will be docked</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the docking operation was successful;
<code>false</code> otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/flexdock/util/DockingUtility.html#dockRelative(org.flexdock.docking.Dockable, org.flexdock.docking.Dockable, java.lang.String, float)"><code>dockRelative(Dockable, Dockable, String, float)</code></a>,
<a href="../../../org/flexdock/docking/DockingManager.html#isValidDockingRegion(java.lang.String)"><code>DockingManager.isValidDockingRegion(String)</code></a>,
<a href="../../../org/flexdock/docking/Dockable.html#getDockingPort()"><code>Dockable.getDockingPort()</code></a>,
<a href="../../../org/flexdock/docking/DockingManager.html#dock(org.flexdock.docking.Dockable, org.flexdock.docking.DockingPort, java.lang.String)"><code>DockingManager.dock(Dockable, DockingPort, String)</code></a></dd></dl>
</li>
</ul>
<a name="dockRelative(org.flexdock.docking.Dockable, org.flexdock.docking.Dockable, java.lang.String, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dockRelative</h4>
<pre>public static boolean dockRelative(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable,
<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> parent,
java.lang.String relativeRegion,
float ratio)</pre>
<div class="block">Docks the specified <code>Dockable</code> relative to another already-docked
<code>Dockable</code> in the specified region with the specified split
proportion. The "parent" <code>Dockable</code> must currently be docked. If
not, this method will return <code>false</code>. Otherwise, its parent
<code>DockingPort</code> will be resolved and the new <code>Dockable</code> will be
docked into the <code>DockingPort</code> relative to the "parent"
<code>Dockable</code>. If the specified region is CENTER, then the
<code>proportion</code> parameter is ignored. Otherwise, a split layout should
result with the proportional space specified in the <code>proportion</code>
parameter allotted to the <code>dockable</code> argument.
<p>
This method returns <code>false</code> if any of the input parameters are
<code>null</code> or if the specified <code>region</code> is invalid according to
<code>DockingManager.isValidDockingRegion(String region)</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dockable</code> - the <code>Dockable</code> to be docked</dd><dd><code>parent</code> - the <code>Dockable</code> used as a reference point for docking</dd><dd><code>relativeRegion</code> - the docking region into which <code>dockable</code> will be docked</dd><dd><code>ratio</code> - the proportional space to allot the <code>dockable</code> argument
if the docking operation results in a split layout.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the docking operation was successful;
<code>false</code> otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/flexdock/docking/DockingManager.html#isValidDockingRegion(java.lang.String)"><code>DockingManager.isValidDockingRegion(String)</code></a>,
<a href="../../../org/flexdock/docking/Dockable.html#getDockingPort()"><code>Dockable.getDockingPort()</code></a>,
<a href="../../../org/flexdock/docking/DockingManager.html#dock(org.flexdock.docking.Dockable, org.flexdock.docking.DockingPort, java.lang.String)"><code>DockingManager.dock(Dockable, DockingPort, String)</code></a></dd></dl>
</li>
</ul>
<a name="isFloating(org.flexdock.docking.Dockable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFloating</h4>
<pre>public static boolean isFloating(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable)</pre>
<div class="block">Returns <code>true</code> if the specified <code>Dockable</code> is currently
docked within a floating dialog. This method returns <code>false</code> if the
<code>Dockable</code> is presently, minimized, hidden, docked within the main
application layout, or if the <code>Dockable</code> parameter is <code>null</code>.
<p>
This method retrieves the current <code>DockingState</code> instance
associated with the <code>Dockable</code> and calls it's <code>isFloating()</code>
method to return. <code>DockingState</code> for the specified <code>Dockable</code>
is queried by calling <code>getDockingState(Dockable dockable)</code> on the
<code>DockingManager's</code> currently installed <code>LayoutManager</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dockable</code> - the <code>Dockable</code> whose floating state is to be returned</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the specified <code>Dockable</code> is currently
floating; <code>false</code> otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/flexdock/docking/state/DockingState.html#isFloating()"><code>DockingState.isFloating()</code></a>,
<a href="../../../org/flexdock/docking/DockingManager.html#getLayoutManager()"><code>DockingManager.getLayoutManager()</code></a>,
<a href="../../../org/flexdock/docking/state/LayoutManager.html#getDockingState(org.flexdock.docking.Dockable)"><code>LayoutManager.getDockingState(Dockable)</code></a></dd></dl>
</li>
</ul>
<a name="isEmbedded(org.flexdock.docking.Dockable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmbedded</h4>
<pre>public static boolean isEmbedded(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable)</pre>
<div class="block">Returns <code>true</code> if the specified <code>Dockable</code> is currently
docked within a <code>DockingPort</code>. This method returns <code>false</code>
if the <code>Dockable</code> is presently floating, minimized, hidden, or if
the <code>Dockable</code> parameter is <code>null</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dockable</code> - the <code>Dockable</code> whose embedded state is to be returned</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the specified <code>Dockable</code> is currently
docked within a <code>DockingPort</code>; <code>false</code> otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/flexdock/docking/DockingManager.html#isDocked(org.flexdock.docking.Dockable)"><code>DockingManager.isDocked(Dockable)</code></a>,
<a href="../../../org/flexdock/util/DockingUtility.html#isFloating(org.flexdock.docking.Dockable)"><code>isFloating(Dockable)</code></a></dd></dl>
</li>
</ul>
<a name="setSplitProportion(org.flexdock.docking.DockingPort, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSplitProportion</h4>
<pre>public static void setSplitProportion(<a href="../../../org/flexdock/docking/DockingPort.html" title="interface in org.flexdock.docking">DockingPort</a> port,
float proportion)</pre>
<div class="block">Sets the divider location of the split layout embedded within the
specified <code>DockingPort</code>. This method differs from both
<code>setSplitProportion(Dockable dockable, float proportion)</code> in that
this method resolves the split layout embedded <b>within</b> the
specified <code>DockingPort</code>, whereas the other method modifies the
split layout <b>containing</b> its respective <code>Dockable</code>
parameter.
<p>
The resulting divider location will be a percentage of the split layout
size based upon the <code>proportion</code> parameter. Valid values for
<code>proportion</code> range from <code>0.0F{@code to {@code 1.0F}. For
example, a {@code proportion} of {@code 0.3F} will move the divider to
30% of the "size" (<i>width</i> for horizontal split, <i>height</i>
for vertical split) of the split container embedded within the specified
{@code DockingPort}. If a {@code proportion} of less than {@code 0.0F}
is supplied, the value }0.0F</code> is used. If a <code>proportion</code> greater
than <code>1.0F</code> is supplied, the value }1.0F} is used.
<p>
This method should be effective regardless of whether the split layout in
question has been fully realized and is currently visible on the screen.
This should alleviate common problems associated with setting percentages
of unrealized <code>Component</code> dimensions, which are initially
<code>0x0</code> before the <code>Component</code> has been rendered to the screen.
<p>
If the specified <code>DockingPort</code> is <code>null</code>, then no
<code>Exception</code> is thrown and no action is taken. Identical behavior
occurs if the <code>DockingPort</code> does not contain split layout.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>port</code> - the <code>DockingPort</code> containing the split layout is to be
resized.</dd><dd><code>proportion</code> - the percentage of split layout size to which the split divider
should be set.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/flexdock/util/SwingUtility.html#setSplitDivider(javax.swing.JSplitPane, float)"><code>SwingUtility.setSplitDivider(JSplitPane, float)</code></a></dd></dl>
</li>
</ul>
<a name="setSplitProportion(org.flexdock.docking.Dockable, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSplitProportion</h4>
<pre>public static void setSplitProportion(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable,
float proportion)</pre>
<div class="block">Sets the divider location of the split layout containing the specified
dockable <code>Component</code>.
<p>
The resulting divider location will be a percentage of the split layout
size based upon the <code>proportion</code> parameter. Valid values for
<code>proportion</code> range from <code>0.0F{@code to {@code 1.0F}. For
example, a {@code proportion} of {@code 0.3F} will move the divider to
30% of the "size" (<i>width</i> for horizontal split, <i>height</i>
for vertical split) of the split container that contains the specified
{@code Dockable}. If a {@code proportion} of less than {@code 0.0F} is
supplied, the value }0.0F</code> is used. If a <code>proportion</code> greater than
<code>1.0F</code> is supplied, the value }1.0F} is used.
<p>
It is important to note that the split divider location is only a
percentage of the container size from left to right or top to bottom. A
<code>proportion</code> of <code>0.3F</code> does not imply that <code>dockable</code>
itself will be allotted 30% of the available space. The split divider
will be moved to the 30% position of the split container regardless of
the region in which the specified <code>Dockable</code> resides (which may
possibly result in <code>dockable</code> being allotted 70% of the available
space).
<p>
This method should be effective regardless of whether the split layout in
question has been fully realized and is currently visible on the screen.
This should alleviate common problems associated with setting percentages
of unrealized <code>Component</code> dimensions, which are initially
<code>0x0</code> before the <code>Component</code> has been rendered to the screen.
<p>
If the specified <code>Dockable</code> is <code>null</code>, then no
<code>Exception</code> is thrown and no action is taken. Identical behavior
occurs if the <code>Dockable</code> does not reside within a split layout.
<p>
If the <code>Dockable</code> resides within a tabbed layout, a check is done
to see if the tabbed layout resides within a parent split layout. If so,
the resolved split layout is resized. Otherwise no action is taken.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dockable</code> - the <code>Dockable</code> whose containing split layout is to be
resized.</dd><dd><code>proportion</code> - the percentage of containing split layout size to which the
split divider should be set.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/flexdock/util/SwingUtility.html#setSplitDivider(javax.swing.JSplitPane, float)"><code>SwingUtility.setSplitDivider(JSplitPane, float)</code></a></dd></dl>
</li>
</ul>
<a name="getTabText(org.flexdock.docking.Dockable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTabText</h4>
<pre>public static java.lang.String getTabText(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable)</pre>
<div class="block">Returns the text to be used by a <code>Dockable</code> as a tab label within a
tabbed layout. This method retrieves the associated
<code>DockablePropertySet</code> by calling <code>getDockingProperties()</code> on
the specified <code>Dockable</code>. It then returns the value retrieved from
calling <code>getDockableDesc()</code> on the <code>DockablePropertySet</code>
instance. If the specified <code>Dockable</code> is <code>null</code>, then this
method returns <code>null</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dockable</code> - the <code>Dockable</code> whose tab-text is to be returned</dd>
<dt><span class="strong">Returns:</span></dt><dd>the text to be used by a <code>Dockable</code> as a tab label within a
tabbed layout.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/flexdock/docking/Dockable.html#getDockingProperties()"><code>Dockable.getDockingProperties()</code></a>,
<a href="../../../org/flexdock/docking/props/DockablePropertySet.html#getDockableDesc()"><code>DockablePropertySet.getDockableDesc()</code></a></dd></dl>
</li>
</ul>
<a name="isDockable(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDockable</h4>
<pre>public static boolean isDockable(java.lang.Object obj)</pre>
<div class="block">Returns <code>true</code> if the specific <code>Object</code> is a <code>Dockable</code>.
If <code>obj instanceof Dockable</code> is <code>true</code>, then this method
returns <code>true</code>. A <code>null</code> parameter will cause this method to
return <code>false</code>.
<p>
Registered <code>Dockable</code> components, if they are <code>JComponents</code>,
will also have a <code>Boolean</code> client property present with the key
<code>Dockable.DOCKABLE_INDICATOR</code>, used by dockable
<code>JComponents</code> that don't implement the <code>Dockable</code> interface
directly, but acquire docking capabilities through a separate wrapper
<code>Dockable</code> implementation. For these components, the
<code>instanceof</code> check is insufficient since the valid <code>Dockable</code>
is implemented by a separate class. Therefore, if the <code>instanceof</code>
check fails, and the supplied <code>Object</code> parameter is a
<code>JComponent</code>, a client property with the key
<code>Dockable.DOCKABLE_INDICATOR</code> is checked for a value of
<code>Boolean.TRUE</code>. If the client property is present, then this
method returns <code>true</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - the <code>Object</code> to be checked to see if it represents a
valid <code>Dockable</code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the specific <code>Object</code> is a <code>Dockable</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/flexdock/docking/Dockable.html#DOCKABLE_INDICATOR"><code>Dockable.DOCKABLE_INDICATOR</code></a>,
<code>Boolean.TRUE</code>,
<code>JComponent.getClientProperty(java.lang.Object)</code></dd></dl>
</li>
</ul>
<a name="getAncestorDockable(java.awt.Component)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAncestorDockable</h4>
<pre>public static <a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> getAncestorDockable(java.awt.Component comp)</pre>
</li>
</ul>
<a name="isActive(org.flexdock.docking.Dockable)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isActive</h4>
<pre>public static boolean isActive(<a href="../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable)</pre>
</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="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.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/flexdock/util/ClassMapping.html" title="class in org.flexdock.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/flexdock/util/LookAndFeelSettings.html" title="class in org.flexdock.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/flexdock/util/DockingUtility.html" target="_top">Frames</a></li>
<li><a href="DockingUtility.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>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|