com.vaadin.fluent.api

Interface FluentMedia<THIS extends FluentMedia<THIS>>

Type Parameters:

THIS - Self-referential generic THIS

All Superinterfaces:

com.vaadin.server.ClientConnector, com.vaadin.ui.Component, com.vaadin.shared.Connector, com.vaadin.event.ContextClickEvent.ContextClickNotifier, FluentAbstractComponent<THIS>, FluentClientConnector<THIS>, FluentComponent<THIS>, FluentContextClickNotifier<THIS>, FluentSizeable<THIS>, Serializable, com.vaadin.server.Sizeable

All Known Subinterfaces:

FluentAudio<THIS>, FluentVideo<THIS>

All Known Implementing Classes:

FAudio, FVideo

public interface FluentMedia<THIS extends FluentMedia<THIS>>
extends FluentAbstractComponent<THIS>

The base interface for fluent versions of AbstractMedia

See Also:

AbstractMedia

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.fluent.api.FluentComponent

FluentComponent.FluentFocusable<C extends FluentComponent.FluentFocusable<C>>

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

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

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

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

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

com.vaadin.server.Sizeable.Unit

Field Summary

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

Method Summary

Modifier and Type	Method and Description
default THIS	withAltText(String altText) Sets the alternative text to be displayed if the browser does not support HTML5.
default THIS	withAutoplay(boolean autoplay) Sets whether the media is to automatically start playback when enough data has been loaded.
default THIS	withHtmlContentAllowed(boolean htmlContentAllowed) Set whether the alternative text (AbstractMedia.setAltText(String)) is rendered as HTML or not.
default THIS	withLoop(boolean loop) Enables or disables looping.
default THIS	withMuted(boolean muted) Set whether to mute the audio or not.
default THIS	withPreload(com.vaadin.shared.ui.PreloadMode preload) Sets the preload attribute that is intended to provide a hint to the browser how the media should be preloaded.
default THIS	withShowControls(boolean showControls) Sets whether or not the browser should show native media controls.
default THIS	withSource(com.vaadin.server.Resource source) Sets a single media file as the source of the media component.
default THIS	withSources(com.vaadin.server.Resource... sources) Set multiple sources at once.

Methods inherited from interface com.vaadin.fluent.api.FluentAbstractComponent

withCaption, withCaptionAsHtml, withComponentError, withData, withDescription, withDescription, withLocale, withResponsive, withShortcutListener, withStyleName

Methods inherited from interface com.vaadin.fluent.api.FluentComponent

withCaption, withEnabled, withIcon, withId, withParent, withPrimaryStyleName, withStyleName, withStyleName, withVisible

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

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

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.fluent.api.FluentSizeable

withFullHeight, withFullSize, withFullWidth, withHeight, withHeight, withSize, withUndefinedHeight, withUndefinedSize, withUndefinedWidth, withWidth, withWidth

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface com.vaadin.fluent.api.FluentClientConnector

withAttachListener, withDetachListener

Methods inherited from interface com.vaadin.fluent.api.FluentContextClickNotifier

withContextClickListener

Methods inherited from interface com.vaadin.event.ContextClickEvent.ContextClickNotifier

addContextClickListener, removeContextClickListener

Method Detail

withAltText

default THIS withAltText(String altText)

Sets the alternative text to be displayed if the browser does not support HTML5. This text is rendered as HTML if withHtmlContentAllowed(boolean) is set to true. With HTML rendering, this method can also be used to implement fallback to a flash-based player, see the Mozilla Developer Network for details.

Parameters:

altText - the alternate text if video is unavailable

Returns:

this for method chaining

See Also:

AbstractMedia.setAltText(String)

withAutoplay

default THIS withAutoplay(boolean autoplay)

Sets whether the media is to automatically start playback when enough data has been loaded.

Parameters:

autoplay - if true, enable autoplay

Returns:

this for method chaining

See Also:

AbstractMedia.setAutoplay(boolean)

withHtmlContentAllowed

default THIS withHtmlContentAllowed(boolean htmlContentAllowed)

Set whether the alternative text (AbstractMedia.setAltText(String)) is rendered as HTML or not.

Parameters:

htmlContentAllowed - true if alternated text may contain html, false otherwise

Returns:

this for method chaining

See Also:

AbstractMedia.setHtmlContentAllowed(boolean)

withLoop

default THIS withLoop(boolean loop)

Enables or disables looping.

Parameters:

loop - if true, enable looping

Returns:

this for method chaining

See Also:

AbstractMedia.setLoop(boolean)

withMuted

default THIS withMuted(boolean muted)

Set whether to mute the audio or not.

Parameters:

muted - if true, media is muted

Returns:

this for method chaining

See Also:

AbstractMedia.setMuted(boolean)

withPreload

default THIS withPreload(com.vaadin.shared.ui.PreloadMode preload)

Sets the preload attribute that is intended to provide a hint to the browser how the media should be preloaded. Valid values are 'none', 'metadata', 'preload', see the Mozilla Developer Network for details.

Parameters:

preload - preload mode

Returns:

this for method chaining

See Also:

AbstractMedia.setPreload(PreloadMode)

withShowControls

default THIS withShowControls(boolean showControls)

Sets whether or not the browser should show native media controls.

Parameters:

showControls - if true, controls are visible

Returns:

this for method chaining

See Also:

AbstractMedia.setShowControls(boolean)

withSource

default THIS withSource(com.vaadin.server.Resource source)

Sets a single media file as the source of the media component.

Parameters:

source - the media source

Returns:

this for method chaining

See Also:

AbstractMedia.setSource(Resource)

withSources

default THIS withSources(com.vaadin.server.Resource... sources)

Set multiple sources at once. 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.

Parameters:

sources - the media sources

Returns:

this for method chaining

See Also:

AbstractMedia.setSources(Resource...)