Package com.helger.html.hc.html.embedded

Class AbstractHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

java.lang.Object

com.helger.html.hc.impl.AbstractHCNode

com.helger.html.hc.html.AbstractHCElement<IMPLTYPE>

com.helger.html.hc.html.AbstractHCElementWithInternalChildren<IMPLTYPE,IHCMediaElementChild<?>>

com.helger.html.hc.html.embedded.AbstractHCMediaElement<IMPLTYPE>

All Implemented Interfaces:

com.helger.commons.hierarchy.IHasChildren<IHCNode>, com.helger.commons.hierarchy.IHasChildrenRecursive<IHCNode>, com.helger.commons.hierarchy.IHasChildrenSorted<IHCNode>, com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, IHCMediaElement<IMPLTYPE>, IHCElement<IMPLTYPE>, IHCElementWithInternalChildren<IMPLTYPE,IHCMediaElementChild<?>>, IHCHasCSSClasses<IMPLTYPE>, IHCHasCSSStyles<IMPLTYPE>, IHCHasChildrenMutable<IMPLTYPE,IHCMediaElementChild<?>>, IHCHasID<IMPLTYPE>, IHCNode, Serializable

Direct Known Subclasses:

HCAudio, HCPicture, HCVideo

public abstract class AbstractHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>
extends AbstractHCElementWithInternalChildren<IMPLTYPE,IHCMediaElementChild<?>>
implements IHCMediaElement<IMPLTYPE>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_AUTOPLAY	By default auto play is disabled
static boolean	DEFAULT_CONTROLS	By default controls are disabled
static boolean	DEFAULT_LOOP	By default loop is disabled
static boolean	DEFAULT_MUTED	By default muted is disabled

Fields inherited from class com.helger.html.hc.html.AbstractHCElement

DEFAULT_HIDDEN, DEFAULT_SPELLCHECK, DEFAULT_TRANSLATE, DEFAULT_UNFOCUSABLE

Fields inherited from interface com.helger.html.hc.html.IHCElement

DEFAULT_TABINDEX

Constructor Summary

Constructors

Constructor	Description
AbstractHCMediaElement(EHTMLElement eElement)

Method Summary

Modifier and Type	Method	Description
IMPLTYPE	addSource(HCSource aSource)
IMPLTYPE	addTrack(HCTrack aTrack)
protected void	fillMicroElement(com.helger.xml.microdom.IMicroElement aElement, IHCConversionSettingsToNode aConversionSettings)	Set all attributes and child elements of this object
protected com.helger.commons.collection.impl.ICommonsList<IHCMediaElementChild<?>>	getChildrenFormEmitting(com.helger.commons.collection.impl.ICommonsList<IHCMediaElementChild<?>> aChildren)	Helper method that returns the elements in the correct order for emitting.
EHCCORSSettings	getCrossOrigin()
EHCPreload	getPreload()
com.helger.commons.url.ISimpleURL	getSrc()
boolean	isAutoPlay()
boolean	isControls()
boolean	isLoop()
boolean	isMuted()
IMPLTYPE	setAutoPlay(boolean bAutoPlay)
IMPLTYPE	setControls(boolean bControls)
IMPLTYPE	setCrossOrigin(EHCCORSSettings eCrossOrigin)
IMPLTYPE	setLoop(boolean bLoop)
IMPLTYPE	setMuted(boolean bMuted)
IMPLTYPE	setPreload(EHCPreload ePreload)
IMPLTYPE	setSrc(com.helger.commons.url.ISimpleURL aSrc)

Methods inherited from class com.helger.html.hc.html.AbstractHCElementWithInternalChildren

addChild, addChildAt, afterAddChild, afterRemoveChild, beforeAddChild, canConvertToMicroNode, children, findFirstChild, findFirstChildMapped, forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getAllChildren, getAllChildrenAsNodeList, getChildAtIndex, getChildCount, getChildren, getFirstChild, getLastChild, getPlainText, hasChildren, removeAllChildren, removeChild, removeChildAt, sortAllChildren, toString

