From: John Ahlroos <john@vaadin.com>
Date: Mon, 1 Oct 2012 12:07:44 +0000 (+0300)
Subject: Javadoc + fixed a typo in method name #9724
X-Git-Tag: 7.0.0.beta6~87^2~12
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=5efcd34424299e40dfef960c61f52ee61b104929;p=vaadin-framework.git

Javadoc + fixed a typo in method name #9724
---

diff --git a/server/src/com/vaadin/ui/AbstractComponent.java b/server/src/com/vaadin/ui/AbstractComponent.java
index 5e4938dcf5..4a3aba3cf4 100644
--- a/server/src/com/vaadin/ui/AbstractComponent.java
+++ b/server/src/com/vaadin/ui/AbstractComponent.java
@@ -197,7 +197,7 @@ public abstract class AbstractComponent extends AbstractClientConnector
     }
 
     @Override
-    public void setPrimaryStylename(String style) {
+    public void setPrimaryStyleName(String style) {
         getState().primaryStyleName = style;
     }
 
diff --git a/server/src/com/vaadin/ui/Component.java b/server/src/com/vaadin/ui/Component.java
index dd7ea6278b..186aaa0219 100644
--- a/server/src/com/vaadin/ui/Component.java
+++ b/server/src/com/vaadin/ui/Component.java
@@ -198,17 +198,33 @@ public interface Component extends ClientConnector, Sizeable, Serializable {
     public void removeStyleName(String style);
 
     /**
-     * FIXME Javadoc
+     * Gets the primary style name of the component. See
+     * {@link Component#setPrimaryStyleName(String)} for a better description of
+     * the primary stylename.
      */
     public String getPrimaryStyleName();
 
     /**
-     * FIXME Javadoc
+     * Changes the primary style name of the component.
+     * 
+     * <p>
+     * The primary style name identifies the component when applying the CSS
+     * theme to the Component. By changing the style name all CSS rules targeted
+     * for that style name will no longer apply, and might result in the
+     * component not working as intended.
+     * </p>
+     * 
+     * <p>
+     * To preserve the original style of the component when changing to a new
+     * primary style you should make your new primary style inherit the old
+     * primary style using the SASS @include directive. See more in the SASS
+     * tutorials.
+     * </p>
      * 
      * @param style
-     *            The stylename to set
+     *            The new primary style name
      */
-    public void setPrimaryStylename(String style);
+    public void setPrimaryStyleName(String style);
 
     /**
      * Tests whether the component is enabled or not. A user can not interact