[Schmitzm-commits] r2183 - trunk/schmitzm-core/src/main/java/de/schmitzm/swing/event

[scm-commit at wald.intevation.org]

Author: mojays
Date: 2012-12-30 17:46:14 +0100 (Sun, 30 Dec 2012)
New Revision: 2183

Modified:
   trunk/schmitzm-core/src/main/java/de/schmitzm/swing/event/DockingListener.java
Log:
JavaDoc

Modified: trunk/schmitzm-core/src/main/java/de/schmitzm/swing/event/DockingListener.java
===================================================================
--- trunk/schmitzm-core/src/main/java/de/schmitzm/swing/event/DockingListener.java	2012-12-30 16:44:14 UTC (rev 2182)
+++ trunk/schmitzm-core/src/main/java/de/schmitzm/swing/event/DockingListener.java	2012-12-30 16:46:14 UTC (rev 2183)
@@ -140,7 +140,9 @@
   
   
   /**
-   * Creates new listener.
+   * Creates new listener with 10px threshold for "magnetic" effect.
+   * {@link #connect()} has to be called explicitly to add this listener as {@link ComponentListener}
+   * to the components.
    * @param mainComp main component whose movement causes movement of docked component
    * @param dockedComp docked component which is moved when main component is moved
    */
@@ -150,6 +152,8 @@
 
   /**
    * Creates new listener.
+   * {@link #connect()} has to be called explicitly to add this listener as {@link ComponentListener}
+   * to the components.
    * @param border threshold (in pixels) for "magnetic effect"
    * @param mainComp main component whose movement causes movement of docked component
    * @param dockedComp docked component which is moved when main component is moved