zkmax.med

Class Video

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zkmax.med.Video

public class Video
extends Widget

A video player Only works for browsers supporting HTML5 video tag.

Since:

8.6.0

Author:

charlesqiu

Field Summary

Fields inherited from class zk.Widget

$weave, auDelay, autag, bindLevel, className, desktop, effects_, firstChild, id, insertingBefore_, inServer, lastChild, nChildren, nextSibling, parent, previousSibling, uuid, widgetName

Fields inherited from class zk.Object

$class, $oid

Method Summary

Modifier and Type	Method and Description
void	enableFullScreen() Use full screen mode.
String	getCrossorigin() Returns the crossorigin of this video tag.
double	getPlaybackRate() Returns the video play speed.
String	getPlaysinline() Returns the playsinline of this video tag.
String	getPoster() Returns whether to display a poster before the video play.
String	getPreload() Returns whether and how the video should be loaded.
String	getSrc() Returns the video source.
double	getVolume() Returns the volume of video.
boolean	isAutoplay() Returns whether to auto start playing the video.
boolean	isClipToFit() Return whether to clip video when the source size doesn't fit the tag size setting, for example: if video source is 1280 * 720, but the video tag is <video width="1000px" height="720px" />, it will cut off the sides of the video, preserving the aspect ratio, and also filling in the space.
boolean	isControls() Returns whether to display the video controls.
boolean	isDimBackground() Returns whether to turn whole page to be covered by translucent black except the Video, also called theater mode.
boolean	isLoop() Returns whether to play the video repeatedly.
boolean	isMuted() Returns whether the video is muted.
void	setAutoplay(boolean autoplay) Sets whether to auto start playing the video.
void	setClipToFit(boolean clipToFit) Set whether to clip video when the source size doesn't fit the tag size setting, for example: if video source is 1280 * 720, but the video tag is <video width="1000px" height="720px" />, it will cut off the sides of the video, preserving the aspect ratio, and also filling in the space.
void	setControls(boolean controls) Sets whether to display the video controls.
void	setCrossorigin(String crossorigin) Sets the crossorigin of this video tag.
void	setCurrentTime(double currentTime) Sets which part of video to play.
void	setDimBackground(boolean dimBackground) Sets whether to turn whole page to be covered by translucent black except the Video, also called theater mode.
void	setLoop(boolean loop) Sets whether to play the video repeatedly.
void	setMuted(boolean muted) Sets whether to mute the video.
void	setPlaybackRate(double playbackRate) Sets the video play speed, type of value is in double, valid value is depending on browser.
void	setPlaying(boolean playing) Sets whether the video is playing.
void	setPlaysinline(String playsinline) Sets the playsinline of this video tag.
void	setPoster(String poster) Sets whether to display a poster before the video play.
void	setPreload(String preload) Sets whether and how the video should be loaded, which could be one of "none", "metadata", "auto".
void	setSrc(String src) Sets the video source.
void	setVolume(double volume) Sets the volume of video.
void	toggleLight(boolean lightOff) Toggle the theater mode by add or remove Class.

Methods inherited from class zul.Widget

afterKeyDown_, beforeCtrlKeys_, getContext, getCtrlKeys, getOpenTooltip, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class zk.Widget

$, $f, $f, $f, $init, $n, $n, $o, $s, $service, afterAnima_, afterParentChanged_, appendChild, appendChild, beforeParentChanged_, beforeSendAU_, bind_, bind, bindChildren_, bindDoubleTap_, bindMissingAncestors, bindSwipe_, bindTapHold_, canActivate, cleanDrag_, clear, clearCache, cloneDrag_, deferRedraw_, deferRedrawHTML_, detach, doBlur_, doClick_, doDoubleClick_, doFocus_, doKeyDown_, doKeyPress_, doKeyUp_, domAttrs_, domClass_, domListen_, doMouseDown_, doMouseMove_, doMouseOut_, doMouseOver_, doMouseUp_, domStyle_, domTextStyleAttr_, domTooltiptext_, domUnlisten_, doPaste_, doResizeScroll_, doRightClick_, doSelect_, doSwipe_, doTooltipOut_, doTooltipOver_, dropEffect_, extraBind_, fire, fireX, focus_, focus, forcerender, fromPageCoord, get, getAction, getCaveNode, getChildAt, getChildIndex, getClass, getCssflex, getDraggable, getDragMessage_, getDragNode, getDragOptions_, getDrop_, getDroppable, getElementsById, getElementsByName, getFirstNode_, getFloatZIndex_, getHeight, getHflex, getId, getLeft, getMold, getOldWidget_, getPage, getRenderdefer, getSclass, getScrollLeft, getScrollTop, getStyle, getTabindex, getTextNode, getTooltiptext, getTop, getTopWidget, getVflex, getWidth, getZclass, getZIndex, hide, ignoreDescendantFloatUp_, ignoreDrag_, initDrag_, insertBefore, insertChildHTML_, isAutoId, isBinding, isFloating_, isListen, isRealElement, isRealVisible, isRealVisible, isVisible, isVisible, isWatchable_, listen, listenOnFitSize_, mimicMouseDown_, newInstance, nextUuid, onAfterSize, onChildAdded_, onChildRemoved_, onChildRenderDefer_, onChildReplaced_, onChildVisible_, onDrop_, redraw, redrawHTML_, register, removeChild, removeChild, removeChildHTML_, removeHTML_, replaceCavedChildren_, replaceChildHTML_, replaceHTML, replaceWidget, rerender, rerender, rerenderLater_, rerenderNow_, scrollIntoView, sendAU_, set, set, setAction, setChildren, setCssflex, setDomVisible_, setDraggable, setDroppable, setFloating_, setFloatZIndex_, setHeight, setHflex, setId, setLeft, setListener, setListener, setListeners, setMold, setRenderdefer, setSclass, setScrollLeft, setScrollTop, setStyle, setTabindex, setTooltiptext, setTop, setTopmost, setVflex, setVisible, setWidth, setZclass, setZIndex, shallChildROD_, shallFireSizedLaterWhenAddChd_, shallIgnoreClick_, show, smartUpdate, unbind_, unbind, unbindChildren_, unbindDoubleTap_, unbindSwipe_, unbindTapHold_, uncloneDrag_, unlisten, unlistenOnFitSize_, updateDomClass_, updateDomStyle_, uuid, zsync

