org.icefaces.ace.component.videoplayer

Class VideoPlayerBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.icefaces.ace.component.videoplayer.VideoPlayerBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, IVideoPlayer

Direct Known Subclasses:

VideoPlayer

public abstract class VideoPlayerBase
extends javax.faces.component.UIComponentBase
implements IVideoPlayer

videoPlayer renders a video player to play back videos. The component can be bound to a variety of source types.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	VideoPlayerBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
VideoPlayerBase()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFamily()
int	getHeight() Return the value of the height property.
java.lang.String	getLibrary() Return the value of the library property.
java.lang.String	getLinkLabel() Return the value of the linkLabel property.
java.lang.String	getName() Return the value of the name property.
java.lang.String	getPoster() Return the value of the poster property.
java.lang.String	getPreload() Return the value of the preload property.
java.lang.String	getScope() Return the value of the scope property.
java.lang.String	getSrcAttribute() Return the value of the srcAttribute property.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.lang.String	getType() Return the value of the type property.
java.lang.String	getUrl() Return the value of the url property.
java.lang.Object	getValue() Return the value of the value property.
int	getWidth() Return the value of the width property.
boolean	isAutoplay() Return the value of the autoplay property.
boolean	isControls() Return the value of the controls property.
boolean	isLoop() Return the value of the loop property.
boolean	isMuted() Return the value of the muted property.
boolean	isPlaysinline() Return the value of the playsinline property.
protected boolean	isPropertySet(java.lang.String finder)
void	setAutoplay(boolean autoplay) Set the value of the autoplay property.
void	setControls(boolean controls) Set the value of the controls property.
void	setHeight(int height) Set the value of the height property.
void	setLibrary(java.lang.String library) Set the value of the library property.
void	setLinkLabel(java.lang.String linkLabel) Set the value of the linkLabel property.
void	setLoop(boolean loop) Set the value of the loop property.
void	setMuted(boolean muted) Set the value of the muted property.
void	setName(java.lang.String name) Set the value of the name property.
void	setPlaysinline(boolean playsinline) Set the value of the playsinline property.
void	setPoster(java.lang.String poster) Set the value of the poster property.
void	setPreload(java.lang.String preload) Set the value of the preload property.
void	setScope(java.lang.String scope) Set the value of the scope property.
void	setSrcAttribute(java.lang.String srcAttribute) Set the value of the srcAttribute property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setType(java.lang.String type) Set the value of the type property.
void	setUrl(java.lang.String url) Set the value of the url property.
void	setValue(java.lang.Object value) Set the value of the value property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)
void	setWidth(int width) Set the value of the width property.

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

VideoPlayerBase

public VideoPlayerBase()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

setAutoplay

public void setAutoplay(boolean autoplay)

Set the value of the autoplay property.

Contents: Will cause the media to automatically play when the page is load. This may be required for some older devices to play.

Specified by:

setAutoplay in interface IVideoPlayer

isAutoplay

public boolean isAutoplay()

Return the value of the autoplay property.

Contents: Will cause the media to automatically play when the page is load. This may be required for some older devices to play. Default = 'false'.

Specified by:

isAutoplay in interface IVideoPlayer

setControls

public void setControls(boolean controls)

Set the value of the controls property.

Contents: If "true", will render the media controls.

Specified by:

setControls in interface IVideoPlayer

isControls

public boolean isControls()

Return the value of the controls property.

Contents: If "true", will render the media controls. Default = 'true'.

Specified by:

isControls in interface IVideoPlayer

setHeight

public void setHeight(int height)

Set the value of the height property.

Contents: The maximum height of video area.

Specified by:

setHeight in interface IVideoPlayer

getHeight

public int getHeight()

Return the value of the height property.

Contents: The maximum height of video area. Default = 'Integer.MIN_VALUE'.

Specified by:

getHeight in interface IVideoPlayer

setLibrary

public void setLibrary(java.lang.String library)

Set the value of the library property.

Contents: The library used for JSF Resource registration.

Specified by:

setLibrary in interface IVideoPlayer

getLibrary

public java.lang.String getLibrary()

Return the value of the library property.

Contents: The library used for JSF Resource registration.

Specified by:

getLibrary in interface IVideoPlayer

setLinkLabel

public void setLinkLabel(java.lang.String linkLabel)

Set the value of the linkLabel property.

Contents: For certain devices, this adds the ability for a link to launch a system media player. If this attribute is present thelink will appear with this text as the label.

Specified by:

setLinkLabel in interface IVideoPlayer

getLinkLabel

public java.lang.String getLinkLabel()

Return the value of the linkLabel property.

Contents: For certain devices, this adds the ability for a link to launch a system media player. If this attribute is present thelink will appear with this text as the label.

Specified by:

getLinkLabel in interface IVideoPlayer

setLoop

public void setLoop(boolean loop)

Set the value of the loop property.

Contents: If "true", will play the the audio file repeatedly.

Specified by:

setLoop in interface IVideoPlayer

isLoop

public boolean isLoop()

Return the value of the loop property.

Contents: If "true", will play the the audio file repeatedly. Default = 'false'.

Specified by:

isLoop in interface IVideoPlayer

setMuted

public void setMuted(boolean muted)

Set the value of the muted property.

