com.extjs.gxt.ui.client.widget.flash
Class FlashComponent

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.flash.FlashComponent
All Implemented Interfaces:
Observable, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget
Direct Known Subclasses:
Chart

public class FlashComponent
extends BoxComponent

Base class for components that embed a flash object.


Nested Class Summary
static class FlashComponent.WMode
           
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
protected  com.google.gwt.user.client.Element swfElement
           
protected  SwfObject swfObject
           
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
FlashComponent(java.lang.String url)
          Creates a new flash component.
 
Method Summary
 java.lang.String getExpressInstall()
          Gets the express install url.
 java.lang.String getFlashVersion()
          Returns the flash version.
 java.lang.String getSwfHeight()
          Returns the width of the flash object.
 java.lang.String getSwfId()
          Returns the flash id.
 java.lang.String getSwfWidth()
          Returns the flash object width.
 FlashComponent.WMode getWmode()
          Returns the wmode.
protected  void injectFlash(SwfObject.SwfConfig config)
           
 boolean isIeFixEnabled()
          Returns true if the IE fix is enabled.
protected  void onAttach()
           
protected  void onDetach()
           
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
 void setExpressInstall(java.lang.String url)
          Add support for express install.
 void setFlashVersion(java.lang.String flashVersion)
          Sets the flash version.
 void setIeFixEnabled(boolean enabled)
          Sets if an IE fix should be used to ensure flash-to-JS interaction works.
 void setSwfHeight(java.lang.String swfHeight)
          Sets the flash object height (defaults to '100%').
 void setSwfId(java.lang.String swfId)
          Sets the flash id (- will be removed and are not allowed).
 void setSwfWidth(java.lang.String swfWidth)
          Sets the flash object width (defaults to '100%').
 void setWmode(FlashComponent.WMode wmode)
          Sets the wmode (defaults to WMode.TRANSPARENT).
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, afterRender, createComponentEvent, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onHide, onPosition, onResize, onShow, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disable, disableContextMenu, disableEvents, disableTextSelection, doAttachChildren, doDetachChildren, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, notifyHide, notifyShow, onBrowserEvent, onComponentEvent, onDetachHelper, onDisable, onEnable, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

swfElement

protected com.google.gwt.user.client.Element swfElement

swfObject

protected SwfObject swfObject
Constructor Detail

FlashComponent

public FlashComponent(java.lang.String url)
Creates a new flash component.

Parameters:
url - the url of the flash file
Method Detail

getExpressInstall

public java.lang.String getExpressInstall()
Gets the express install url.

Returns:
the express install url.

getFlashVersion

public java.lang.String getFlashVersion()
Returns the flash version.

Returns:
the flash version

getSwfHeight

public java.lang.String getSwfHeight()
Returns the width of the flash object.

Returns:
the width of the flash object

getSwfId

public java.lang.String getSwfId()
Returns the flash id.

Returns:
the flash id

getSwfWidth

public java.lang.String getSwfWidth()
Returns the flash object width.

Returns:
the flash object width

getWmode

public FlashComponent.WMode getWmode()
Returns the wmode.

Returns:
the wmode

isIeFixEnabled

public boolean isIeFixEnabled()
Returns true if the IE fix is enabled.

Returns:
the IE fix enabled state

setExpressInstall

public void setExpressInstall(java.lang.String url)
Add support for express install.

Parameters:
url - the url of the express install file

setFlashVersion

public void setFlashVersion(java.lang.String flashVersion)
Sets the flash version.

Parameters:
flashVersion - the flash version

setIeFixEnabled

public void setIeFixEnabled(boolean enabled)
Sets if an IE fix should be used to ensure flash-to-JS interaction works. Enabled by default.

Parameters:
enabled - true to enable the IE fix

setSwfHeight

public void setSwfHeight(java.lang.String swfHeight)
Sets the flash object height (defaults to '100%').

Parameters:
swfHeight - the height

setSwfId

public void setSwfId(java.lang.String swfId)
Sets the flash id (- will be removed and are not allowed).

Parameters:
swfId - the flash id

setSwfWidth

public void setSwfWidth(java.lang.String swfWidth)
Sets the flash object width (defaults to '100%').

Parameters:
swfWidth - the width

setWmode

public void setWmode(FlashComponent.WMode wmode)
Sets the wmode (defaults to WMode.TRANSPARENT).

Parameters:
wmode - the wmode

onAttach

protected void onAttach()
Overrides:
onAttach in class Component

onDetach

protected void onDetach()
Overrides:
onDetach in class Component

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)
Description copied from class: Component
Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:
onRender in class Component
Parameters:
target - the target element
index - the insert location

injectFlash

protected void injectFlash(SwfObject.SwfConfig config)