From 5ab84abfd50d4aa2b142687661f9288d51a6440a Mon Sep 17 00:00:00 2001
From: Artur Signell
- * Gets the component's description, used in tooltips and can be displayed
- * directly in certain other components such as forms. The description can
- * be used to briefly describe the state of the component to the user. The
- * description string may contain certain XML tags:
- *
- *
- *
- *
- *
- * Tag
- * Description
- * Example
- *
- *
- * <b>
- * bold
- * bold text
- *
- *
- * <i>
- * italic
- * italic text
- *
- *
- * <u>
- * underlined
- * underlined text
- *
- *
- * <br>
- * linebreak
- * N/A
- *
- *
- * <ul>
- *
- * <li>item1
- * <li>item1
- * </ul>item list
- *
- *
- *
- *
- *
- * These tags may be nested. - *
+ /* + * (non-Javadoc) * - * @return component's descriptionString
+ * @see com.vaadin.ui.Component#getDescription()
*/
+ @Override
public String getDescription() {
return getState().description;
}
diff --git a/server/src/com/vaadin/ui/Component.java b/server/src/com/vaadin/ui/Component.java
index 186aaa0219..36868c41e9 100644
--- a/server/src/com/vaadin/ui/Component.java
+++ b/server/src/com/vaadin/ui/Component.java
@@ -646,6 +646,65 @@ public interface Component extends ClientConnector, Sizeable, Serializable {
*/
public String getId();
+ /**
+ * + * Gets the component's description, used in tooltips and can be displayed + * directly in certain other components such as forms. The description can + * be used to briefly describe the state of the component to the user. The + * description string may contain certain XML tags: + *
+ * + *+ *
Tag | + *Description | + *Example | + *
<b> | + *bold | + *bold text | + *
<i> | + *italic | + *italic text | + *
<u> | + *underlined | + *underlined text | + *
<br> | + *linebreak | + *N/A | + *
<ul> + * <li>item1 + * <li>item1 + * </ul> |
+ * item list | + *
+ *
|
+ *
+ * These tags may be nested. + *
+ * + * @return component's descriptionString
+ */
+ public String getDescription();
+
/* Component event framework */
/**
--
cgit v1.2.3