com.vaadin.ui
Class Embedded

java.lang.Object
  com.vaadin.ui.AbstractComponent
      com.vaadin.ui.Embedded

All Implemented Interfaces:

MethodEventSource, Paintable, Sizeable, VariableOwner, Component, Serializable, EventListener

public class Embedded
extends AbstractComponent

Component for embedding external objects.

Since:

3.0

Version:

6.8.18

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent

AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.terminal.Paintable

Paintable.RepaintRequestEvent, Paintable.RepaintRequestListener

Field Summary

static int	TYPE_BROWSER Browser ("iframe") type.
static int	TYPE_IMAGE Image types.
static int	TYPE_OBJECT General object type.

Fields inherited from interface com.vaadin.terminal.Sizeable

SIZE_UNDEFINED, UNIT_SYMBOLS, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Embedded()
Creates a new empty Embedded object.

Embedded(String caption)
Creates a new empty Embedded object with caption.

Embedded(String caption, Resource source)
Creates a new Embedded object whose contents is loaded from given resource.

Method Summary

void	addListener(MouseEvents.ClickListener listener) Add a click listener to the component.
void	changeVariables(Object source, Map<String,Object> variables) Called when one or more variables handled by the implementing class are changed.
String	getAlternateText() Gets this component's "alt-text".
String	getArchive() 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.
String	getClassId() This attribute may be used to specify the location of an object's implementation via a URI.
String	getCodebase() This attribute specifies the base path used to resolve relative URIs specified by the classid, data, and archive attributes.
String	getCodetype() Gets the MIME-Type of the code.
String	getMimeType() Gets the MIME-Type of the object.
String	getParameter(String name) Gets the value of an object parameter.
Iterator<String>	getParameterNames() Gets the embedded object parameter names.
Resource	getSource() Gets the resource contained in the embedded object.
String	getStandby() This attribute specifies a message that a user agent may render while loading the object's implementation and data.
int	getType() Gets the type of the embedded object.
void	paintContent(PaintTarget target) Invoked when the component state should be painted.
void	removeListener(MouseEvents.ClickListener listener) Remove a click listener from the component.
void	removeParameter(String name) Removes an object parameter from the list.
void	setAlternateText(String altText) Sets this component's "alt-text", that is, an alternate text that can be presented instead of this component's normal content, for accessibility purposes.
void	setArchive(String archive) 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.
void	setClassId(String classId) This attribute may be used to specify the location of an object's implementation via a URI.
void	setCodebase(String codebase) This attribute specifies the base path used to resolve relative URIs specified by the classid, data, and archive attributes.
void	setCodetype(String codetype) This attribute specifies the content type of data expected when downloading the object specified by classid.
void	setMimeType(String mimeType) Sets the mimeType, the MIME-Type of the object.
void	setParameter(String name, String value) Sets an object parameter.
void	setSource(Resource source) Sets the object source resource.
void	setStandby(String standby) This attribute specifies a message that a user agent may render while loading the object's implementation and data.
void	setType(int type) Sets the object type.

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addListener, addListener, addListener, addListener, addStyleName, attach, childRequestedRepaint, detach, fireComponentErrorEvent, fireComponentEvent, fireEvent, focus, getApplication, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getErrorMessage, getHeight, getHeightUnits, getIcon, getListeners, getLocale, getParent, getStyle, getStyleName, getWidth, getWidthUnits, getWindow, handleError, hasListeners, isEnabled, isImmediate, isReadOnly, isVisible, paint, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeStyleName, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDebugId, setDescription, setEnabled, setErrorHandler, setHeight, setHeight, setHeight, setHeightUnits, setIcon, setImmediate, setLocale, setParent, setReadOnly, setSizeFull, setSizeUndefined, setStyle, setStyleName, setVisible, setWidth, setWidth, setWidth, setWidthUnits

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_OBJECT

public static final int TYPE_OBJECT

General object type.

See Also:

Constant Field Values

TYPE_IMAGE

public static final int TYPE_IMAGE

Image types.

See Also:

Constant Field Values

TYPE_BROWSER

public static final int TYPE_BROWSER

Browser ("iframe") type.

See Also:

Constant Field Values

Constructor Detail

Embedded

public Embedded()

Creates a new empty Embedded object.

Embedded

public Embedded(String caption)

