diff options
| author | Artur Signell <artur@vaadin.com> | 2014-12-16 10:05:54 +0200 |
|---|---|---|
| committer | Vaadin Code Review <review@vaadin.com> | 2014-12-16 14:37:33 +0000 |
| commit | 1ae161965d5b9b9bc6aae041ab80c906460ede83 (patch) | |
| tree | 05e096bbd88674284eacd7f5c91744999ace8626 /server/src | |
| parent | 1bfb901ad434d295f775c2fe34ac2cad4b2924e4 (diff) | |
| download | vaadin-framework-1ae161965d5b9b9bc6aae041ab80c906460ede83.tar.gz vaadin-framework-1ae161965d5b9b9bc6aae041ab80c906460ede83.zip | |
Clarified javadoc (#7749)
Change-Id: I89d55fdc9b380f90940477e1d4d031394c81ee40
Diffstat (limited to 'server/src')
| -rw-r--r-- | server/src/com/vaadin/ui/Component.java | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/server/src/com/vaadin/ui/Component.java b/server/src/com/vaadin/ui/Component.java index 78fb643ba9..9e0816a398 100644 --- a/server/src/com/vaadin/ui/Component.java +++ b/server/src/com/vaadin/ui/Component.java @@ -732,9 +732,15 @@ public interface Component extends ClientConnector, Sizeable, Serializable { /* Declarative support */ /** - * Update the component state based on the given design. The component is - * responsible not only for updating itself but also ensuring that its - * children update their state based on the design. + * Reads the component state from the given design. + * <p> + * The component is responsible not only for updating its own state but also + * for ensuring that its children update their state based on the design. + * <p> + * It is assumed that the component is in its default state when this method + * is called. Reading should only take into consideration attributes + * specified in the design and not reset any unspecified attributes to their + * defaults. * <p> * This method must not modify the design. * @@ -747,11 +753,10 @@ public interface Component extends ClientConnector, Sizeable, Serializable { public void readDesign(Element design, DesignContext designContext); /** - * Update the given design based on the component state. The component is - * responsible not only for updating itself but also for ensuring its - * children update themselves in the correct position in the design. The - * caller of this method should not assume that contents of the - * <code>design</code> parameter are presented. + * Writes the component state to the given design. + * <p> + * The component is responsible not only for writing its own state but also + * for ensuring that its children write their state to the design. * <p> * This method must not modify the component state. * |