Split Embedded into several components, migrate them to Vaadin 7 (#9087)

4 files changed, 333 insertions, 0 deletions

diff --git a/server/src/com/vaadin/ui/AbstractEmbedded.java b/server/src/com/vaadin/ui/AbstractEmbedded.java
new file mode 100644
index 0000000000..9396af5c44
--- /dev/null
+++ b/server/src/com/vaadin/ui/AbstractEmbedded.java
@@ -0,0 +1,84 @@
+/*
+@VaadinApache2LicenseForJavaFiles@
+ */
+
+package com.vaadin.ui;
+
+import com.vaadin.shared.ui.AbstractEmbeddedState;
+import com.vaadin.terminal.Resource;
+import com.vaadin.terminal.gwt.server.ResourceReference;
+
+/**
+ * Abstract base for embedding components.
+ * 
+ * @author Vaadin Ltd.
+ * @version
+ * @VERSION@
+ * @since 7.0
+ */
+@SuppressWarnings("serial")
+public abstract class AbstractEmbedded extends AbstractComponent {
+
+    @Override
+    public AbstractEmbeddedState getState() {
+        return (AbstractEmbeddedState) super.getState();
+    }
+
+    /**
+     * Sets the object source resource. The dimensions are assumed if possible.
+     * The type is guessed from resource.
+     * 
+     * @param source
+     *            the source to set.
+     */
+    public void setSource(Resource source) {
+        if (source == null) {
+            getState().setSource(null);
+        } else {
+            getState().setSource(new ResourceReference(source));
+        }
+        requestRepaint();
+    }
+
+    /**
+     * Get the object source resource.
+     * 
+     * @return the source
+     */
+    public Resource getSource() {
+        ResourceReference ref = ((ResourceReference) getState().getSource());
+        if (ref == null) {
+            return null;
+        } else {
+            return ref.getResource();
+        }
+    }
+
+    /**
+     * Sets this component's alternate text that can be presented instead of the
+     * component's normal content for accessibility purposes.
+     * 
+     * @param altText
+     *            A short, human-readable description of this component's
+     *            content.
+     */
+    public void setAlternateText(String altText) {
+        if (altText != getState().getAlternateText()
+                || (altText != null && !altText.equals(getState()
+                        .getAlternateText()))) {
+            getState().setAlternateText(altText);
+            requestRepaint();
+        }
+    }
+
+    /**
+     * Gets this component's alternate text that can be presented instead of the
+     * component's normal content for accessibility purposes.
+     * 
+     * @returns Alternate text
+     */
+    public String getAlternateText() {
+        return getState().getAlternateText();
+    }
+
+}
diff --git a/server/src/com/vaadin/ui/EmbeddedBrowser.java b/server/src/com/vaadin/ui/EmbeddedBrowser.java
new file mode 100644
index 0000000000..4e2ae18de8
--- /dev/null
+++ b/server/src/com/vaadin/ui/EmbeddedBrowser.java
@@ -0,0 +1,19 @@
+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
new file mode 100644
index 0000000000..0e6cf63a91
--- /dev/null
+++ b/server/src/com/vaadin/ui/Flash.java
@@ -0,0 +1,136 @@
+/*
+@VaadinApache2LicenseForJavaFiles@
+ */
+
+package com.vaadin.ui;
+
+import java.util.HashMap;
+
+import com.vaadin.shared.ui.flash.FlashState;
+
+/**
+ * Component for embedding flash objects.
+ * 
+ * @author Vaadin Ltd.
+ * @version
+ * @VERSION@
+ * @since 7.0
+ */
+@SuppressWarnings("serial")
+public class Flash extends AbstractEmbedded {
+
+    @Override
+    public FlashState getState() {
+        return (FlashState) super.getState();
+    }
+
+    /**
+     * This attribute specifies the base path used to resolve relative URIs
+     * specified by the classid, data, and archive attributes. When absent, its
+     * default value is the base URI of the current document.
+     * 
+     * @param codebase
+     *            The base path
+     */
+    public void setCodebase(String codebase) {
+        if (codebase != getState().getCodebase()
+                || (codebase != null && !codebase.equals(getState()
+                        .getCodebase()))) {
+            getState().setCodebase(codebase);
+            requestRepaint();
+        }
+    }
+
+    /**
+     * This attribute specifies the content type of data expected when
+     * downloading the object specified by classid. This attribute is optional
+     * but recommended when classid is specified since it allows the user agent
+     * to avoid loading information for unsupported content types. When absent,
+     * it defaults to the value of the type attribute.
+     * 
+     * @param codetype
+     *            the codetype to set.
+     */
+    public void setCodetype(String codetype) {
+        if (codetype != getState().getCodetype()
+                || (codetype != null && !codetype.equals(getState()
+                        .getCodetype()))) {
+            getState().setCodetype(codetype);
+            requestRepaint();
+        }
+    }
+
+    /**
+     * This attribute may be used to specify a space-separated list of URIs for
+     * archives containing resources relevant to the object, which may include
+     * the resources specified by the classid and data attributes. Preloading
+     * archives will generally result in reduced load times for objects.
+     * Archives specified as relative URIs should be interpreted relative to the
+     * codebase attribute.
+     * 
+     * @param archive
+     *            Space-separated list of URIs with resources relevant to the
+     *            object
+     */
+    public void setArchive(String archive) {
+        if (archive != getState().getArchive()
+                || (archive != null && !archive.equals(getState().getArchive()))) {
+            getState().setArchive(archive);
+            requestRepaint();
+        }
+    }
+
+    public void setStandby(String standby) {
+        if (standby != getState().getStandby()
+                || (standby != null && !standby.equals(getState().getStandby()))) {
+            getState().setStandby(standby);
+            requestRepaint();
+        }
+    }
+
+    /**
+     * Sets an object parameter. Parameters are optional information, and they
+     * are passed to the instantiated object. Parameters are are stored as name
+     * value pairs. This overrides the previous value assigned to this
+     * parameter.
+     * 
+     * @param name
+     *            the name of the parameter.
+     * @param value
+     *            the value of the parameter.
+     */
+    public void setParameter(String name, String value) {
+        if (getState().getEmbedParams() == null) {
+            getState().setEmbedParams(new HashMap<String, String>());
+        }
+        getState().getEmbedParams().put(name, value);
+        requestRepaint();
+    }
+
+    /**
+     * Gets the value of an object parameter. Parameters are optional
+     * information, and they are passed to the instantiated object. Parameters
+     * are are stored as name value pairs.
+     * 
+     * @return the Value of parameter or null if not found.
+     */
+    public String getParameter(String name) {
+        return getState().getEmbedParams() != null ? getState()
+                .getEmbedParams().get(name) : null;
+    }
+
+    /**
+     * Removes an object parameter from the list.
+     * 
+     * @param name
+     *            the name of the parameter to remove.
+     */
+    public void removeParameter(String name) {
+        if (getState().getEmbedParams() == null) {
+            return;
+        }
+        getState().getEmbedParams().remove(name);
+        requestRepaint();
+    }
+
+}
diff --git a/server/src/com/vaadin/ui/Image.java b/server/src/com/vaadin/ui/Image.java
new file mode 100644
index 0000000000..b0dbc9e629
--- /dev/null
+++ b/server/src/com/vaadin/ui/Image.java
@@ -0,0 +1,94 @@
+/*
+@VaadinApache2LicenseForJavaFiles@
+ */
+
+package com.vaadin.ui;
+
+import com.vaadin.event.MouseEvents.ClickEvent;
+import com.vaadin.event.MouseEvents.ClickListener;
+import com.vaadin.shared.EventId;
+import com.vaadin.shared.MouseEventDetails;
+import com.vaadin.shared.ui.image.ImageServerRpc;
+import com.vaadin.shared.ui.image.ImageState;
+import com.vaadin.terminal.Resource;
+
+/**
+ * Component for embedding images.
+ * 
+ * @author Vaadin Ltd.
+ * @version
+ * @VERSION@
+ * @since 7.0
+ */
+@SuppressWarnings("serial")
+public class Image extends AbstractEmbedded {
+
+    protected ImageServerRpc rpc = new ImageServerRpc() {
+        @Override
+        public void click(MouseEventDetails mouseDetails) {
+            fireEvent(new ClickEvent(Image.this, mouseDetails));
+        }
+    };
+
+    /**
+     * Creates a new empty Image.
+     */
+    public Image() {
+        registerRpc(rpc);
+    }
+
+    /**
+     * Creates a new empty Image with caption.
+     * 
+     * @param caption
+     */
+    public Image(String caption) {
+        this();
+        setCaption(caption);
+    }
+
+    /**
+     * Creates a new Image whose contents is loaded from given resource. The
+     * dimensions are assumed if possible. The type is guessed from resource.
+     * 
+     * @param caption
+     * @param source
+     *            the Source of the embedded object.
+     */
+    public Image(String caption, Resource source) {
+        this(caption);
+        setSource(source);
+    }
+
+    @Override
+    public ImageState getState() {
+        return (ImageState) super.getState();
+    }
+
+    /**
+     * Add a click listener to the component. The listener is called whenever
+     * the user clicks inside the component. Depending on the content the event
+     * may be blocked and in that case no event is fired.
+     * 
+     * Use {@link #removeListener(ClickListener)} to remove the listener.
+     * 
+     * @param listener
+     *            The listener to add
+     */
+    public void addListener(ClickListener listener) {
+        addListener(EventId.CLICK_EVENT_IDENTIFIER, ClickEvent.class, listener,
+                ClickListener.clickMethod);
+    }
+
+    /**
+     * Remove a click listener from the component. The listener should earlier
+     * have been added using {@link #addListener(ClickListener)}.
+     * 
+     * @param listener
+     *            The listener to remove
+     */
+    public void removeListener(ClickListener listener) {
+        removeListener(EventId.CLICK_EVENT_IDENTIFIER, ClickEvent.class,
+                listener);
+    }
+}