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, HtmlBasedComponent, Component, Scope, ComponentCtrl, Flash

public class Flash
extends HtmlBasedComponent
implements Flash

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, RS_NO_DISPLAY, RS_NO_HEIGHT, RS_NO_WIDTH

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

_visible

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

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

Constructor Summary

Flash()

Flash(java.lang.String src)

Method Summary

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	getEncodedSrc() Returned the encoded URL of the source flash.
java.lang.String	getSrc() Gets the source path of Flash movie
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 repeatly.
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 repeatly
void	setSrc(java.lang.String src) Sets the source path of Flash movie and redraw the component
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

focus, getAllOnClickAttrs, getDraggable, getDroppable, getHeight, getInnerAttrs, getLeft, getMoldSclass, getOuterAttrs, getRealSclass, getRealStyle, getRealStyleFlags, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, newExtraCtrl, redraw, setClass, setDraggable, setDroppable, setFocus, setHeight, setLeft, setMoldSclass, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex

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

addAnnotation, addAnnotation, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addSharedAnnotationMap, addSharedEventHandlerMap, appendAsapAttr, appendAsapAttr, appendChild, applyProperties, clone, containsVariable, detach, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttributes, getAttributes, getChildren, getCommand, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getExtraCtrl, getFellow, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getMoldURI, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, hasFellow, insertBefore, invalidate, isAsapRequired, isChildable, isInvalidated, isListenerAvailable, isVisible, newChildren, onChildAdded, onChildRemoved, onDrawNewChild, onPageAttached, onPageDetached, onWrongValue, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setComponentDefinition, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, smartUpdate, smartUpdate, smartUpdate, smartUpdateDeferred, smartUpdateValues, toString, unsetVariable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent

focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex

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

addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributes, getAttributes, getChildren, getDefinition, getDesktop, getFellow, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, redraw, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, unsetVariable

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)

Specified by:

getBgcolor in interface Flash

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.

Specified by:

setBgcolor in interface Flash

Parameters:

bgcolor - [ hexadecimal RGB value]

isLoop

public boolean isLoop()

Returns true if the Flash movie plays repeatly.

Default: false

Specified by:

isLoop in interface Flash

Returns:

true if the Flash movie plays repeatly

setLoop

public void setLoop(boolean loop)

Sets whether the Flash movie plays repeatly

Specified by:

setLoop in interface Flash

Parameters:

loop -

isAutoPlay

public boolean isAutoPlay()

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

Specified by:

isAutoPlay in interface Flash

setAutoPlay

public void setAutoPlay(boolean autoplay)

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

Specified by:

setAutoPlay in interface Flash

isAutoplay

public boolean isAutoplay()

Return true if the Flash movie starts playing automatically

Default: true

Specified by:

isAutoplay in interface Flash

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.

Specified by:

setAutoplay in interface Flash

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".

Specified by:

getWmode in interface Flash

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.

Specified by:

setWmode in interface Flash

Parameters:

wmode - Possible values: window, opaque, transparent.

getSrc

public java.lang.String getSrc()

Gets the source path of Flash movie

Specified by:

getSrc in interface Flash

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

Specified by:

setSrc in interface Flash

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.

Specified by:

setContent in interface Flash

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).

Specified by:

getContent in interface Flash

Since:

3.6.1

getEncodedSrc

public java.lang.String getEncodedSrc()

Returned the encoded URL of the source flash. It is used only internally (for component development).

Since:

3.6.1