diff options
author | Leif Åstrand <legioth@gmail.com> | 2017-12-01 09:30:43 +0200 |
---|---|---|
committer | Teemu Suo-Anttila <tsuoanttila@users.noreply.github.com> | 2017-12-07 12:19:06 +0200 |
commit | 987948dfd0d676d4b957a58dc03896727fa22793 (patch) | |
tree | 5a7a05a71108afca79ee68205c9bc23e5ec9b9ce | |
parent | 5abefeec3114290c4f5d3eef474d2a5c2dccef8b (diff) | |
download | vaadin-framework-987948dfd0d676d4b957a58dc03896727fa22793.tar.gz vaadin-framework-987948dfd0d676d4b957a58dc03896727fa22793.zip |
Clarify ContentMode javadocs (#10395)
* Don't refer to Label
* Explicitly mention XSS risk with HTML
-rw-r--r-- | shared/src/main/java/com/vaadin/shared/ui/ContentMode.java | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/shared/src/main/java/com/vaadin/shared/ui/ContentMode.java b/shared/src/main/java/com/vaadin/shared/ui/ContentMode.java index 4c604f4291..4808935658 100644 --- a/shared/src/main/java/com/vaadin/shared/ui/ContentMode.java +++ b/shared/src/main/java/com/vaadin/shared/ui/ContentMode.java @@ -16,24 +16,25 @@ package com.vaadin.shared.ui; /** - * Content modes defining how the client should interpret a Label's value. + * Defines how the client should interpret textual values. * * @since 8.0 */ public enum ContentMode { /** - * Content mode, where the label contains only plain text. + * Textual values are displayed as plain text. */ TEXT, /** - * Content mode, where the label contains preformatted text. In this mode - * newlines are preserved when rendered on the screen. + * Textual values are displayed as preformatted text. In this mode newlines + * are preserved when rendered on the screen. */ PREFORMATTED, /** - * Content mode, where the label contains HTML. + * Textual values are interpreted and displayed as HTML. Care should be + * taken when using this mode to avoid Cross-site Scripting (XSS) issues. */ HTML |