summaryrefslogtreecommitdiffstats
path: root/server/src/com/vaadin/ui/Component.java
diff options
context:
space:
mode:
authorJohn Ahlroos <john@vaadin.com>2012-10-01 15:07:44 +0300
committerJohn Ahlroos <john@vaadin.com>2012-10-01 15:07:44 +0300
commit5efcd34424299e40dfef960c61f52ee61b104929 (patch)
tree21eb7e25fae584a06fe92518d059e0c7b26c7694 /server/src/com/vaadin/ui/Component.java
parent31faeb75ef5c0977acab2c2ca75ecfce2d768949 (diff)
downloadvaadin-framework-5efcd34424299e40dfef960c61f52ee61b104929.tar.gz
vaadin-framework-5efcd34424299e40dfef960c61f52ee61b104929.zip
Javadoc + fixed a typo in method name #9724
Diffstat (limited to 'server/src/com/vaadin/ui/Component.java')
-rw-r--r--server/src/com/vaadin/ui/Component.java24
1 files changed, 20 insertions, 4 deletions
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