Improvements to #9087:

* Rename EmbeddedBrowser to BrowserFrame
* Add constructors to Flash and BrowserFrame
* Change getState() methods to protected
* JavaDoc improvements
* Make ImageClicks test deterministic

13 files changed, 135 insertions, 63 deletions

diff --git a/client/src/com/vaadin/client/ui/embeddedbrowser/EmbeddedBrowserConnector.java b/client/src/com/vaadin/client/ui/browserframe/BrowserFrameConnector.java
index 10445dbff5..c22d92235b 100644
--- a/client/src/com/vaadin/client/ui/embeddedbrowser/EmbeddedBrowserConnector.java
+++ b/client/src/com/vaadin/client/ui/browserframe/BrowserFrameConnector.java
@@ -1,13 +1,13 @@
-package com.vaadin.client.ui.embeddedbrowser;
+package com.vaadin.client.ui.browserframe;
 
 import com.vaadin.client.communication.StateChangeEvent;
 import com.vaadin.client.ui.AbstractComponentConnector;
 import com.vaadin.shared.ui.AbstractEmbeddedState;
 import com.vaadin.shared.ui.Connect;
-import com.vaadin.shared.ui.embeddedbrowser.EmbeddedBrowserState;
+import com.vaadin.shared.ui.browserframe.BrowserFrameState;
 