Creates a new empty Embedded object with caption.

Parameters:

caption -

Embedded

public Embedded(String caption,
                Resource source)

Creates a new Embedded object whose contents is loaded from given resource. The dimensions are assumed if possible. The type is guessed from resource.

Parameters:

caption -

source - the Source of the embedded object.

Method Detail

paintContent

public void paintContent(PaintTarget target)
                  throws PaintException

Invoked when the component state should be painted.

Overrides:

paintContent in class AbstractComponent

Parameters:

target - the target UIDL stream where the component should paint itself to

Throws:

PaintException - if the paint operation failed.

setAlternateText

public void setAlternateText(String altText)

Sets this component's "alt-text", that is, an alternate text that can be presented instead of this component's normal content, for accessibility purposes. Does not work when setType(int) has been called with TYPE_BROWSER.

Parameters:

altText - A short, human-readable description of this component's content.

Since:

6.8

getAlternateText

public String getAlternateText()

Gets this component's "alt-text".

See Also:

setAlternateText(String)

setParameter

public void setParameter(String name,
                         String value)

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.

Parameters:

name - the name of the parameter.

value - the value of the parameter.

getParameter

public String getParameter(String name)

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.

Returns:

the Value of parameter or null if not found.

removeParameter

public void removeParameter(String name)

Removes an object parameter from the list.

Parameters:

name - the name of the parameter to remove.

getParameterNames

public Iterator<String> getParameterNames()

Gets the embedded object parameter names.

Returns:

the Iterator of parameters names.

getCodebase

public String getCodebase()

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.

Returns:

the code base.

getCodetype

public String getCodetype()

Gets the MIME-Type of the code.

Returns:

the MIME-Type of the code.

getMimeType

public String getMimeType()

Gets the MIME-Type of the object.

Returns:

the MIME-Type of the object.

getStandby

public String getStandby()

This attribute specifies a message that a user agent may render while loading the object's implementation and data.

Returns:

The text displayed when loading

setCodebase

public void setCodebase(String codebase)

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.

Parameters:

codebase - The base path

setCodetype

public void setCodetype(String codetype)

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.

Parameters:

codetype - the codetype to set.

setMimeType

public void setMimeType(String mimeType)

Sets the mimeType, the MIME-Type of the object.

Parameters:

mimeType - the mimeType to set.

setStandby

public void setStandby(String standby)

This attribute specifies a message that a user agent may render while loading the object's implementation and data.

Parameters:

standby - The text to display while loading

getClassId

public String getClassId()

This attribute may be used to specify the location of an object's implementation via a URI.

Returns:

the classid.

setClassId

public void setClassId(String classId)

This attribute may be used to specify the location of an object's implementation via a URI.

Parameters:

classId - the classId to set.

getSource

public Resource getSource()

Gets the resource contained in the embedded object.

Returns:

the Resource

getType

public int getType()

Gets the type of the embedded object.

This can be one of the following:

• TYPE_OBJECT (This is the default)
• TYPE_IMAGE

Returns:

the type.

setSource

public void setSource(Resource source)

Sets the object source resource. The dimensions are assumed if possible. The type is guessed from resource.

Parameters:

source - the source to set.

setType

public void setType(int type)

Sets the object type.

This can be one of the following:

• TYPE_OBJECT (This is the default)
• TYPE_IMAGE
• TYPE_BROWSER

Parameters:

type - the type to set.

getArchive

public String getArchive()

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.

Returns:

Space-separated list of URIs with resources relevant to the object

setArchive

public void setArchive(String archive)

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.

Parameters:

archive - Space-separated list of URIs with resources relevant to the object

addListener

public void addListener(MouseEvents.ClickListener listener)

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 #removeListener(ClickListener) to remove the listener.

Parameters:

listener - The listener to add

removeListener

public void removeListener(MouseEvents.ClickListener listener)

Remove a click listener from the component. The listener should earlier have been added using #addListener(ClickListener).

Parameters:

listener - The listener to remove

changeVariables

public void changeVariables(Object source,
                            Map<String,Object> variables)

Description copied from interface: VariableOwner

Called when one or more variables handled by the implementing class are changed.

Specified by:

changeVariables in interface VariableOwner

Overrides:

changeVariables in class AbstractComponent

Parameters:

source - the Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.

variables - the Mapping from variable names to new variable values.