svn commit: r894623 - /wicket/trunk/wicket/src/main/java/org/apache/wicket/util/tester/WicketTester.java

[jd...@apache.org]

Author: jdonnerstag
Date: Wed Dec 30 14:22:56 2009
New Revision: 894623

URL: http://svn.apache.org/viewvc?rev=894623&view=rev
Log:
fixed: WicketTester javadocs are referring in many places to a component's path but it's not documented anywhere
Issue: WICKET-2655

Modified:
    wicket/trunk/wicket/src/main/java/org/apache/wicket/util/tester/WicketTester.java

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/util/tester/WicketTester.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/util/tester/WicketTester.java?rev=894623&r1=894622&r2=894623&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/util/tester/WicketTester.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/util/tester/WicketTester.java Wed Dec 30 14:22:56 2009
@@ -28,6 +28,7 @@
 import junit.framework.AssertionFailedError;
 
 import org.apache.wicket.Component;
+import org.apache.wicket.MarkupContainer;
 import org.apache.wicket.Page;
 import org.apache.wicket.ajax.AjaxRequestTarget;
 import org.apache.wicket.feedback.FeedbackMessage;
@@ -141,6 +142,13 @@
  * reflection. Finally, we use <code>assertInfoMessages</code> to assert there is a feedback message
  * "Wicket Rocks ;-)" at the INFO level.
  * 
+ * Many methods require a 'path' parameter. E.g. the page relative path can be obtained via
+ * {@link Component#getPageRelativePath()}. Since each Component has an ID/name, any Component can
+ * also be referenced by its ID {@link MarkupContainer#get(String)}. And since MarkupContainer's and
+ * its subclasses are containers which allow to add Components (in sync with the markup hierarchy),
+ * you may not only access direct childs but also subchilds like get("myPanel:myForm:myNameField")
+ * separating each ID with a ':'.
+ * 
  * TODO General: Example usage of FormTester
  * 
  * @author Ingram Chen