-@Connect(com.vaadin.ui.EmbeddedBrowser.class)
-public class EmbeddedBrowserConnector extends AbstractComponentConnector {
+@Connect(com.vaadin.ui.BrowserFrame.class)
+public class BrowserFrameConnector extends AbstractComponentConnector {
 
     @Override
     protected void init() {
@@ -15,13 +15,13 @@ public class EmbeddedBrowserConnector extends AbstractComponentConnector {
     }
 
     @Override
-    public VEmbeddedBrowser getWidget() {
-        return (VEmbeddedBrowser) super.getWidget();
+    public VBrowserFrame getWidget() {
+        return (VBrowserFrame) super.getWidget();
     }
 
     @Override
-    public EmbeddedBrowserState getState() {
-        return (EmbeddedBrowserState) super.getState();
+    public BrowserFrameState getState() {
+        return (BrowserFrameState) super.getState();
     }
 
     @Override
diff --git a/client/src/com/vaadin/client/ui/embeddedbrowser/VEmbeddedBrowser.java b/client/src/com/vaadin/client/ui/browserframe/VBrowserFrame.java
index 3fe1c44bc3..da2c981a8d 100644
--- a/client/src/com/vaadin/client/ui/embeddedbrowser/VEmbeddedBrowser.java
+++ b/client/src/com/vaadin/client/ui/browserframe/VBrowserFrame.java
@@ -1,21 +1,21 @@
-package com.vaadin.client.ui.embeddedbrowser;
+package com.vaadin.client.ui.browserframe;
 
 import com.google.gwt.dom.client.Document;
 import com.google.gwt.dom.client.Element;
 import com.google.gwt.dom.client.IFrameElement;
 import com.google.gwt.user.client.ui.Widget;
 
-public class VEmbeddedBrowser extends Widget {
+public class VBrowserFrame extends Widget {
 
     protected IFrameElement iframe;
     protected Element altElement;
     protected String altText;
 
-    public VEmbeddedBrowser() {
+    public VBrowserFrame() {
         Element root = Document.get().createDivElement();
         setElement(root);
 
-        setStylePrimaryName("v-embeddedbrowser");
+        setStylePrimaryName("v-browserframe");
 
         createAltTextElement();
     }
diff --git a/server/src/com/vaadin/ui/AbstractEmbedded.java b/server/src/com/vaadin/ui/AbstractEmbedded.java
index 5c72141ef9..7dcf7ca091 100644
--- a/server/src/com/vaadin/ui/AbstractEmbedded.java
+++ b/server/src/com/vaadin/ui/AbstractEmbedded.java
@@ -19,7 +19,7 @@ import com.vaadin.shared.ui.AbstractEmbeddedState;
 public abstract class AbstractEmbedded extends AbstractComponent {
 
     @Override
-    public AbstractEmbeddedState getState() {
+    protected AbstractEmbeddedState getState() {
         return (AbstractEmbeddedState) super.getState();
     }
 
diff --git a/server/src/com/vaadin/ui/BrowserFrame.java b/server/src/com/vaadin/ui/BrowserFrame.java
new file mode 100644
index 0000000000..e79e03c2dd
--- /dev/null
+++ b/server/src/com/vaadin/ui/BrowserFrame.java
@@ -0,0 +1,51 @@
+package com.vaadin.ui;
+
+import com.vaadin.server.Resource;
+import com.vaadin.shared.ui.browserframe.BrowserFrameState;
+
+/**
+ * A component displaying an embedded web page. Implemented as a HTML
+ * <code>iframe</code> element.
+ * 
+ * @author Vaadin Ltd.
+ * @version
+ * @VERSION@
+ * @since 7.0
+ */
+public class BrowserFrame extends AbstractEmbedded {
+
+    /**
+     * Creates a new empty browser frame.
+     */
+    public BrowserFrame() {
+
+    }
+
+    /**
+     * Creates a new empty browser frame with the given caption.
+     * 
+     * @param caption
+     *            The caption for the component
+     */
+    public BrowserFrame(String caption) {
+        setCaption(caption);
+    }
+
+    /**
+     * Creates a new browser frame with the given caption and content.
+     * 
+     * @param caption
+     *            The caption for the component.
+     * @param source
+     *            A Resource representing the Web page that should be displayed.
+     */
+    public BrowserFrame(String caption, Resource source) {
+        this(caption);
+        setSource(source);
+    }
+
+    @Override
+    protected BrowserFrameState getState() {
+        return (BrowserFrameState) super.getState();
+    }
+}
diff --git a/server/src/com/vaadin/ui/Embedded.java b/server/src/com/vaadin/ui/Embedded.java
index 3bcd7a26a0..d61fd44292 100644
--- a/server/src/com/vaadin/ui/Embedded.java
+++ b/server/src/com/vaadin/ui/Embedded.java
@@ -34,9 +34,14 @@ import com.vaadin.shared.ui.embedded.EmbeddedServerRpc;
 /**
  * Component for embedding external objects.
  * <p>
- * As of Vaadin 7.0, the {@link Image}, {@link Flash}, and
- * {@link EmbeddedBrowser} components should be used instead of
- * <code>Embedded</code> whenever appropriate.
+ * 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.
+ * 
+ * @see Video
+ * @see Audio
  * 
  * @author Vaadin Ltd.
  * @since 3.0
@@ -60,7 +65,7 @@ public class Embedded extends AbstractComponent implements LegacyComponent {
     /**
      * Browser ("iframe") type.
      * 
-     * @deprecated As of 7.0, use the {@link EmbeddedBrowser} component instead.
+     * @deprecated As of 7.0, use the {@link BrowserFrame} component instead.
      */
     @Deprecated
     public static final int TYPE_BROWSER = 2;
diff --git a/server/src/com/vaadin/ui/EmbeddedBrowser.java b/server/src/com/vaadin/ui/EmbeddedBrowser.java
deleted file mode 100644
index 4e2ae18de8..0000000000
--- a/server/src/com/vaadin/ui/EmbeddedBrowser.java
+++ /dev/null
@@ -1,19 +0,0 @@
-package com.vaadin.ui;
-
-import com.vaadin.shared.ui.embeddedbrowser.EmbeddedBrowserState;
-
-/**
- * Component for embedding browser "iframe".
- * 
- * @author Vaadin Ltd.
- * @version
- * @VERSION@
- * @since 7.0
- */
-public class EmbeddedBrowser extends AbstractEmbedded {
-
-    @Override
-    public EmbeddedBrowserState getState() {
-        return (EmbeddedBrowserState) super.getState();
-    }
-}
diff --git a/server/src/com/vaadin/ui/Flash.java b/server/src/com/vaadin/ui/Flash.java
index 430018289a..726b6c21c4 100644
--- a/server/src/com/vaadin/ui/Flash.java
+++ b/server/src/com/vaadin/ui/Flash.java
@@ -6,10 +6,11 @@ package com.vaadin.ui;
 
 import java.util.HashMap;
 
+import com.vaadin.server.Resource;
 import com.vaadin.shared.ui.flash.FlashState;
 
 /**
- * Component for embedding flash objects.
+ * A component for displaying Adobe® Flash® content.
  * 
  * @author Vaadin Ltd.
  * @version
@@ -19,8 +20,39 @@ import com.vaadin.shared.ui.flash.FlashState;
 @SuppressWarnings("serial")
 public class Flash extends AbstractEmbedded {
 
+    /**
+     * Creates a new empty Flash component.
+     */
+    public Flash() {
+
+    }
+
+    /**
+     * Creates a new empty Flash component with the given caption
+     * 
+     * @param caption
+     *            The caption for the component
+     */
+    public Flash(String caption) {
+        setCaption(caption);
+    }
+
+    /**
+     * Creates a new Flash component with the given caption and content.
+     * 
+     * @param caption
+     *            The caption for the component
+     * @param source
+     *            A Resource representing the Flash content that should be
+     *            displayed
+     */
+    public Flash(String caption, Resource source) {
+        this(caption);
+        setSource(source);
+    }
+
     @Override
-    public FlashState getState() {
+    protected FlashState getState() {
         return (FlashState) super.getState();
     }
 
diff --git a/server/src/com/vaadin/ui/Image.java b/server/src/com/vaadin/ui/Image.java
index 178e557cf3..c1b27704d4 100644
--- a/server/src/com/vaadin/ui/Image.java
+++ b/server/src/com/vaadin/ui/Image.java
@@ -61,7 +61,7 @@ public class Image extends AbstractEmbedded {
     }
 
     @Override
-    public ImageState getState() {
+    protected ImageState getState() {
         return (ImageState) super.getState();
     }
 
diff --git a/shared/src/com/vaadin/shared/ui/browserframe/BrowserFrameState.java b/shared/src/com/vaadin/shared/ui/browserframe/BrowserFrameState.java
new file mode 100644
index 0000000000..1c36420372
--- /dev/null
+++ b/shared/src/com/vaadin/shared/ui/browserframe/BrowserFrameState.java
@@ -0,0 +1,7 @@
+package com.vaadin.shared.ui.browserframe;
+
+import com.vaadin.shared.ui.AbstractEmbeddedState;
+
+public class BrowserFrameState extends AbstractEmbeddedState {
+
+}
diff --git a/shared/src/com/vaadin/shared/ui/embeddedbrowser/EmbeddedBrowserState.java b/shared/src/com/vaadin/shared/ui/embeddedbrowser/EmbeddedBrowserState.java
deleted file mode 100644
index cca47176a3..0000000000
--- a/shared/src/com/vaadin/shared/ui/embeddedbrowser/EmbeddedBrowserState.java
+++ /dev/null
@@ -1,7 +0,0 @@
-package com.vaadin.shared.ui.embeddedbrowser;
-
-import com.vaadin.shared.ui.AbstractEmbeddedState;
-
-public class EmbeddedBrowserState extends AbstractEmbeddedState {
-
-}
diff --git a/uitest/src/com/vaadin/tests/components/embeddedbrowser/EmbeddedBrowserIsVisible.html b/uitest/src/com/vaadin/tests/components/browserframe/BrowserFrameIsVisible.html
index 2d76cd48b2..93b855838c 100644
--- a/uitest/src/com/vaadin/tests/components/embeddedbrowser/EmbeddedBrowserIsVisible.html
+++ b/uitest/src/com/vaadin/tests/components/browserframe/BrowserFrameIsVisible.html
@@ -4,16 +4,16 @@
 <head profile="http://selenium-ide.openqa.org/profiles/test-case">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
 <link rel="selenium.base" href="" />
-<title>EmbeddedBrowserIsVisible</title>
+<title>BrowserFrameIsVisible</title>
 </head>
 <body>
 <table cellpadding="1" cellspacing="1" border="1">
 <thead>
-<tr><td rowspan="1" colspan="3">EmbeddedBrowserIsVisible</td></tr>
+<tr><td rowspan="1" colspan="3">BrowserFrameIsVisible</td></tr>
 </thead><tbody>
 <tr>
 	<td>open</td>
-	<td>/run/com.vaadin.tests.components.embeddedbrowser.EmbeddedBrowserIsVisible?restartApplication</td>
+	<td>/run/com.vaadin.tests.components.browserframe.BrowserFrameIsVisible?restartApplication</td>
 	<td></td>
 </tr>
 <tr>
@@ -23,7 +23,7 @@
 </tr>
 <tr>
 	<td>click</td>
-	<td>vaadin=runcomvaadintestscomponentsembeddedbrowserEmbeddedBrowserIsVisible::/VVerticalLayout[0]/VVerticalLayout[0]/VHorizontalLayout[0]/VButton[0]/domChild[0]/domChild[0]</td>
+	<td>vaadin=runcomvaadintestscomponentsbrowserframeBrowserFrameIsVisible::/VVerticalLayout[0]/VVerticalLayout[0]/VHorizontalLayout[0]/VButton[0]/domChild[0]/domChild[0]</td>
 	<td></td>
 </tr>
 <tr>
@@ -33,7 +33,7 @@
 </tr>
 <tr>
 	<td>click</td>
-	<td>vaadin=runcomvaadintestscomponentsembeddedbrowserEmbeddedBrowserIsVisible::/VVerticalLayout[0]/VVerticalLayout[0]/VHorizontalLayout[0]/VButton[1]/domChild[0]/domChild[0]</td>
+	<td>vaadin=runcomvaadintestscomponentsbrowserframeBrowserFrameIsVisible::/VVerticalLayout[0]/VVerticalLayout[0]/VHorizontalLayout[0]/VButton[1]/domChild[0]/domChild[0]</td>
 	<td></td>
 </tr>
 <tr>
@@ -43,7 +43,7 @@
 </tr>
 <tr>
 	<td>click</td>
-	<td>vaadin=runcomvaadintestscomponentsembeddedbrowserEmbeddedBrowserIsVisible::/VVerticalLayout[0]/VVerticalLayout[0]/VHorizontalLayout[0]/VButton[2]/domChild[0]/domChild[0]</td>
+	<td>vaadin=runcomvaadintestscomponentsbrowserframeBrowserFrameIsVisible::/VVerticalLayout[0]/VVerticalLayout[0]/VHorizontalLayout[0]/VButton[2]/domChild[0]/domChild[0]</td>
 	<td></td>
 </tr>
 <tr>
@@ -53,7 +53,7 @@
 </tr>
 <tr>
 	<td>click</td>
-	<td>vaadin=runcomvaadintestscomponentsembeddedbrowserEmbeddedBrowserIsVisible::/VVerticalLayout[0]/VVerticalLayout[0]/VHorizontalLayout[0]/VButton[1]/domChild[0]/domChild[0]</td>
+	<td>vaadin=runcomvaadintestscomponentsbrowserframeBrowserFrameIsVisible::/VVerticalLayout[0]/VVerticalLayout[0]/VHorizontalLayout[0]/VButton[1]/domChild[0]/domChild[0]</td>
 	<td></td>
 </tr>
 <tr>
diff --git a/uitest/src/com/vaadin/tests/components/embeddedbrowser/EmbeddedBrowserIsVisible.java b/uitest/src/com/vaadin/tests/components/browserframe/BrowserFrameIsVisible.java
index 2eaf712676..4e9c133bea 100644
--- a/uitest/src/com/vaadin/tests/components/embeddedbrowser/EmbeddedBrowserIsVisible.java
+++ b/uitest/src/com/vaadin/tests/components/browserframe/BrowserFrameIsVisible.java
@@ -1,4 +1,4 @@
-package com.vaadin.tests.components.embeddedbrowser;
+package com.vaadin.tests.components.browserframe;
 
 import java.io.ByteArrayInputStream;
 import java.io.InputStream;
@@ -6,12 +6,12 @@ import java.io.UnsupportedEncodingException;
 
 import com.vaadin.server.StreamResource;
 import com.vaadin.tests.components.TestBase;
+import com.vaadin.ui.BrowserFrame;
 import com.vaadin.ui.Button;
 import com.vaadin.ui.Button.ClickEvent;
-import com.vaadin.ui.EmbeddedBrowser;
 import com.vaadin.ui.HorizontalLayout;
 
-public class EmbeddedBrowserIsVisible extends TestBase {
+public class BrowserFrameIsVisible extends TestBase {
 
     @Override
     protected void setup() {
@@ -28,8 +28,8 @@ public class EmbeddedBrowserIsVisible extends TestBase {
         Button page3 = new Button("null");
         buttonLayout.addComponent(page3);
 
-        final EmbeddedBrowser browser = new EmbeddedBrowser();
-        browser.setDebugId("browser");
+        final BrowserFrame browser = new BrowserFrame();
+        browser.setId("browser");
         browser.setWidth("600px");
         browser.setHeight("300px");
         browser.setAlternateText("Browser alternative text");
@@ -40,7 +40,7 @@ public class EmbeddedBrowserIsVisible extends TestBase {
         browser.setSource(textResource);
         addComponent(browser);
 
-        page1.addListener(new Button.ClickListener() {
+        page1.addClickListener(new Button.ClickListener() {
 
             @Override
             public void buttonClick(ClickEvent event) {
@@ -52,7 +52,7 @@ public class EmbeddedBrowserIsVisible extends TestBase {
             }
         });
 
-        page2.addListener(new Button.ClickListener() {
+        page2.addClickListener(new Button.ClickListener() {
 
             @Override
             public void buttonClick(ClickEvent event) {
@@ -64,7 +64,7 @@ public class EmbeddedBrowserIsVisible extends TestBase {
             }
         });
 
-        page3.addListener(new Button.ClickListener() {
+        page3.addClickListener(new Button.ClickListener() {
 
             @Override
             public void buttonClick(ClickEvent event) {
diff --git a/uitest/src/com/vaadin/tests/components/image/ImageClicks.java b/uitest/src/com/vaadin/tests/components/image/ImageClicks.java
index e2d983b7ce..e50b8c3a4f 100644
--- a/uitest/src/com/vaadin/tests/components/image/ImageClicks.java
+++ b/uitest/src/com/vaadin/tests/components/image/ImageClicks.java
@@ -7,6 +7,7 @@ import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
+import java.util.Random;
 
 import javax.imageio.ImageIO;
 
@@ -19,6 +20,8 @@ import com.vaadin.ui.Label;
 
 public class ImageClicks extends TestBase {
 
+    private final Random rng = new Random(0);
+
     private int clickCounter = 0;
 
     @Override
@@ -32,7 +35,7 @@ public class ImageClicks extends TestBase {
         final StreamResource imageResource = new StreamResource(imageSource,
                 "testimage.png");
         image.setSource(imageResource);
-        image.addListener(new ClickListener() {
+        image.addClickListener(new ClickListener() {
 
             @Override
             public void click(ClickEvent event) {
@@ -107,7 +110,7 @@ public class ImageClicks extends TestBase {
                     }
 
                     // Cell
-                    if (Math.random() < 0.5f) {
+                    if (rng.nextFloat() < 0.5f) {
                         drawable.setColor(Color.white);
                     } else {
                         drawable.setColor(Color.black);