org.zkoss.zul.api
Interface Flash

All Superinterfaces:
java.lang.Cloneable, Component, HtmlBasedComponent, Scope, java.io.Serializable
All Known Subinterfaces:
Flashchart
All Known Implementing Classes:
Flash, Flashchart

public interface Flash
extends HtmlBasedComponent

A generic flash component.

Non XUL extension.

Since:
3.5.2
Author:
Jeff

Field Summary
 
Fields inherited from interface org.zkoss.zk.ui.Component
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
 
Method Summary
 java.lang.String getBgcolor()
          Gets the background color of Flash movie Default: null.
 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.s
 boolean isLoop()
          Returns true if the Flash movie plays repeatly Default: false.
 void setAutoplay(boolean autoplay)
          Sets wether to play the Flash movie automatically.
 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 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 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, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 

Method Detail

getBgcolor

java.lang.String getBgcolor()
Gets the background color of Flash movie

Default: null.

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

setBgcolor

void setBgcolor(java.lang.String bgcolor)
Sets the background color of Flash movie

Parameters:
bgcolor - [ hexadecimal RGB value]

isLoop

boolean isLoop()
Returns true if the Flash movie plays repeatly

Default: false.

Returns:
true if the Flash movie plays repeatly

setLoop

void setLoop(boolean loop)
Sets whether the Flash movie plays repeatly

Parameters:
loop -

isAutoplay

boolean isAutoplay()
Return true if the Flash movie starts playing automatically

Default: true.s

Returns:
true if the Flash movie starts playing automatically
Since:
3.6.1

setAutoplay

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

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

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.

getQuality

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

void setQuality(java.lang.String quality)
Sets the quality of the Flash movie.

Parameters:
quality - the quality of the Flash movie.
Since:
5.0.0

getVersion

java.lang.String getVersion()
Returns the expected version of the Flash player.

Default: "6,0,0,0"

Since:
5.0.0

setVersion

void setVersion(java.lang.String version)
Sets the expected version of the Flash player.

Since:
5.0.0

getSrc

java.lang.String getSrc()
Gets the source path of Flash movie

Returns:
the source path of Flash movie

setSrc

void setSrc(java.lang.String src)
Sets the source path of Flash movie and redraw the component

Parameters:
src -

setContent

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

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


Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo