diff options
| author | Artur Signell <artur@vaadin.com> | 2012-11-06 18:21:04 +0200 |
|---|---|---|
| committer | Vaadin Code Review <review@vaadin.com> | 2012-11-07 08:10:25 +0000 |
| commit | 5ab84abfd50d4aa2b142687661f9288d51a6440a (patch) | |
| tree | 54490e1a7b38332d45408be8c764bbb4cf8b02ff /server/src/com | |
| parent | d55cac7aa08e1652d140f6980ffc29e99da349ab (diff) | |
| download | vaadin-framework-5ab84abfd50d4aa2b142687661f9288d51a6440a.tar.gz vaadin-framework-5ab84abfd50d4aa2b142687661f9288d51a6440a.zip | |
Added Component.getDescription (#8154)
Change-Id: Iaa2f35415e68ecd4d53fd8743eb2c5cfb0afd36a
Diffstat (limited to 'server/src/com')
| -rw-r--r-- | server/src/com/vaadin/ui/AbstractComponent.java | 59 | ||||
| -rw-r--r-- | server/src/com/vaadin/ui/Component.java | 59 |
2 files changed, 63 insertions, 55 deletions
diff --git a/server/src/com/vaadin/ui/AbstractComponent.java b/server/src/com/vaadin/ui/AbstractComponent.java index 4a3aba3cf4..fb550fa944 100644 --- a/server/src/com/vaadin/ui/AbstractComponent.java +++ b/server/src/com/vaadin/ui/AbstractComponent.java @@ -421,63 +421,12 @@ public abstract class AbstractComponent extends AbstractClientConnector } } - /** - * <p> - * 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: - * </p> - * - * <p> - * <table border=1> - * <tr> - * <td width=120><b>Tag</b></td> - * <td width=120><b>Description</b></td> - * <td width=120><b>Example</b></td> - * </tr> - * <tr> - * <td><b></td> - * <td>bold</td> - * <td><b>bold text</b></td> - * </tr> - * <tr> - * <td><i></td> - * <td>italic</td> - * <td><i>italic text</i></td> - * </tr> - * <tr> - * <td><u></td> - * <td>underlined</td> - * <td><u>underlined text</u></td> - * </tr> - * <tr> - * <td><br></td> - * <td>linebreak</td> - * <td>N/A</td> - * </tr> - * <tr> - * <td><ul><br> - * <li>item1<br> - * <li>item1<br> - * </ul></td> - * <td>item list</td> - * <td> - * <ul> - * <li>item1 - * <li>item2 - * </ul> - * </td> - * </tr> - * </table> - * </p> - * - * <p> - * These tags may be nested. - * </p> + /* + * (non-Javadoc) * - * @return component's description <code>String</code> + * @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(); + /** + * <p> + * 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: + * </p> + * + * <p> + * <table border=1> + * <tr> + * <td width=120><b>Tag</b></td> + * <td width=120><b>Description</b></td> + * <td width=120><b>Example</b></td> + * </tr> + * <tr> + * <td><b></td> + * <td>bold</td> + * <td><b>bold text</b></td> + * </tr> + * <tr> + * <td><i></td> + * <td>italic</td> + * <td><i>italic text</i></td> + * </tr> + * <tr> + * <td><u></td> + * <td>underlined</td> + * <td><u>underlined text</u></td> + * </tr> + * <tr> + * <td><br></td> + * <td>linebreak</td> + * <td>N/A</td> + * </tr> + * <tr> + * <td><ul><br> + * <li>item1<br> + * <li>item1<br> + * </ul></td> + * <td>item list</td> + * <td> + * <ul> + * <li>item1 + * <li>item2 + * </ul> + * </td> + * </tr> + * </table> + * </p> + * + * <p> + * These tags may be nested. + * </p> + * + * @return component's description <code>String</code> + */ + public String getDescription(); + /* Component event framework */ /** |