/usr/share/doc/libflexdock-java-doc/api/org/flexdock/docking/defaults/AbstractDockable.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 | <!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:32 UTC 2013 -->
<title>AbstractDockable</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="AbstractDockable";
}
//-->
</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>Prev Class</li>
<li><a href="../../../../org/flexdock/docking/defaults/BorderManager.html" title="interface in org.flexdock.docking.defaults"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/flexdock/docking/defaults/AbstractDockable.html" target="_top">Frames</a></li>
<li><a href="AbstractDockable.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </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.flexdock.docking.defaults</div>
<h2 title="Class AbstractDockable" class="title">Class AbstractDockable</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.flexdock.docking.defaults.AbstractDockable</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.util.EventListener, <a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a>, <a href="../../../../org/flexdock/docking/event/DockingListener.html" title="interface in org.flexdock.docking.event">DockingListener</a>, <a href="../../../../org/flexdock/docking/event/DockingMonitor.html" title="interface in org.flexdock.docking.event">DockingMonitor</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">AbstractDockable</span>
extends java.lang.Object
implements <a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a></pre>
<div class="block">Provides a default implementation of the <code>Dockable</code> interface. This
class should be extended by any application that wishes to make use of the
<code>Dockable</code> interface without the need for writing out an implementation
for every method that isn't explicitly used.</div>
<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">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_org.flexdock.docking.event.DockingListener">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface org.flexdock.docking.event.<a href="../../../../org/flexdock/docking/event/DockingListener.html" title="interface in org.flexdock.docking.event">DockingListener</a></h3>
<code><a href="../../../../org/flexdock/docking/event/DockingListener.Stub.html" title="class in org.flexdock.docking.event">DockingListener.Stub</a></code></li>
</ul>
</li>
</ul>
<!-- =========== 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.Dockable">
<!-- -->
</a>
<h3>Fields inherited from interface org.flexdock.docking.<a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a></h3>
<code><a href="../../../../org/flexdock/docking/Dockable.html#DOCKABLE_INDICATOR">DOCKABLE_INDICATOR</a></code></li>
</ul>
</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/flexdock/docking/defaults/AbstractDockable.html#AbstractDockable(java.lang.String)">AbstractDockable</a></strong>(java.lang.String id)</code>
<div class="block">Creates a new <code>AbstractDockable</code> instance.</div>
</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#addDockingListener(org.flexdock.docking.event.DockingListener)">addDockingListener</a></strong>(<a href="../../../../org/flexdock/docking/event/DockingListener.html" title="interface in org.flexdock.docking.event">DockingListener</a> listener)</code>
<div class="block">Adds a <code>DockingListener</code> to observe docking events for this
<code>Dockable</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#addPropertyChangeListener(java.beans.PropertyChangeListener)">addPropertyChangeListener</a></strong>(java.beans.PropertyChangeListener listener)</code>
<div class="block">Adds a PropertyChangeListener to the listener list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#dock(org.flexdock.docking.Dockable)">dock</a></strong>(<a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable)</code>
<div class="block">Provides the default <code>Dockable</code> implementation of
<code>dock(Dockable dockable)</code> by calling and returning
<code>DockingManager.dock(Dockable dockable, Dockable parent)</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#dock(org.flexdock.docking.Dockable, java.lang.String)">dock</a></strong>(<a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable,
java.lang.String relativeRegion)</code>
<div class="block">Provides the default <code>Dockable</code> implementation of
<code>dock(Dockable dockable, String relativeRegion)</code> by calling and
returning
<code>DockingManager.dock(Dockable dockable, Dockable parent, String region)</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#dock(org.flexdock.docking.Dockable, java.lang.String, float)">dock</a></strong>(<a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable,
java.lang.String relativeRegion,
float ratio)</code>
<div class="block">Provides the default <code>Dockable</code> implementation of
<code>dock(Dockable dockable, String relativeRegion, float ratio)</code> by
calling and returning
<code>DockingManager.dock(Dockable dockable, Dockable parent, String region, float proportion)</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#dockingCanceled(org.flexdock.docking.event.DockingEvent)">dockingCanceled</a></strong>(<a href="../../../../org/flexdock/docking/event/DockingEvent.html" title="class in org.flexdock.docking.event">DockingEvent</a> evt)</code>
<div class="block">No operation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#dockingComplete(org.flexdock.docking.event.DockingEvent)">dockingComplete</a></strong>(<a href="../../../../org/flexdock/docking/event/DockingEvent.html" title="class in org.flexdock.docking.event">DockingEvent</a> evt)</code>
<div class="block">No operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#dragStarted(org.flexdock.docking.event.DockingEvent)">dragStarted</a></strong>(<a href="../../../../org/flexdock/docking/event/DockingEvent.html" title="class in org.flexdock.docking.event">DockingEvent</a> evt)</code>
<div class="block">No operation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#dropStarted(org.flexdock.docking.event.DockingEvent)">dropStarted</a></strong>(<a href="../../../../org/flexdock/docking/event/DockingEvent.html" title="class in org.flexdock.docking.event">DockingEvent</a> evt)</code>
<div class="block">No operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#getClientProperty(java.lang.Object)">getClientProperty</a></strong>(java.lang.Object key)</code>
<div class="block">Returns the value of the property with the specified key.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract java.awt.Component</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#getComponent()">getComponent</a></strong>()</code>
<div class="block">Returns the <code>Component</code> used to back this <code>Dockable</code>
instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/flexdock/docking/event/DockingListener.html" title="interface in org.flexdock.docking.event">DockingListener</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#getDockingListeners()">getDockingListeners</a></strong>()</code>
<div class="block">Returns an array of all <code>DockingListeners</code> added to this
<code>Dockable</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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/docking/defaults/AbstractDockable.html#getDockingPort()">getDockingPort</a></strong>()</code>
<div class="block">Returns the <code>DockingPort</code> within which this <code>Dockable</code> is
currently docked.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/flexdock/docking/props/DockablePropertySet.html" title="interface in org.flexdock.docking.props">DockablePropertySet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#getDockingProperties()">getDockingProperties</a></strong>()</code>
<div class="block">Returns a <code>DockablePropertySet</code> instance associated with this
<code>Dockable</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#getDragSources()">getDragSources</a></strong>()</code>
<div class="block">Returns a <code>List</code> of <code>Components</code> used to initiate
drag-to-dock operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Set</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#getFrameDragSources()">getFrameDragSources</a></strong>()</code>
<div class="block">Returns a <code>HashSet</code> of <code>Components</code> used as frame drag
sources when this <code>Dockable</code> is floating in a non-decorated
external dialog.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#getPersistentId()">getPersistentId</a></strong>()</code>
<div class="block">Returns the persistent ID of this <code>Dockable</code> instance provided when
this object was instantiated.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#getTabText()">getTabText</a></strong>()</code>
<div class="block">Returns the <code>String</code> used for tab labels when this <code>Dockable</code>
is embedded within a tabbed layout.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#putClientProperty(java.lang.Object, java.lang.Object)">putClientProperty</a></strong>(java.lang.Object key,
java.lang.Object value)</code>
<div class="block">Adds an arbitrary key/value "client property" to this <code>Dockable</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#removeDockingListener(org.flexdock.docking.event.DockingListener)">removeDockingListener</a></strong>(<a href="../../../../org/flexdock/docking/event/DockingListener.html" title="interface in org.flexdock.docking.event">DockingListener</a> listener)</code>
<div class="block">Removes the specified <code>DockingListener</code> from this <code>Dockable</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#removePropertyChangeListener(java.beans.PropertyChangeListener)">removePropertyChangeListener</a></strong>(java.beans.PropertyChangeListener listener)</code>
<div class="block">Removes a PropertyChangeListener from the listener list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#setTabText(java.lang.String)">setTabText</a></strong>(java.lang.String tabText)</code>
<div class="block">Sets the <code>String</code> to be used for tab labels when this
<code>Dockable</code> is embedded within a tabbed layout.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#undockingComplete(org.flexdock.docking.event.DockingEvent)">undockingComplete</a></strong>(<a href="../../../../org/flexdock/docking/event/DockingEvent.html" title="class in org.flexdock.docking.event">DockingEvent</a> evt)</code>
<div class="block">No operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#undockingStarted(org.flexdock.docking.event.DockingEvent)">undockingStarted</a></strong>(<a href="../../../../org/flexdock/docking/event/DockingEvent.html" title="class in org.flexdock.docking.event">DockingEvent</a> evt)</code>
<div class="block">No operation.</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractDockable(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractDockable</h4>
<pre>public AbstractDockable(java.lang.String id)</pre>
<div class="block">Creates a new <code>AbstractDockable</code> instance. This constructor is
meant to be invoked by subclasses as it initializes the
<code>Dockable's</code> persistent ID and drag sources.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - the persistent ID of the resulting <code>Dockable</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/Dockable.html#getPersistentId()"><code>Dockable.getPersistentId()</code></a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getComponent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComponent</h4>
<pre>public abstract java.awt.Component getComponent()</pre>
<div class="block">Returns the <code>Component</code> used to back this <code>Dockable</code>
instance.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/Dockable.html#getComponent()">getComponent</a></code> in interface <code><a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the <code>Component</code> used to back this <code>Dockable</code>
instance.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/Dockable.html#getComponent()"><code>Dockable.getComponent()</code></a></dd></dl>
</li>
</ul>
<a name="getDragSources()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDragSources</h4>
<pre>public java.util.List getDragSources()</pre>
<div class="block">Returns a <code>List</code> of <code>Components</code> used to initiate
drag-to-dock operation. By default, the returned <code>List</code> contains
the <code>Component</code> returned by <code>getComponent()</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/Dockable.html#getDragSources()">getDragSources</a></code> in interface <code><a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>List</code> of <code>Components</code> used to initiate
drag-to-dock operation.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/Dockable.html#getDragSources()"><code>Dockable.getDragSources()</code></a>,
<a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#getComponent()"><code>getComponent()</code></a></dd></dl>
</li>
</ul>
<a name="getPersistentId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPersistentId</h4>
<pre>public java.lang.String getPersistentId()</pre>
<div class="block">Returns the persistent ID of this <code>Dockable</code> instance provided when
this object was instantiated.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/Dockable.html#getPersistentId()">getPersistentId</a></code> in interface <code><a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the persistent ID of this <code>Dockable</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/Dockable.html#getPersistentId()"><code>Dockable.getPersistentId()</code></a>,
<a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#AbstractDockable(java.lang.String)"><code>AbstractDockable(String)</code></a></dd></dl>
</li>
</ul>
<a name="getFrameDragSources()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFrameDragSources</h4>
<pre>public java.util.Set getFrameDragSources()</pre>
<div class="block">Returns a <code>HashSet</code> of <code>Components</code> used as frame drag
sources when this <code>Dockable</code> is floating in a non-decorated
external dialog. The <code>HashSet</code> returned by this method is initially
empty. Because it is mutable, however, new <code>Components</code> may be
added to it.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/Dockable.html#getFrameDragSources()">getFrameDragSources</a></code> in interface <code><a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>HashSet</code> of <code>Components</code> used as frame drag
sources when this <code>Dockable</code> is floating in a non-decorated
external dialog.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/Dockable.html#getFrameDragSources()"><code>Dockable.getFrameDragSources()</code></a></dd></dl>
</li>
</ul>
<a name="setTabText(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTabText</h4>
<pre>public void setTabText(java.lang.String tabText)</pre>
<div class="block">Sets the <code>String</code> to be used for tab labels when this
<code>Dockable</code> is embedded within a tabbed layout. <code>null</code> values
are discouraged, but not illegal.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tabText</code> - the <code>String</code> to be used for tab labels when this
<code>Dockable</code> is embedded within a tabbed layout.</dd></dl>
</li>
</ul>
<a name="getTabText()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTabText</h4>
<pre>public java.lang.String getTabText()</pre>
<div class="block">Returns the <code>String</code> used for tab labels when this <code>Dockable</code>
is embedded within a tabbed layout. It is possible for this method to
return a <code>null</code> reference.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>tabText the <code>String</code> used for tab labels when this
<code>Dockable</code> is embedded within a tabbed layout.</dd></dl>
</li>
</ul>
<a name="dockingCanceled(org.flexdock.docking.event.DockingEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dockingCanceled</h4>
<pre>public void dockingCanceled(<a href="../../../../org/flexdock/docking/event/DockingEvent.html" title="class in org.flexdock.docking.event">DockingEvent</a> evt)</pre>
<div class="block">No operation. Provided as a method stub to fulfull the
<code>DockingListener</code> interface contract.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/event/DockingListener.html#dockingCanceled(org.flexdock.docking.event.DockingEvent)">dockingCanceled</a></code> in interface <code><a href="../../../../org/flexdock/docking/event/DockingListener.html" title="interface in org.flexdock.docking.event">DockingListener</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>evt</code> - the <code>DockingEvent</code> to respond to.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/event/DockingListener.html#dockingCanceled(org.flexdock.docking.event.DockingEvent)"><code>DockingListener.dockingCanceled(DockingEvent)</code></a></dd></dl>
</li>
</ul>
<a name="dockingComplete(org.flexdock.docking.event.DockingEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dockingComplete</h4>
<pre>public void dockingComplete(<a href="../../../../org/flexdock/docking/event/DockingEvent.html" title="class in org.flexdock.docking.event">DockingEvent</a> evt)</pre>
<div class="block">No operation. Provided as a method stub to fulfull the
<code>DockingListener</code> interface contract.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/event/DockingListener.html#dockingComplete(org.flexdock.docking.event.DockingEvent)">dockingComplete</a></code> in interface <code><a href="../../../../org/flexdock/docking/event/DockingListener.html" title="interface in org.flexdock.docking.event">DockingListener</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>evt</code> - the <code>DockingEvent</code> to respond to.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/event/DockingListener.html#dockingComplete(org.flexdock.docking.event.DockingEvent)"><code>DockingListener.dockingComplete(DockingEvent)</code></a></dd></dl>
</li>
</ul>
<a name="dragStarted(org.flexdock.docking.event.DockingEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dragStarted</h4>
<pre>public void dragStarted(<a href="../../../../org/flexdock/docking/event/DockingEvent.html" title="class in org.flexdock.docking.event">DockingEvent</a> evt)</pre>
<div class="block">No operation. Provided as a method stub to fulfull the
<code>DockingListener</code> interface contract.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/event/DockingListener.html#dragStarted(org.flexdock.docking.event.DockingEvent)">dragStarted</a></code> in interface <code><a href="../../../../org/flexdock/docking/event/DockingListener.html" title="interface in org.flexdock.docking.event">DockingListener</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>evt</code> - the <code>DockingEvent</code> to respond to.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/event/DockingListener.html#dragStarted(org.flexdock.docking.event.DockingEvent)"><code>DockingListener.dragStarted(DockingEvent)</code></a></dd></dl>
</li>
</ul>
<a name="dropStarted(org.flexdock.docking.event.DockingEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dropStarted</h4>
<pre>public void dropStarted(<a href="../../../../org/flexdock/docking/event/DockingEvent.html" title="class in org.flexdock.docking.event">DockingEvent</a> evt)</pre>
<div class="block">No operation. Provided as a method stub to fulfull the
<code>DockingListener</code> interface contract.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/event/DockingListener.html#dropStarted(org.flexdock.docking.event.DockingEvent)">dropStarted</a></code> in interface <code><a href="../../../../org/flexdock/docking/event/DockingListener.html" title="interface in org.flexdock.docking.event">DockingListener</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>evt</code> - the <code>DockingEvent</code> to respond to.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/event/DockingListener.html#dropStarted(org.flexdock.docking.event.DockingEvent)"><code>DockingListener.dropStarted(DockingEvent)</code></a></dd></dl>
</li>
</ul>
<a name="undockingComplete(org.flexdock.docking.event.DockingEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>undockingComplete</h4>
<pre>public void undockingComplete(<a href="../../../../org/flexdock/docking/event/DockingEvent.html" title="class in org.flexdock.docking.event">DockingEvent</a> evt)</pre>
<div class="block">No operation. Provided as a method stub to fulfull the
<code>DockingListener</code> interface contract.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/event/DockingListener.html#undockingComplete(org.flexdock.docking.event.DockingEvent)">undockingComplete</a></code> in interface <code><a href="../../../../org/flexdock/docking/event/DockingListener.html" title="interface in org.flexdock.docking.event">DockingListener</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>evt</code> - the <code>DockingEvent</code> to respond to.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/event/DockingListener.html#undockingComplete(org.flexdock.docking.event.DockingEvent)"><code>DockingListener.undockingComplete(DockingEvent)</code></a></dd></dl>
</li>
</ul>
<a name="undockingStarted(org.flexdock.docking.event.DockingEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>undockingStarted</h4>
<pre>public void undockingStarted(<a href="../../../../org/flexdock/docking/event/DockingEvent.html" title="class in org.flexdock.docking.event">DockingEvent</a> evt)</pre>
<div class="block">No operation. Provided as a method stub to fulfull the
<code>DockingListener</code> interface contract.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/event/DockingListener.html#undockingStarted(org.flexdock.docking.event.DockingEvent)">undockingStarted</a></code> in interface <code><a href="../../../../org/flexdock/docking/event/DockingListener.html" title="interface in org.flexdock.docking.event">DockingListener</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>evt</code> - the <code>DockingEvent</code> to respond to.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/event/DockingListener.html#undockingStarted(org.flexdock.docking.event.DockingEvent)"><code>DockingListener.undockingStarted(DockingEvent)</code></a></dd></dl>
</li>
</ul>
<a name="addDockingListener(org.flexdock.docking.event.DockingListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addDockingListener</h4>
<pre>public void addDockingListener(<a href="../../../../org/flexdock/docking/event/DockingListener.html" title="interface in org.flexdock.docking.event">DockingListener</a> listener)</pre>
<div class="block">Adds a <code>DockingListener</code> to observe docking events for this
<code>Dockable</code>. <code>null</code> arguments are ignored.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/event/DockingMonitor.html#addDockingListener(org.flexdock.docking.event.DockingListener)">addDockingListener</a></code> in interface <code><a href="../../../../org/flexdock/docking/event/DockingMonitor.html" title="interface in org.flexdock.docking.event">DockingMonitor</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the <code>DockingListener</code> to add to this <code>Dockable</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#getDockingListeners()"><code>getDockingListeners()</code></a>,
<a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#removeDockingListener(org.flexdock.docking.event.DockingListener)"><code>removeDockingListener(DockingListener)</code></a></dd></dl>
</li>
</ul>
<a name="getDockingListeners()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDockingListeners</h4>
<pre>public <a href="../../../../org/flexdock/docking/event/DockingListener.html" title="interface in org.flexdock.docking.event">DockingListener</a>[] getDockingListeners()</pre>
<div class="block">Returns an array of all <code>DockingListeners</code> added to this
<code>Dockable</code>. If there are no listeners present for this
<code>Dockable</code>, then a zero-length array is returned.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/event/DockingMonitor.html#getDockingListeners()">getDockingListeners</a></code> in interface <code><a href="../../../../org/flexdock/docking/event/DockingMonitor.html" title="interface in org.flexdock.docking.event">DockingMonitor</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an array of all <code>DockingListeners</code> added to this
<code>Dockable</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#addDockingListener(org.flexdock.docking.event.DockingListener)"><code>addDockingListener(DockingListener)</code></a>,
<a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#removeDockingListener(org.flexdock.docking.event.DockingListener)"><code>removeDockingListener(DockingListener)</code></a></dd></dl>
</li>
</ul>
<a name="removeDockingListener(org.flexdock.docking.event.DockingListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeDockingListener</h4>
<pre>public void removeDockingListener(<a href="../../../../org/flexdock/docking/event/DockingListener.html" title="interface in org.flexdock.docking.event">DockingListener</a> listener)</pre>
<div class="block">Removes the specified <code>DockingListener</code> from this <code>Dockable</code>.
If the specified <code>DockingListener</code> is <code>null</code>, or the
listener has not previously been added to this <code>Dockable</code>, then no
<code>Exception</code> is thrown and no action is taken.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/event/DockingMonitor.html#removeDockingListener(org.flexdock.docking.event.DockingListener)">removeDockingListener</a></code> in interface <code><a href="../../../../org/flexdock/docking/event/DockingMonitor.html" title="interface in org.flexdock.docking.event">DockingMonitor</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the <code>DockingListener</code> to remove from this
<code>Dockable</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#addDockingListener(org.flexdock.docking.event.DockingListener)"><code>addDockingListener(DockingListener)</code></a>,
<a href="../../../../org/flexdock/docking/defaults/AbstractDockable.html#getDockingListeners()"><code>getDockingListeners()</code></a></dd></dl>
</li>
</ul>
<a name="getClientProperty(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientProperty</h4>
<pre>public java.lang.Object getClientProperty(java.lang.Object key)</pre>
<div class="block">Returns the value of the property with the specified key. Only properties
added with <code>putClientProperty</code> will return a non-<code>null</code>
value. If <code>key</code> is <code>null</code>, a <code>null</code> reference is
returned.
<p>
If the <code>Component</code> returned by <code>getComponent()</code> is an
instance of <code>JComponent</code>, then this method will dispatch to that
<code>JComponent's</code> <code>getClientProperty(Object, Object)</code> method.
Otherwise, this <code>Dockable</code> will provide its own internal mapping of
client properties.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/Dockable.html#getClientProperty(java.lang.Object)">getClientProperty</a></code> in interface <code><a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key that is being queried</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of this property or <code>null</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/Dockable.html#getClientProperty(java.lang.Object)"><code>Dockable.getClientProperty(Object)</code></a>,
<code>JComponent.getClientProperty(java.lang.Object)</code></dd></dl>
</li>
</ul>
<a name="putClientProperty(java.lang.Object, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putClientProperty</h4>
<pre>public void putClientProperty(java.lang.Object key,
java.lang.Object value)</pre>
<div class="block">Adds an arbitrary key/value "client property" to this <code>Dockable</code>.
<code>null</code> values are allowed. If <code>key</code> is <code>null</code>, then no
action is taken.
<p>
If the <code>Component</code> returned by <code>getComponent()</code> is an
instance of <code>JComponent</code>, then this method will dispatch to that
<code>JComponent's</code> <code>putClientProperty(Object, Object)</code> method.
Otherwise, this <code>Dockable</code> will provide its own internal mapping of
client properties.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/Dockable.html#putClientProperty(java.lang.Object, java.lang.Object)">putClientProperty</a></code> in interface <code><a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the new client property key</dd><dd><code>value</code> - the new client property value; if <code>null</code> this method
will remove the property</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/Dockable.html#putClientProperty(java.lang.Object, java.lang.Object)"><code>Dockable.putClientProperty(Object, Object)</code></a>,
<code>JComponent.putClientProperty(java.lang.Object,
java.lang.Object)</code></dd></dl>
</li>
</ul>
<a name="getDockingProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDockingProperties</h4>
<pre>public <a href="../../../../org/flexdock/docking/props/DockablePropertySet.html" title="interface in org.flexdock.docking.props">DockablePropertySet</a> getDockingProperties()</pre>
<div class="block">Returns a <code>DockablePropertySet</code> instance associated with this
<code>Dockable</code>. This method returns the default implementation
supplied by the framework by invoking
<code>getDockablePropertySet(Dockable dockable)</code> on
<code>org.flexdock.docking.props.PropertyManager</code> and supplying an
argument of <code>this</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/Dockable.html#getDockingProperties()">getDockingProperties</a></code> in interface <code><a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the <code>DockablePropertySet</code> associated with this
<code>Dockable</code>. This method will not return a <code>null</code>
reference.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/props/DockablePropertySet.html" title="interface in org.flexdock.docking.props"><code>DockablePropertySet</code></a>,
<a href="../../../../org/flexdock/docking/Dockable.html#getDockingProperties()"><code>Dockable.getDockingProperties()</code></a>,
<a href="../../../../org/flexdock/docking/props/PropertyManager.html#getDockablePropertySet(org.flexdock.docking.Dockable)"><code>PropertyManager.getDockablePropertySet(Dockable)</code></a></dd></dl>
</li>
</ul>
<a name="getDockingPort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDockingPort</h4>
<pre>public <a href="../../../../org/flexdock/docking/DockingPort.html" title="interface in org.flexdock.docking">DockingPort</a> getDockingPort()</pre>
<div class="block">Returns the <code>DockingPort</code> within which this <code>Dockable</code> is
currently docked. If not currently docked, this method will return
<code>null</code>.
<p>
This method defers processing to
<code>getDockingPort(Dockable dockable)</code>, passing an argument of
<code>this</code>. This <code>DockingPort</code> returned is based upon the
<code>Component</code> returned by this <code>Dockable's</code> abstract
<code>getComponent()</code> method.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/Dockable.html#getDockingPort()">getDockingPort</a></code> in interface <code><a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the <code>DockingPort</code> within which this <code>Dockable</code> is
currently docked.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/Dockable.html#getDockingPort()"><code>Dockable.getDockingPort()</code></a>,
<a href="../../../../org/flexdock/docking/DockingManager.html#getDockingPort(org.flexdock.docking.Dockable)"><code>DockingManager.getDockingPort(Dockable)</code></a></dd></dl>
</li>
</ul>
<a name="dock(org.flexdock.docking.Dockable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dock</h4>
<pre>public boolean dock(<a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable)</pre>
<div class="block">Provides the default <code>Dockable</code> implementation of
<code>dock(Dockable dockable)</code> by calling and returning
<code>DockingManager.dock(Dockable dockable, Dockable parent)</code>.
<code>'this'</code> is passed as the <code>parent</code> parameter.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/Dockable.html#dock(org.flexdock.docking.Dockable)">dock</a></code> in interface <code><a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>dockable</code> - the <code>Dockable</code> to dock relative to this <code>Dockable</code></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/Dockable.html#dock(org.flexdock.docking.Dockable)"><code>Dockable.dock(Dockable)</code></a>,
<a href="../../../../org/flexdock/docking/DockingManager.html#dock(org.flexdock.docking.Dockable, org.flexdock.docking.Dockable)"><code>DockingManager.dock(Dockable, Dockable)</code></a></dd></dl>
</li>
</ul>
<a name="dock(org.flexdock.docking.Dockable, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dock</h4>
<pre>public boolean dock(<a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable,
java.lang.String relativeRegion)</pre>
<div class="block">Provides the default <code>Dockable</code> implementation of
<code>dock(Dockable dockable, String relativeRegion)</code> by calling and
returning
<code>DockingManager.dock(Dockable dockable, Dockable parent, String region)</code>.
<code>'this'</code> is passed as the <code>parent</code> parameter.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/Dockable.html#dock(org.flexdock.docking.Dockable, java.lang.String)">dock</a></code> in interface <code><a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>dockable</code> - the <code>Dockable</code> to dock relative to this <code>Dockable</code></dd><dd><code>relativeRegion</code> - the docking region into which to dock the specified
<code>Dockable</code></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/Dockable.html#dock(org.flexdock.docking.Dockable, java.lang.String)"><code>Dockable.dock(Dockable, String)</code></a>,
<a href="../../../../org/flexdock/docking/DockingManager.html#dock(org.flexdock.docking.Dockable, org.flexdock.docking.Dockable, java.lang.String)"><code>DockingManager.dock(Dockable, Dockable, String)</code></a></dd></dl>
</li>
</ul>
<a name="dock(org.flexdock.docking.Dockable, java.lang.String, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dock</h4>
<pre>public boolean dock(<a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a> dockable,
java.lang.String relativeRegion,
float ratio)</pre>
<div class="block">Provides the default <code>Dockable</code> implementation of
<code>dock(Dockable dockable, String relativeRegion, float ratio)</code> by
calling and returning
<code>DockingManager.dock(Dockable dockable, Dockable parent, String region, float proportion)</code>.
<code>'this'</code> is passed as the <code>parent</code> parameter.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/Dockable.html#dock(org.flexdock.docking.Dockable, java.lang.String, float)">dock</a></code> in interface <code><a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>dockable</code> - the <code>Dockable</code> to dock relative to this <code>Dockable</code></dd><dd><code>relativeRegion</code> - the docking region into which to dock the specified
<code>Dockable</code></dd><dd><code>ratio</code> - the proportion of available space in the resulting layout to
allot to the new sibling <code>Dockable</code>.</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#dock(org.flexdock.docking.Dockable, org.flexdock.docking.Dockable, java.lang.String, float)"><code>DockingManager.dock(Dockable, Dockable, String, float)</code></a></dd></dl>
</li>
</ul>
<a name="addPropertyChangeListener(java.beans.PropertyChangeListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPropertyChangeListener</h4>
<pre>public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/flexdock/docking/Dockable.html#addPropertyChangeListener(java.beans.PropertyChangeListener)">Dockable</a></code></strong></div>
<div class="block">Adds a PropertyChangeListener to the listener list. The listener is
registered for all bound properties of this class. Note that if this
Dockable is inheriting a bound property, then no event will be fired in
response to a change in the inherited property.
<p>
If listener is null, no exception is thrown and no action is performed.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/Dockable.html#addPropertyChangeListener(java.beans.PropertyChangeListener)">addPropertyChangeListener</a></code> in interface <code><a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the PropertyChangeListener to be added</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/Dockable.html#removePropertyChangeListener(java.beans.PropertyChangeListener)"><code>Dockable.removePropertyChangeListener(PropertyChangeListener)</code></a></dd></dl>
</li>
</ul>
<a name="removePropertyChangeListener(java.beans.PropertyChangeListener)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removePropertyChangeListener</h4>
<pre>public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/flexdock/docking/Dockable.html#removePropertyChangeListener(java.beans.PropertyChangeListener)">Dockable</a></code></strong></div>
<div class="block">Removes a PropertyChangeListener from the listener list. This method
should be used to remove PropertyChangeListeners that were registered for
all bound properties of this class.
<p>
If listener is null, no exception is thrown and no action is performed.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/flexdock/docking/Dockable.html#removePropertyChangeListener(java.beans.PropertyChangeListener)">removePropertyChangeListener</a></code> in interface <code><a href="../../../../org/flexdock/docking/Dockable.html" title="interface in org.flexdock.docking">Dockable</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the PropertyChangeListener to be removed</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/flexdock/docking/Dockable.html#addPropertyChangeListener(java.beans.PropertyChangeListener)"><code>Dockable.addPropertyChangeListener(java.beans.PropertyChangeListener)</code></a></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="../../../../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>Prev Class</li>
<li><a href="../../../../org/flexdock/docking/defaults/BorderManager.html" title="interface in org.flexdock.docking.defaults"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/flexdock/docking/defaults/AbstractDockable.html" target="_top">Frames</a></li>
<li><a href="AbstractDockable.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </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>
|