com.vaadin.ui

Class Flash

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractEmbedded

com.vaadin.ui.Flash

All Implemented Interfaces:

ContextClickEvent.ContextClickNotifier, MethodEventSource, ClientConnector, Sizeable, Connector, Component, Serializable

public class Flash
extends AbstractEmbedded

A component for displaying Adobe® Flash® content.

Since:

7.0

Version:

@VERSION@

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

Sizeable.Unit

Field Summary

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

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

Constructor Summary

Constructors

Constructor and Description
Flash() Creates a new empty Flash component.
Flash(String caption) Creates a new empty Flash component with the given caption
Flash(String caption, Resource source) Creates a new Flash component with the given caption and content.

Method Summary

Modifier and Type	Method and Description
String	getArchive() Returns current archive.
String	getCodebase() Returns the codebase.
String	getCodetype() Returns the current codetype.
String	getParameter(String name) Gets the value of an object parameter.
Iterable<String>	getParameterNames() Returns an iterable with declared parameter names.
String	getStandby() Returns standby.
protected FlashState	getState() Returns the shared state bean with information to be sent from the server to the client.
protected FlashState	getState(boolean markAsDirty) Returns the shared state for this connector.
void	readDesign(org.jsoup.nodes.Element design, DesignContext designContext) Reads the component state from the given design.
void	removeParameter(String name) Removes an object parameter from the list.
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	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	setParameter(String name, String value) Sets an object parameter.
void	setStandby(String standby) Sets standby.
void	writeDesign(org.jsoup.nodes.Element design, DesignContext designContext) Writes the component state to the given design.

Methods inherited from class com.vaadin.ui.AbstractEmbedded

getAlternateText, getCustomAttributes, getSource, setAlternateText, setSource

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getExplicitImmediateValue, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isImmediate, isOrHasAncestor, isReadOnly, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setReadOnly, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.Component

getUI

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Constructor Detail

Flash

public Flash()

Creates a new empty Flash component.

Flash

public Flash(String caption)

Creates a new empty Flash component with the given caption

Parameters:

caption - The caption for the component

Flash

public Flash(String caption,
             Resource source)

Creates a new Flash component with the given caption and content.

Parameters:

caption - The caption for the component

source - A Resource representing the Flash content that should be displayed

Method Detail

getState

protected FlashState getState()

Description copied from class: AbstractComponent

Returns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().

Overrides:

getState in class AbstractEmbedded

Returns:

updated component shared state

getState

protected FlashState getState(boolean markAsDirty)

Description copied from class: AbstractClientConnector

Returns the shared state for this connector.

Overrides:

getState in class AbstractEmbedded

Parameters:

markAsDirty - true if the connector should automatically be marked dirty, false otherwise

Returns:

The shared state for this connector. Never null.

See Also:

AbstractClientConnector.getState()

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

getCodebase

public String getCodebase()

Returns the codebase.

Returns:

Current codebase.

Since:

7.4.1

See Also:

setCodebase(String)

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.

getCodetype

public String getCodetype()

Returns the current codetype.

Returns:

Current codetype.

Since:

7.4.1

See Also:

setCodetype(String)

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

getArchive

public String getArchive()

Returns current archive.

Returns:

Current archive.

Since:

7.4.1

See Also:

setArchive(String)

setStandby

public void setStandby(String standby)

Sets standby.

Parameters:

standby - Standby string.

getStandby

public String getStandby()

Returns standby.

Returns:

Standby string.

Since:

7.4.1

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.

writeDesign

public void writeDesign(org.jsoup.nodes.Element design,
                        DesignContext designContext)

Description copied from interface: Component

Writes the component state to the given design.

The component is responsible not only for writing its own state but also for ensuring that its children write their state to the design.

This method must not modify the component state.

Specified by:

writeDesign in interface Component

Overrides:

writeDesign in class AbstractEmbedded

Parameters:

design - The element to write the component state to. Any previous attributes or child nodes are not cleared.

designContext - The DesignContext instance used for writing the design

getParameterNames

public Iterable<String> getParameterNames()

Returns an iterable with declared parameter names.

Returns:

An iterable with declared parameter names.

Since:

7.4.1

See Also:

setParameter(String, String), getParameter(String)

readDesign

public void readDesign(org.jsoup.nodes.Element design,
                       DesignContext designContext)

Description copied from interface: Component

Reads the component state from the given design.

The component is responsible not only for updating its own state but also for ensuring that its children update their state based on the design.

It is assumed that the component is in its default state when this method is called. Reading should only take into consideration attributes specified in the design and not reset any unspecified attributes to their defaults.

This method must not modify the design.

Specified by:

readDesign in interface Component

Overrides:

readDesign in class AbstractEmbedded

Parameters:

design - The element to obtain the state from

designContext - The DesignContext instance used for parsing the design