Methods inherited from class zk.Object

$init, $instanceof, $super, $super, $supers, $supers, afterInit, isAssignableFrom, isInstance, proxy

Methods inherited from class java.lang.Object

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

Method Detail

setAutoplay

public void setAutoplay(boolean autoplay)

Sets whether to auto start playing the video.

Parameters:

autoplay -

isAutoplay

public boolean isAutoplay()

Returns whether to auto start playing the video.

Default: false.

Returns:

boolean

setControls

public void setControls(boolean controls)

Sets whether to display the video controls.

Parameters:

controls -

isControls

public boolean isControls()

Returns whether to display the video controls.

Default: false.

Returns:

boolean

setLoop

public void setLoop(boolean loop)

Sets whether to play the video repeatedly.

Parameters:

loop -

isLoop

public boolean isLoop()

Returns whether to play the video repeatedly.

Default: false.

Returns:

boolean

setDimBackground

public void setDimBackground(boolean dimBackground)

Sets whether to turn whole page to be covered by translucent black except the Video, also called theater mode. When theater mode is enabled, user can click anywhere on the page except the Video to disable theater mode.

Parameters:

dimBackground -

isDimBackground

public boolean isDimBackground()

Returns whether to turn whole page to be covered by translucent black except the Video, also called theater mode. When theater mode is enabled, user can click anywhere on the page except the Video to disable theater mode.

Default: false.

Returns:

boolean

setPreload

public void setPreload(String preload)

Sets whether and how the video should be loaded, which could be one of "none", "metadata", "auto". Refer to Preload Attribute Description for details.

Parameters:

preload -

getPreload

public String getPreload()

Returns whether and how the video should be loaded.

Default: null.

Returns:

String

setPoster

public void setPoster(String poster)

Sets whether to display a poster before the video play.

Parameters:

poster -

getPoster

public String getPoster()

Returns whether to display a poster before the video play.

Default: null.

Returns:

String

setSrc

public void setSrc(String src)

Sets the video source.

Parameters:

src -

getSrc

public String getSrc()

Returns the video source.

Default: null.

Returns:

String

setCrossorigin

public void setCrossorigin(String crossorigin)

Sets the crossorigin of this video tag.

Parameters:

crossorigin -

getCrossorigin

public String getCrossorigin()

Returns the crossorigin of this video tag.

Default: null.

Returns:

String

setPlaysinline

public void setPlaysinline(String playsinline)

Sets the playsinline of this video tag.

Parameters:

playsinline -

getPlaysinline

public String getPlaysinline()

Returns the playsinline of this video tag.

Default: null.

Returns:

String

setPlaybackRate

public void setPlaybackRate(double playbackRate)

Sets the video play speed, type of value is in double, valid value is depending on browser.

Parameters:

playbackRate -

getPlaybackRate

public double getPlaybackRate()

Returns the video play speed.

Default: 1.0.

Returns:

double

setClipToFit

public void setClipToFit(boolean clipToFit)

Set whether to clip video when the source size doesn't fit the tag size setting, for example: if video source is 1280 * 720, but the video tag is <video width="1000px" height="720px" />, it will cut off the sides of the video, preserving the aspect ratio, and also filling in the space.

Parameters:

clipToFit -

isClipToFit

public boolean isClipToFit()

Return whether to clip video when the source size doesn't fit the tag size setting, for example: if video source is 1280 * 720, but the video tag is <video width="1000px" height="720px" />, it will cut off the sides of the video, preserving the aspect ratio, and also filling in the space.

Default: false.

Returns:

boolean

setMuted

public void setMuted(boolean muted)

Sets whether to mute the video.

Parameters:

muted - whether to mute the video.

isMuted

public boolean isMuted()

Returns whether the video is muted.

Returns:

boolean

setVolume

public void setVolume(double volume)

Sets the volume of video.

Parameters:

volume - the volume of video, type of value is in double, valid value is between 0.0 and 1.0.

getVolume

public double getVolume()

Returns the volume of video.

Default: 1.0.

Returns:

double

toggleLight

public void toggleLight(boolean lightOff)

Toggle the theater mode by add or remove Class.

Parameters:

lightOff -

enableFullScreen

public void enableFullScreen()

Use full screen mode.

setCurrentTime

public void setCurrentTime(double currentTime)

Sets which part of video to play. invoked by server.

Parameters:

currentTime - which part of video to play, the value is in seconds.

setPlaying

public void setPlaying(boolean playing)

Sets whether the video is playing. invoked by server.

Parameters:

playing - whether the video is playing.