Contents: audio will be muted if true for html5 compliant desktop browsers only. Default is false

Specified by:

setMuted in interface IVideoPlayer

isMuted

public boolean isMuted()

Return the value of the muted property.

Contents: audio will be muted if true for html5 compliant desktop browsers only. Default is false Default = 'false'.

Specified by:

isMuted in interface IVideoPlayer

setName

public void setName(java.lang.String name)

Set the value of the name property.

Contents: The name is used for JSF Resource registration.

Specified by:

setName in interface IVideoPlayer

getName

public java.lang.String getName()

Return the value of the name property.

Contents: The name is used for JSF Resource registration.

Specified by:

getName in interface IVideoPlayer

setPlaysinline

public void setPlaysinline(boolean playsinline)

Set the value of the playsinline property.

Contents: Allows webkit supported browsers to play back the video inline rather than a new window.

Specified by:

setPlaysinline in interface IVideoPlayer

isPlaysinline

public boolean isPlaysinline()

Return the value of the playsinline property.

Contents: Allows webkit supported browsers to play back the video inline rather than a new window.

Specified by:

isPlaysinline in interface IVideoPlayer

setPoster

public void setPoster(java.lang.String poster)

Set the value of the poster property.

Contents: display a static photo until the video is played

Specified by:

setPoster in interface IVideoPlayer

getPoster

public java.lang.String getPoster()

Return the value of the poster property.

Contents: display a static photo until the video is played

Specified by:

getPoster in interface IVideoPlayer

setPreload

public void setPreload(java.lang.String preload)

Set the value of the preload property.

Contents: Options for preloading the resource. Accepted values are "auto" (allow the browser to decide), "none" or "metadata" (preload only the metadata).

Specified by:

setPreload in interface IVideoPlayer

getPreload

public java.lang.String getPreload()

Return the value of the preload property.

Contents: Options for preloading the resource. Accepted values are "auto" (allow the browser to decide), "none" or "metadata" (preload only the metadata). Default = 'auto'.

Specified by:

getPreload in interface IVideoPlayer

setScope

public void setScope(java.lang.String scope)

Set the value of the scope property.

Contents: The JSF Resource scope of the object resolving from the "value" attribute. It is only applicable when using a byte array or an instance of IceOutputResource as the value. Possible values are "flash", "request", "view", "session", and "application".

Specified by:

setScope in interface IVideoPlayer

getScope

public java.lang.String getScope()

Return the value of the scope property.

Contents: The JSF Resource scope of the object resolving from the "value" attribute. It is only applicable when using a byte array or an instance of IceOutputResource as the value. Possible values are "flash", "request", "view", "session", and "application". Default = 'session'.

Specified by:

getScope in interface IVideoPlayer

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Contents: Sets the CSS style definition to be applied to this component.

Specified by:

setStyle in interface IVideoPlayer

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: Sets the CSS style definition to be applied to this component.

Specified by:

getStyle in interface IVideoPlayer

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: Sets the CSS class to apply to this component.

Specified by:

setStyleClass in interface IVideoPlayer

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: Sets the CSS class to apply to this component.

Specified by:

getStyleClass in interface IVideoPlayer

setType

public void setType(java.lang.String type)

Set the value of the type property.

Contents: The mime type of media file.

Specified by:

setType in interface IVideoPlayer

getType

public java.lang.String getType()

Return the value of the type property.

Contents: The mime type of media file.

Specified by:

getType in interface IVideoPlayer

setUrl

public void setUrl(java.lang.String url)

Set the value of the url property.

Contents: The URL or src of the media file. If the "value" attribute is empty, the "url" attribute will be used.

Specified by:

setUrl in interface IVideoPlayer

getUrl

public java.lang.String getUrl()

Return the value of the url property.

Contents: The URL or src of the media file. If the "value" attribute is empty, the "url" attribute will be used.

Specified by:

getUrl in interface IVideoPlayer

setValue

public void setValue(java.lang.Object value)

Set the value of the value property.

Contents: The media source. The value may resolve to a byte array, the String of a file name, or a JSF Resource, if used in JSF project

Specified by:

setValue in interface IVideoPlayer

getValue

public java.lang.Object getValue()

Return the value of the value property.

Contents: The media source. The value may resolve to a byte array, the String of a file name, or a JSF Resource, if used in JSF project

Specified by:

getValue in interface IVideoPlayer

setWidth

public void setWidth(int width)

Set the value of the width property.

Contents: The maximum width of video area.

Specified by:

setWidth in interface IVideoPlayer

getWidth

public int getWidth()

Return the value of the width property.

Contents: The maximum width of video area. Default = 'Integer.MIN_VALUE'.

Specified by:

getWidth in interface IVideoPlayer

setSrcAttribute

public void setSrcAttribute(java.lang.String srcAttribute)

Set the value of the srcAttribute property.

Specified by:

setSrcAttribute in interface IVideoPlayer

getSrcAttribute

public java.lang.String getSrcAttribute()

Return the value of the srcAttribute property.

Specified by:

getSrcAttribute in interface IVideoPlayer

isPropertySet

protected boolean isPropertySet(java.lang.String finder)

setValueExpression

public void setValueExpression(java.lang.String name,
                      javax.el.ValueExpression binding)

Overrides:

setValueExpression in class javax.faces.component.UIComponent