(no commit message)
[utils] / wicket / components / src / main / java / org / wamblee / wicket / jquery / AbstractJQueryBehavior.java
index 14692bfb8bbd03aed1eaf94a499b6caeaced6667..b1d271346ffe605579333ed8cf7f72bd84cceecc 100644 (file)
@@ -24,11 +24,11 @@ import org.apache.wicket.markup.html.IHeaderResponse;
 import org.wamblee.wicket.behavior.CompositeBehavior;
 
 /**
- * Abstract JQuery hehavior class that performs some useful basic behaviors for
- * the behavior such as:
+ * Abstract JQuery hehavior class that makes it easy to write jQuery behaviors:
  * <ul>
  * <li>Creating a ready function which will be invoked for the component</li>
  * <li>Checking that the component is not a page</li>
+ * <li>Ensuring tha the markup id of the component is output</li>
  * <li>Creating a call to an intialization function from the ready handler using the component id </li>
  * </ul>
  * 
@@ -44,7 +44,8 @@ public class AbstractJQueryBehavior extends CompositeBehavior {
      * Constructs the behavior.
      * 
      * @param aFunction
-     *            Ready function to be invoked.
+     *            Function to be invoked from the ready handler. This function is invoked with a 
+     *            CSS selector that identifies the component.
      * @param aBehaviors
      *            Behaviors to add in addition to the basic JQuery stuff.
      */