org.zkoss.zul

Class Flash

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.Flash

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Component, Scope, ComponentCtrl

public class Flash
extends HtmlBasedComponent

A generic flash component.

Non XUL extension.

Since:

3.0.0

Author:

Jeff

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

AbstractComponent.Children

Field Summary

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
Flash()
Flash(java.lang.String src)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBgcolor() Gets the background color of Flash movie.
Media	getContent() Returns the content set by setContent(org.zkoss.util.media.Media).
java.lang.String	getQuality() Returns the quality of the Flash movie Default: "high".
java.lang.String	getSrc() Gets the source path of Flash movie
java.lang.String	getVersion() Returns the expected version of the Flash player.
java.lang.String	getWmode() Returns the Window mode property of the Flash movie Default: "transparent".
boolean	isAutoplay() Return true if the Flash movie starts playing automatically Default: true
boolean	isAutoPlay() Deprecated. As of release 3.6.1, use isAutoplay() instead.
boolean	isLoop() Returns true if the Flash movie plays repeatedly.
protected void	renderProperties(ContentRenderer renderer) Renders the content of this component, excluding the enclosing tags and children.
void	setAutoplay(boolean autoplay) Sets wether to play the Flash movie automatically.
void	setAutoPlay(boolean autoplay) Deprecated. As of release 3.6.1, use setAutoplay(boolean) instead.
void	setBgcolor(java.lang.String bgcolor) Sets the background color of Flash movie.
void	setContent(Media media) Sets the content of the flash directly.
void	setLoop(boolean loop) Sets whether the Flash movie plays repeatedly
void	setQuality(java.lang.String quality) Sets the quality of the Flash movie.
void	setSrc(java.lang.String src) Sets the source path of Flash movie and redraw the component
void	setVersion(java.lang.String version) Sets the expected version of the Flash player.
void	setWmode(java.lang.String wmode) Sets the Window Mode property of the Flash movie for transparency, layering, and positioning in the browser.

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

clone, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getPropertyAccess, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, service, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowRoots, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Flash

public Flash()

Flash

public Flash(java.lang.String src)

Method Detail

getBgcolor

public java.lang.String getBgcolor()

Gets the background color of Flash movie.

Default: null (the system default)

Returns:

the background color of Flash movie,[ hexadecimal RGB value]

setBgcolor

public void setBgcolor(java.lang.String bgcolor)

Sets the background color of Flash movie.

Parameters:

bgcolor - [ hexadecimal RGB value]

isLoop

public boolean isLoop()

Returns true if the Flash movie plays repeatedly.

Default: false

Returns:

true if the Flash movie plays repeatedly

setLoop

public void setLoop(boolean loop)

Sets whether the Flash movie plays repeatedly

Parameters:

loop -

isAutoPlay

public boolean isAutoPlay()

Deprecated. As of release 3.6.1, use isAutoplay() instead.

setAutoPlay

public void setAutoPlay(boolean autoplay)

Deprecated. As of release 3.6.1, use setAutoplay(boolean) instead.

isAutoplay

public boolean isAutoplay()

Return true if the Flash movie starts playing automatically

Default: true

Returns:

true if the Flash movie starts playing automatically

Since:

3.6.1

setAutoplay

public void setAutoplay(boolean autoplay)

Sets wether to play the Flash movie automatically.

Parameters:

autoplay - whether to play the Flash movie automatically

Since:

3.6.1

getWmode

public java.lang.String getWmode()

Returns the Window mode property of the Flash movie

Default: "transparent".

Returns:

the Window mode property of the Flash movie

setWmode

public void setWmode(java.lang.String wmode)

Sets the Window Mode property of the Flash movie for transparency, layering, and positioning in the browser.

Parameters:

wmode - Possible values: window, opaque, transparent.

getVersion

public java.lang.String getVersion()

Returns the expected version of the Flash player.

Default: "6,0,0,0"

Since:

5.0.0

setVersion

public void setVersion(java.lang.String version)

Sets the expected version of the Flash player.

Since:

5.0.0

getQuality

public java.lang.String getQuality()

Returns the quality of the Flash movie

Default: "high".

Returns:

the quality of the Flash movie

Since:

5.0.0

setQuality

public void setQuality(java.lang.String quality)

Sets the quality of the Flash movie.

Parameters:

quality - the quality of the Flash movie. Accept "high","medium","low"

Since:

5.0.0

getSrc

public java.lang.String getSrc()

Gets the source path of Flash movie

Returns:

the source path of Flash movie

setSrc

public void setSrc(java.lang.String src)

Sets the source path of Flash movie and redraw the component

Parameters:

src -

setContent

public void setContent(Media media)

Sets the content of the flash directly. Default: null.

Calling this method implies setSrc(null). In other words, the last invocation of setContent(org.zkoss.util.media.Media) overrides the previous setSrc(java.lang.String), if any.

Parameters:

media - the media representing the flash, i.e., SWF.

Since:

3.6.1

See Also:

setSrc(java.lang.String)

getContent

public Media getContent()

Returns the content set by setContent(org.zkoss.util.media.Media).

Note: it won't fetch what is set thru by setSrc(java.lang.String). It simply returns what is passed to setContent(org.zkoss.util.media.Media).

Since:

3.6.1

renderProperties

protected void renderProperties(ContentRenderer renderer)
                         throws java.io.IOException

Description copied from class: HtmlBasedComponent

Renders the content of this component, excluding the enclosing tags and children.

See also ZK Client-side Reference: Property Rendering

Overrides:

renderProperties in class HtmlBasedComponent

Throws:

java.io.IOException