org.apache.wicket.markup.html.media.video

Class Video

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.media.MediaComponent

org.apache.wicket.markup.html.media.video.Video

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IConverterLocator, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

public class Video
extends MediaComponent

A video media component to display videos.

Since:

7.0.0

Author:

Tobias Soloschenko, Andrew Lombardi

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.markup.html.media.MediaComponent

MediaComponent.Cors, MediaComponent.Preload

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_AFTER_RENDERING, FLAG_INITIALIZED, FLAG_PREPARED_FOR_RENDER, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RENDERING, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

Constructor Summary

Constructors

Constructor and Description
Video(String id) Creates a video component
Video(String id, IModel<?> model) Creates a video component
Video(String id, IModel<?> model, ResourceReference resourceReference) Creates a video component
Video(String id, IModel<?> model, ResourceReference resourceReference, PageParameters pageParameters) Creates a video component
Video(String id, IModel<?> model, String url) Creates a video component
Video(String id, IModel<?> model, String url, PageParameters pageParameters) Creates a video component
Video(String id, ResourceReference resourceReference) Creates a video component
Video(String id, ResourceReference resourceReference, PageParameters pageParameters) Creates a media component
Video(String id, String url) Creates a video component
Video(String id, String url, PageParameters pageParameters) Creates a video component

Method Summary

Methods

Modifier and Type	Method and Description
Integer	getHeight() Gets the height of the video area
ResourceReference	getPoster() The image to be displayed if the video isn't available
PageParameters	getPosterPageParameters() Gets the posters page parameters
Integer	getWidth() Gets the width of the video area
protected void	onComponentTag(ComponentTag tag) Processes the component tag.
void	setHeight(Integer height) Sets the height of the video area
void	setPoster(ResourceReference poster) Sets the image to be displayed if the video isn't available
void	setPoster(ResourceReference poster, PageParameters posterPageParameters) Sets the image to be displayed if the video isn't available
void	setPosterPageParameters(PageParameters posterPageParameters) Sets the posters page parameters
void	setWidth(Integer width) Sets the width of the video area

Methods inherited from class org.apache.wicket.markup.html.media.MediaComponent

getCrossOrigin, getEndTime, getMediaGroup, getPageParameters, getPreload, getStartTime, getType, hasControls, isAutoplay, isLooping, isMuted, setAutoplay, setControls, setCrossOrigin, setEndTime, setLooping, setMediaGroup, setMuted, setPageParameters, setPreload, setStartTime, setType

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onComponentTagBody, onDetach, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterfaceAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

Video

public Video(String id)

Creates a video component

Parameters:

id - the component id

Video

public Video(String id,
     IModel<?> model)

Creates a video component

Parameters:

id - the component id

model - the internally used model

Video

public Video(String id,
     ResourceReference resourceReference)

Creates a video component

Parameters:

id - the component id

resourceReference - the resource reference of the video file

Video

public Video(String id,
     IModel<?> model,
     ResourceReference resourceReference)

Creates a video component

Parameters:

id - the component id

model - the internally used model

resourceReference - the resource reference of the video file

Video

public Video(String id,
     ResourceReference resourceReference,
     PageParameters pageParameters)

Creates a media component

Parameters:

id - the component id

resourceReference - the resource reference of the video file

pageParameters - the page parameters to be used to be prepended to the video URL

Video

public Video(String id,
     IModel<?> model,
     ResourceReference resourceReference,
     PageParameters pageParameters)

Creates a video component

Parameters:

id - the component id

model - the internally used model

resourceReference - the resource reference of the video file

pageParameters - the page parameters to be used to be prepended to the video URL

Video

public Video(String id,
     String url)

Creates a video component

Parameters:

id - the component id

url - an external URL to be used for the video component

Video

public Video(String id,
     IModel<?> model,
     String url)

Creates a video component

Parameters:

id - the component id

model - the internally used model

url - an external URL to be used for the video component

Video

public Video(String id,
     String url,
     PageParameters pageParameters)

Creates a video component

Parameters:

id - the component id

url - an external URL to be used for the video component

pageParameters - the page parameters to be used to be prepended to the video URL

Video

public Video(String id,
     IModel<?> model,
     String url,
     PageParameters pageParameters)

Creates a video component

Parameters:

id - the component id

model - the internally used model

url - an external URL to be used for the video component

pageParameters - the page parameters to be used to be prepended to the video URL

Method Detail

onComponentTag

protected void onComponentTag(ComponentTag tag)

Description copied from class: Component

Processes the component tag. Overrides of this method most likely should call the super implementation.

Overrides:

onComponentTag in class MediaComponent

Parameters:

tag - Tag to modify

getPoster

public ResourceReference getPoster()

The image to be displayed if the video isn't available

Returns:

the resource reference of the image

getPosterPageParameters

public PageParameters getPosterPageParameters()

Gets the posters page parameters

Returns:

the page parameters for the poster

setPosterPageParameters

public void setPosterPageParameters(PageParameters posterPageParameters)

Sets the posters page parameters

Parameters:

posterPageParameters - the page parameters for the poster

setPoster

public void setPoster(ResourceReference poster)

Sets the image to be displayed if the video isn't available

Parameters:

poster - the resource reference of the image used if the video isn't available

setPoster

public void setPoster(ResourceReference poster,
             PageParameters posterPageParameters)

Sets the image to be displayed if the video isn't available

Parameters:

poster - the resource reference of the image used if the video isn't available

posterPageParameters - the page parameters for the poster

getWidth

public Integer getWidth()

Gets the width of the video area

Returns:

the width of the video area

setWidth

public void setWidth(Integer width)

Sets the width of the video area

Parameters:

width - the width of the video area

getHeight

public Integer getHeight()

Gets the height of the video area

Returns:

the height of the video area

setHeight

public void setHeight(Integer height)

Sets the height of the video area

Parameters:

height - the height of the video area