com.vaadin.ui

Class Video

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractMedia

com.vaadin.ui.Video

All Implemented Interfaces:

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

public class Video
extends AbstractMedia

The Video component translates into an HTML5 <video> element and as such is only supported in browsers that support HTML5 media markup. Browsers that do not support HTML5 display the text or HTML set by calling AbstractMedia.setAltText(String). A flash-player fallback can be implemented by setting HTML content allowed ( AbstractMedia.setHtmlContentAllowed(boolean) and calling AbstractMedia.setAltText(String) with the flash player markup. An example of flash fallback can be found at the Mozilla Developer Network. Multiple sources can be specified. Which of the sources is used is selected by the browser depending on which file formats it supports. See wikipedia for a table of formats supported by different browsers.

Since:

6.7.0

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
Video()
Video(String caption)
Video(String caption, Resource source)

Method Summary

Modifier and Type	Method and Description
protected Collection<String>	getCustomAttributes() Returns a collection of attributes that should not be handled by the basic implementation of the AbstractComponent.readDesign(Element, DesignContext) and AbstractComponent.writeDesign(Element, DesignContext) methods.
Resource	getPoster()
protected VideoState	getState() Returns the shared state bean with information to be sent from the server to the client.
protected VideoState	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	setPoster(Resource poster) Sets the poster image, which is shown in place of the video before the user presses play.
void	writeDesign(org.jsoup.nodes.Element design, DesignContext designContext) Writes the component state to the given design.

Methods inherited from class com.vaadin.ui.AbstractMedia

addSource, getAltText, getPreload, getSources, handleConnectorRequest, isAutoplay, isHtmlContentAllowed, isLoop, isMuted, isShowControls, pause, play, setAltText, setAutoplay, setHtmlContentAllowed, setLoop, setMuted, setPreload, setShowControls, setSource, setSources

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, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, 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, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.Component

addStyleNames, getUI, removeStyleNames, setStyleName

Methods inherited from interface com.vaadin.server.ClientConnector

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

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Constructor Detail

Video

public Video()

Video

public Video(String caption)

Parameters:

caption - The caption for this video.

Video

public Video(String caption,
             Resource source)

Parameters:

caption - The caption for this video.

source - The Resource containing the video to play.

Method Detail

setPoster

public void setPoster(Resource poster)

Sets the poster image, which is shown in place of the video before the user presses play.

Parameters:

poster -

getPoster

public Resource getPoster()

Returns:

The poster image.

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 AbstractMedia

Parameters:

design - The element to obtain the state from

designContext - The DesignContext instance used for parsing the design

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 AbstractMedia

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

getCustomAttributes

protected Collection<String> getCustomAttributes()

Description copied from class: AbstractComponent

Returns a collection of attributes that should not be handled by the basic implementation of the AbstractComponent.readDesign(Element, DesignContext) and AbstractComponent.writeDesign(Element, DesignContext) methods. Typically these are handled in a custom way in the overridden versions of the above methods

Overrides:

getCustomAttributes in class AbstractMedia

Returns:

the collection of attributes that are not handled by the basic implementation

getState

protected VideoState 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 AbstractMedia

Returns:

updated component shared state

getState

protected VideoState getState(boolean markAsDirty)

Description copied from class: AbstractClientConnector

Returns the shared state for this connector.

Overrides:

getState in class AbstractMedia

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()