diff options
author | Johannes Dahlström <johannesd@vaadin.com> | 2013-07-30 14:58:14 +0300 |
---|---|---|
committer | Johannes Dahlström <johannesd@vaadin.com> | 2013-07-30 14:58:14 +0300 |
commit | 44aacf471be2f1846607194af98b795e2247a600 (patch) | |
tree | b6a5bc026043c7bb01cc4e50252f3aca708ab0cc /server | |
parent | 7cb49d10de85b038b3f7068bf87b6c10315d3c21 (diff) | |
download | vaadin-framework-44aacf471be2f1846607194af98b795e2247a600.tar.gz vaadin-framework-44aacf471be2f1846607194af98b795e2247a600.zip |
Clarify Embedded javadoc (#12290)
Change-Id: I3c15bf79236019056eeb501974a6a34799e8fd40
Diffstat (limited to 'server')
-rw-r--r-- | server/src/com/vaadin/ui/Embedded.java | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/server/src/com/vaadin/ui/Embedded.java b/server/src/com/vaadin/ui/Embedded.java index c9b64af415..53354db0f4 100644 --- a/server/src/com/vaadin/ui/Embedded.java +++ b/server/src/com/vaadin/ui/Embedded.java @@ -31,13 +31,17 @@ import com.vaadin.shared.ui.embedded.EmbeddedConstants; import com.vaadin.shared.ui.embedded.EmbeddedServerRpc; /** - * Component for embedding external objects. + * A component for embedding external objects. * <p> - * As of Vaadin 7.0, the {@link Image}, {@link Flash}, and {@link BrowserFrame} - * components should be used instead of <code>Embedded</code> for displaying - * images, Adobe Flash objects, and embedded web pages, respectively. - * <code>Embedded</code> is still useful for displaying other multimedia content - * such as applets and PDF documents. + * The {@code Embedded} component is used to display various types of multimedia + * content using the HTML {@code <object>} element. This includes PDF documents, + * Java applets, and QuickTime videos. Installing a browser plug-in is usually + * required to actually view the embedded content. + * <p> + * Note that before Vaadin 7, {@code Embedded} was also used to display images, + * Adobe Flash objects, and embedded web pages. This use of the component is + * deprecated in Vaadin 7; the {@link Image}, {@link Flash}, and + * {@link BrowserFrame} components should be used instead, respectively. * * @see Video * @see Audio |