From: Joonas Lehtinen <joonas.lehtinen@itmill.com>
Date: Thu, 14 Jun 2007 11:36:57 +0000 (+0000)
Subject: Documented WidgetFactory
X-Git-Tag: 6.7.0.beta1~6266
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=50b5c3287fd5c3a04b44f60e3710e7e460fbe156;p=vaadin-framework.git

Documented WidgetFactory

svn changeset:1715/svn branch:trunk
---

diff --git a/src/com/itmill/toolkit/terminal/gwt/client/WidgetFactory.java b/src/com/itmill/toolkit/terminal/gwt/client/WidgetFactory.java
index b4a32c4059..72b327df19 100644
--- a/src/com/itmill/toolkit/terminal/gwt/client/WidgetFactory.java
+++ b/src/com/itmill/toolkit/terminal/gwt/client/WidgetFactory.java
@@ -4,8 +4,18 @@ import com.google.gwt.user.client.ui.Widget;
 
 public interface WidgetFactory {
 
+	/** Create an uninitialized component that best matches given UIDL.
+	 * 
+	 * @param uidl UIDL to be painted with returned component.
+	 * @return New uninitialized and unregistered component that can paint given UIDL.
+	 */
 	Widget createWidget(UIDL uidl);
 
+	/** Test if the given component implementation conforms to UIDL.
+	 * 
+	 * @param currentWidget Current implementation of the component
+	 * @param uidl UIDL to test against
+	 * @return true iff createWidget would return a new component of the same class than currentWidget
+	 */
 	boolean isCorrectImplementation(Widget currentWidget, UIDL uidl);
-	
 }