Methods inherited from class com.helger.html.hc.html.AbstractHCElement

addClass, addEventHandler, addStyle, containsClass, containsEventHandler, containsStyle, createMicroElement, customAttrs, finishMicroElement, getAccessKey, getAllClasses, getAllClassesAsString, getAllClassNames, getAllStyles, getAllStylesAsString, getAllStyleValues, getContentEditable, getDirection, getDraggable, getElement, getEventHandler, getEventMap, getID, getLanguage, getRole, getStyleValue, getTabIndex, getTagName, getTitle, getTranslate, hasAnyClass, hasAnyStyle, hasStyle, internalConvertToMicroNode, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, isValidID, onConsistencyCheck, onFinalizeNodeState, prependEventHandler, removeAllClasses, removeAllEventHandler, removeAllStyles, removeClass, removeStyle, setAccessKey, setContentEditable, setDirection, setDraggable, setEventHandler, setHidden, setID, setID, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setUnfocusable

Methods inherited from class com.helger.html.hc.impl.AbstractHCNode

consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, internalSetNodeState, onCustomizeNode, onRegisterExternalResources, registerExternalResources

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.commons.hierarchy.IHasChildren

forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getChildCount, getChildren, hasChildren, hasNoChildren

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenRecursive

forAllChildrenRecursive, forAllChildrenRecursive

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenSorted

findFirstChild, findFirstChildMapped, getAllChildren, getChildAtIndex, getFirstChild, getLastChild

Methods inherited from interface com.helger.html.hc.html.IHCElement

addEventHandler, containsEventHandler, customAttrs, getAccessKey, getContentEditable, getDirection, getDraggable, getElement, getEventHandler, getEventMap, getLanguage, getRole, getTabIndex, getTagName, getTitle, getTranslate, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, prependEventHandler, removeAllEventHandler, setAccessKey, setContentEditable, setDirection, setDraggable, setEventHandler, setHidden, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setTranslate, setUnfocusable, withCustomAttrs

Methods inherited from interface com.helger.html.hc.html.IHCElementWithInternalChildren

recursiveContainsChildWithTagName

Methods inherited from interface com.helger.html.hc.IHCHasChildrenMutable

addAndReturnChild, addAndReturnChildAt, addChild, addChildAt, addChildren, addChildren, addChildren, addChildrenAt, addChildrenAt, getAllChildrenAsNodeList, removeAllChildren, removeChild, removeChildAt, setChild, sortAllChildren

Methods inherited from interface com.helger.html.hc.html.IHCHasCSSClasses

addClass, addClasses, addClasses, addClasses, containsClass, getAllClasses, getAllClassesAsString, getAllClassNames, hasAnyClass, removeAllClasses, removeClass

Methods inherited from interface com.helger.html.hc.html.IHCHasCSSStyles

addStyle, addStyle, addStyles, addStyles, addStyles, containsStyle, getAllStyles, getAllStylesAsString, getAllStyleValues, getStyleValue, hasAnyStyle, hasStyle, removeAllStyles, removeStyle

Methods inherited from interface com.helger.html.hc.IHCHasID

ensureID, getID, hasID, hasNoID, setID, setUniqueID

Methods inherited from interface com.helger.html.hc.IHCNode

canConvertToMicroNode, consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, getPlainText, registerExternalResources

Field Detail

DEFAULT_AUTOPLAY

public static final boolean DEFAULT_AUTOPLAY

By default auto play is disabled

See Also:

Constant Field Values

DEFAULT_CONTROLS

public static final boolean DEFAULT_CONTROLS

By default controls are disabled

See Also:

Constant Field Values

DEFAULT_LOOP

public static final boolean DEFAULT_LOOP

By default loop is disabled

See Also:

Constant Field Values

DEFAULT_MUTED

public static final boolean DEFAULT_MUTED

By default muted is disabled

See Also:

Constant Field Values

Constructor Detail

AbstractHCMediaElement

public AbstractHCMediaElement(@Nonnull
                              EHTMLElement eElement)

Method Detail

isAutoPlay

public final boolean isAutoPlay()

Specified by:

isAutoPlay in interface IHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

setAutoPlay

@Nonnull
public final IMPLTYPE setAutoPlay(boolean bAutoPlay)

Specified by:

setAutoPlay in interface IHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

getPreload

@Nullable
public final EHCPreload getPreload()

Specified by:

getPreload in interface IHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

setPreload

@Nonnull
public final IMPLTYPE setPreload(@Nullable
                                 EHCPreload ePreload)

Specified by:

setPreload in interface IHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

isControls

public final boolean isControls()

Specified by:

isControls in interface IHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

setControls

@Nonnull
public final IMPLTYPE setControls(boolean bControls)

Specified by:

setControls in interface IHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

isLoop

public final boolean isLoop()

Specified by:

isLoop in interface IHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

setLoop

@Nonnull
public final IMPLTYPE setLoop(boolean bLoop)

Specified by:

setLoop in interface IHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

isMuted

public final boolean isMuted()

Specified by:

isMuted in interface IHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

setMuted

@Nonnull
public final IMPLTYPE setMuted(boolean bMuted)

Specified by:

setMuted in interface IHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

getSrc

@Nullable
public final com.helger.commons.url.ISimpleURL getSrc()

Specified by:

getSrc in interface IHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

setSrc

@Nonnull
public final IMPLTYPE setSrc(@Nullable
                             com.helger.commons.url.ISimpleURL aSrc)

Specified by:

setSrc in interface IHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

getCrossOrigin

@Nullable
public final EHCCORSSettings getCrossOrigin()

Specified by:

getCrossOrigin in interface IHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

setCrossOrigin

@Nonnull
public final IMPLTYPE setCrossOrigin(@Nullable
                                     EHCCORSSettings eCrossOrigin)

Specified by:

setCrossOrigin in interface IHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

addSource

@Nonnull
public final IMPLTYPE addSource(@Nullable
                                HCSource aSource)

Specified by:

addSource in interface IHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

addTrack

@Nonnull
public final IMPLTYPE addTrack(@Nullable
                               HCTrack aTrack)

Specified by:

addTrack in interface IHCMediaElement<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>>

getChildrenFormEmitting

@Nonnull
@Nonempty
protected com.helger.commons.collection.impl.ICommonsList<IHCMediaElementChild<?>> getChildrenFormEmitting(@Nonnull @Nonempty
                                                                                                           com.helger.commons.collection.impl.ICommonsList<IHCMediaElementChild<?>> aChildren)

Description copied from class: AbstractHCElementWithInternalChildren

Helper method that returns the elements in the correct order for emitting. This can e.g. be used for sorting or ordering.

Overrides:

getChildrenFormEmitting in class AbstractHCElementWithInternalChildren<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>,IHCMediaElementChild<?>>

Parameters:

aChildren - The children to be emitted. Is a direct reference to the container where the children are stored. So handle with care!

Returns:

The non-null list with all child elements to be emitted.

fillMicroElement

@OverridingMethodsMustInvokeSuper
protected void fillMicroElement(com.helger.xml.microdom.IMicroElement aElement,
                                IHCConversionSettingsToNode aConversionSettings)

Description copied from class: AbstractHCElement

Set all attributes and child elements of this object

Overrides:

fillMicroElement in class AbstractHCElementWithInternalChildren<IMPLTYPE extends AbstractHCMediaElement<IMPLTYPE>,IHCMediaElementChild<?>>

Parameters:

aElement - The current micro element to be filled. Never null.

aConversionSettings - The conversion settings to be used. Never null.