From: Mohamed Atique <mohamed.atique@renaissance-it.com>
Date: Fri, 13 Apr 2007 10:31:53 +0000 (+0000)
Subject: Constructors documents changed
X-Git-Tag: 6.7.0.beta1~6447
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=4c83e1e7742c96d53265bd37ee7a08ede4233b17;p=vaadin-framework.git

Constructors documents changed

svn changeset:1230/svn branch:trunk
---

diff --git a/src/com/itmill/toolkit/ui/Button.java b/src/com/itmill/toolkit/ui/Button.java
index c9cba2e706..2b278caa86 100644
--- a/src/com/itmill/toolkit/ui/Button.java
+++ b/src/com/itmill/toolkit/ui/Button.java
@@ -64,7 +64,7 @@ public class Button extends AbstractField implements Action.Container {
 	private KeyMapper actionMapper = null;
 
 	/** 
-	 * Creates the new push button.
+	 * Creates a new push button.
 	 * The value of the push button is allways false and they are
 	 * immediate by default.
 	 *
@@ -74,7 +74,7 @@ public class Button extends AbstractField implements Action.Container {
 	}
 
 	/** 
-	 * Creates the new push button.
+	 * Creates a new push button.
 	 * 
 	 * The value of the push button is allways false and they are 
 	 * immediate by default.
@@ -87,7 +87,7 @@ public class Button extends AbstractField implements Action.Container {
 	}
 
 	/** 
-	 * Creates the new push button with click listener.
+	 * Creates a new push button with click listener.
 	 * @param caption the Button caption.
 	 * @param listener the Button click listener.
 	 */
@@ -97,7 +97,7 @@ public class Button extends AbstractField implements Action.Container {
 	}
 
 	/** 
-	 * Creates the new push button with a method listening button clicks.
+	 * Creates a new push button with a method listening button clicks.
 	 * The method must have either no parameters, or only one parameter of
 	 * Button.ClickEvent type.
 	 * @param caption the Button caption.
@@ -111,7 +111,7 @@ public class Button extends AbstractField implements Action.Container {
 	}
 
 	/** 
-	 * Creates the new switch button with initial value.
+	 * Creates a new switch button with initial value.
 	 * @param state the Initial state of the switch-button.
 	 * @param initialState
 	 */
@@ -122,7 +122,7 @@ public class Button extends AbstractField implements Action.Container {
 	}
 
 	/** 
-	 * Creates the new switch button that is connected to a boolean property.
+	 * Creates a new switch button that is connected to a boolean property.
 	 * @param state the Initial state of the switch-button.
 	 * @param dataSource
 	 */
diff --git a/src/com/itmill/toolkit/ui/ComponentContainer.java b/src/com/itmill/toolkit/ui/ComponentContainer.java
index bd8c5d1c7f..40be0a559f 100644
--- a/src/com/itmill/toolkit/ui/ComponentContainer.java
+++ b/src/com/itmill/toolkit/ui/ComponentContainer.java
@@ -151,7 +151,7 @@ public interface ComponentContainer extends Component {
         private Component component;
 
 		/** 
-		 * Creates the new attach event.
+		 * Creates a new attach event.
 		 * @param container the component container the component has been detached to.
 		 * @param attachedComponent the component that has been attached.
 		 */
@@ -190,7 +190,7 @@ public interface ComponentContainer extends Component {
         private Component component;
 
 		/** 
-		 * Creates the new detach event.
+		 * Creates a new detach event.
 		 * @param container the component container the component has been detached from.
 		 * @param detachedComponent the component that has been detached.
 		 */
diff --git a/src/com/itmill/toolkit/ui/CustomComponent.java b/src/com/itmill/toolkit/ui/CustomComponent.java
index 3a253bec80..161b0dd64b 100644
--- a/src/com/itmill/toolkit/ui/CustomComponent.java
+++ b/src/com/itmill/toolkit/ui/CustomComponent.java
@@ -93,7 +93,7 @@ public class CustomComponent implements Component {
 	private boolean repaintRequestListenersNotified = false;
 
 	/** 
-	 * Constructs new custom component. 
+	 * Constructs a new custom component. 
 	 * 
 	 * <p>
 	 * The component is implemented by wrapping the methods of the 
@@ -105,7 +105,7 @@ public class CustomComponent implements Component {
 	}
 
 	/** 
-	 * Constructs the new custom component. 
+	 * Constructs a new custom component. 
 	 * 
 	 * <p>
 	 * The component is implemented by wrapping the methods of the 
diff --git a/src/com/itmill/toolkit/ui/FieldFactory.java b/src/com/itmill/toolkit/ui/FieldFactory.java
index 255411ebd1..da2e8ab39c 100644
--- a/src/com/itmill/toolkit/ui/FieldFactory.java
+++ b/src/com/itmill/toolkit/ui/FieldFactory.java
@@ -44,7 +44,7 @@ public interface FieldFactory {
 
 
 	/** 
-	 * Creates the field based on type of data.
+	 * Creates a field based on type of data.
 	 *
 	 * @param type the type of data presented in field.
 	 * @param uiContext the component where the field is presented.
@@ -54,7 +54,7 @@ public interface FieldFactory {
 	Field createField(Class type, Component uiContext);
 	
 	/** 
-	 * Creates the field based on the property datasource.
+	 * Creates a field based on the property datasource.
 	 *
 	 * @param property the property datasource.
 	 * @param uiContext the component where the field is presented.
@@ -63,7 +63,7 @@ public interface FieldFactory {
 	Field createField(Property property, Component uiContext);
 
 	/** 
-	 * Creates the field based on the item and property id.
+	 * Creates a field based on the item and property id.
 	 * 
 	 * @param item the item where the property belongs to.
 	 * @param propertyId the Id of the property.
@@ -73,7 +73,7 @@ public interface FieldFactory {
 	Field createField(Item item, Object propertyId, Component uiContext);
 
 	/** 
-	 * Creates the field based on the container item id and property id.
+	 * Creates a field based on the container item id and property id.
 	 *
 	 * @param container the Container where the property belongs to.
 	 * @param itemId the item Id.
diff --git a/src/com/itmill/toolkit/ui/Panel.java b/src/com/itmill/toolkit/ui/Panel.java
index 5991d752c6..d1afdcc5ab 100644
--- a/src/com/itmill/toolkit/ui/Panel.java
+++ b/src/com/itmill/toolkit/ui/Panel.java
@@ -91,7 +91,7 @@ public class Panel
 	private boolean scrollable = false;
 
 	/** 
-	 * Creates the new empty panel.
+	 * Creates a new empty panel.
 	 * Ordered layout is used.
 	 */
 	public Panel() {
@@ -99,7 +99,7 @@ public class Panel
 	}
 
 	/** 
-	 * Creates the new empty panel with given layout.
+	 * Creates a new empty panel with given layout.
 	 * Layout must be non-null.
 	 *
 	 * @param layout the layout used in the panel.
@@ -109,7 +109,7 @@ public class Panel
 	}
 
 	/** 
-	 * Creates the new empty panel with caption.
+	 * Creates a new empty panel with caption.
 	 * Ordered layout is used.
 	 *
 	 * @param caption the caption used in the panel.
@@ -119,7 +119,7 @@ public class Panel
 	}
 
 	/** 
-	 * Creates the new empty panel with caption.
+	 * Creates a new empty panel with caption.
 	 *
 	 * @param caption the caption of the panel.
 	 * @param layout the layout used in the panel.
diff --git a/src/com/itmill/toolkit/ui/Table.java b/src/com/itmill/toolkit/ui/Table.java
index e51c4b44a6..9dbff353d8 100644
--- a/src/com/itmill/toolkit/ui/Table.java
+++ b/src/com/itmill/toolkit/ui/Table.java
@@ -321,14 +321,14 @@ public class Table extends Select implements Action.Container,
     /* Table constructors *************************************************** */
 
     /** 
-     * Creates new empty table. 
+     * Creates a new empty table. 
      */
     public Table() {
         setRowHeaderMode(ROW_HEADER_MODE_HIDDEN);
     }
 
     /** 
-     * Creates the new empty table with caption. 
+     * Creates a new empty table with caption. 
      * @param caption
      */
     public Table(String caption) {
@@ -337,7 +337,7 @@ public class Table extends Select implements Action.Container,
     }
 
     /** 
-     * Creates the new table with caption and connect it to a Container.
+     * Creates a new table with caption and connect it to a Container.
      * @param caption
      * @param dataSource  
      */
diff --git a/src/com/itmill/toolkit/ui/Tree.java b/src/com/itmill/toolkit/ui/Tree.java
index 191f5e2375..8d396e244f 100644
--- a/src/com/itmill/toolkit/ui/Tree.java
+++ b/src/com/itmill/toolkit/ui/Tree.java
@@ -106,13 +106,13 @@ public class Tree extends Select implements Container.Hierarchical, Action.Conta
 	/* Tree constructors ************************************************** */
 
 	/** 
-	 * Creates the new empty tree. 
+	 * Creates a new empty tree. 
 	 */
 	public Tree() {
 	}
 
 	/** 
-	 * Creates the new empty tree with caption.
+	 * Creates a new empty tree with caption.
 	 * @param caption  
 	 */
 	public Tree(String caption) {
@@ -120,7 +120,7 @@ public class Tree extends Select implements Container.Hierarchical, Action.Conta
 	}
 
 	/** 
-	 * Creates the new tree with caption and connect it to a Container. 
+	 * Creates a new tree with caption and connect it to a Container. 
 	 * @param caption 
 	 * @param dataSource
 	 */
diff --git a/src/com/itmill/toolkit/ui/Window.java b/src/com/itmill/toolkit/ui/Window.java
index b92337432d..1cdebe2b7d 100644
--- a/src/com/itmill/toolkit/ui/Window.java
+++ b/src/com/itmill/toolkit/ui/Window.java
@@ -134,7 +134,7 @@ public class Window extends Panel implements URIHandler, ParameterHandler {
 	/* ********************************************************************* */
 
 	/**
-	 * Creates the new empty unnamed window with default layout.
+	 * Creates a new empty unnamed window with default layout.
 	 * 
 	 * <p>
 	 * To show the window in application, it must be added to application with
@@ -153,7 +153,7 @@ public class Window extends Panel implements URIHandler, ParameterHandler {
 	}
 
 	/**
-	 * Creates the new empty window with default layout.
+	 * Creates a new empty window with default layout.
 	 * 
 	 * <p>
 	 * To show the window in application, it must be added to application with
@@ -172,7 +172,7 @@ public class Window extends Panel implements URIHandler, ParameterHandler {
 	}
 
 	/**
-	 * Creates the new window.
+	 * Creates a new window.
 	 * 
 	 * <p>
 	 * To show the window in application, it must be added to application with
@@ -662,7 +662,7 @@ public class Window extends Panel implements URIHandler, ParameterHandler {
 		private int border;
 
 		/** 
-		 * Creates the new open resource.
+		 * Creates a new open resource.
 		 * @param resource
 		 * @param name
 		 * @param width