org.apache.wicket.markup.html.media

Class Track

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.media.Track

All Implemented Interfaces:

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

public class Track
extends WebMarkupContainer

The track tag is used to provide subtitles, captions, descriptions, chapters, metadata to a video media component

Since:

7.0.0

Author:

Tobias Soloschenko

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Track.Kind To be used for the kind attribute

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
Track(String id) Creates a track
Track(String id, IModel<?> model) Creates a track
Track(String id, IModel<?> model, ResourceReference resourceReference) Creates a track
Track(String id, IModel<?> model, ResourceReference resourceReference, PageParameters pageParameters) Creates a track
Track(String id, IModel<?> model, String url) Creates a track
Track(String id, ResourceReference resourceReference) Creates a track
Track(String id, ResourceReference resourceReference, PageParameters pageParameters) Creates a track
Track(String id, String url) Creates a track

Method Summary

Methods

Modifier and Type	Method and Description
Track.Kind	getKind() Gets the kind of the track belongs to the media component
String	getLabel() The label for this track
PageParameters	getPageParameters() Gets the page parameter applied to the URL of the track
Locale	getSrclang() Gets the src lang
boolean	isDefaultTrack() If the track is the default track
protected void	onComponentTag(ComponentTag tag) Processes the component tag.
void	setDefaultTrack(Boolean defaultTrack) Sets if this track is the default track
void	setKind(Track.Kind kind) Sets the kind of the track belongs to the media component SUBTITLES: Transcription or translation of the dialogue, suitable for when the sound is available but not understood (e.g.
void	setLabel(String label) Sets the label for this track
void	setPageParameters(PageParameters pageParameters) Sets the page parameter applied to the URL of the track
void	setSrclang(Locale srclang) Sets the src lang

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

Track

public Track(String id)

Creates a track

Parameters:

id - the component id

Track

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

Creates a track

Parameters:

id - the component id

model - the internally used model

Track

public Track(String id,
     ResourceReference resourceReference)

Creates a track

Parameters:

id - the component id

resourceReference - the resource reference to provide track information - like .vtt

Track

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

Creates a track

Parameters:

id - the component id

model - the internally used model

resourceReference - the resource reference to provide track information - like .vtt

Track

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

Creates a track

Parameters:

id - the component id

resourceReference - the resource reference to provide track information - like .vtt

pageParameters - the page parameters applied to the track URL

Track

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

Creates a track

Parameters:

id - the component id

model - the internally used model

resourceReference - the resource reference to provide track information - like .vtt

pageParameters - the page parameters applied to the track URL

Track

public Track(String id,
     String url)

Creates a track

Parameters:

id - the component id

url - an external URL to provide the track information

Track

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

Creates a track

Parameters:

id - the component id

model - the internally used model

url - an external URL to provide the track information

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 Component

Parameters:

tag - Tag to modify

getKind

public Track.Kind getKind()

Gets the kind of the track belongs to the media component

Returns:

the kind

See Also:

#setKind(Kind)}

setKind

public void setKind(Track.Kind kind)

Sets the kind of the track belongs to the media component

SUBTITLES: Transcription or translation of the dialogue, suitable for when the sound is available but not understood (e.g. because the user does not understand the language of the media resource's soundtrack). Displayed over the video.

CAPTIONS: Transcription or translation of the dialogue, sound effects, relevant musical cues, and other relevant audio information, suitable for when the soundtrack is unavailable (e.g. because it is muted or because the user is deaf). Displayed over the video; labeled as appropriate for the hard-of-hearing.

DESCRIPTIONS: Textual descriptions of the video component of the media resource, intended for audio synthesis when the visual component is unavailable (e.g. because the user is interacting with the application without a screen while driving, or because the user is blind). Synthesized as separate audio track.

CHAPTERS: Chapter titles, intended to be used for navigating the media resource. Displayed as an interactive list in the user agent's interface.

METADATA: Tracks intended for use from script. Not displayed by the user agent.

Parameters:

kind - the kind

getLabel

public String getLabel()

The label for this track

Returns:

the label

setLabel

public void setLabel(String label)

Sets the label for this track

Parameters:

label - the label to be set

isDefaultTrack

public boolean isDefaultTrack()

If the track is the default track

Returns:

if the track is the default track

setDefaultTrack

public void setDefaultTrack(Boolean defaultTrack)

Sets if this track is the default track

Parameters:

defaultTrack - if the track is the default track

getSrclang

public Locale getSrclang()

Gets the src lang

Returns:

the src lang

setSrclang

public void setSrclang(Locale srclang)

Sets the src lang

Parameters:

srclang - the src lang to set

getPageParameters

public PageParameters getPageParameters()

Gets the page parameter applied to the URL of the track

Returns:

the page parameter applied to the URL of the track

setPageParameters

public void setPageParameters(PageParameters pageParameters)

Sets the page parameter applied to the URL of the track

Parameters:

pageParameters - the page parameter which are going to be applied to the URL of the track