com.google.gwt.widgetideas.client
Class EmbeddedObject

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.google.gwt.widgetideas.client.EmbeddedObject
All Implemented Interfaces:
com.google.gwt.user.client.EventListener
Direct Known Subclasses:
YouTubeViewer

public class EmbeddedObject
extends com.google.gwt.user.client.ui.Widget

An embedded object, such as a flash application.


Nested Class Summary
 class EmbeddedObject.EmbeddedObjectInfo
          Information about this generic object.
 
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
static int TYPE_SHOCKWAVE
          A shockwave video type.
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
EmbeddedObject()
          Create an empty embedded object.
EmbeddedObject(EmbeddedObject.EmbeddedObjectInfo info)
          Create a new embedded object based on the info.
 
Method Summary
 EmbeddedObject.EmbeddedObjectInfo getInfo()
          Get the EmbeddedObjectInfo used to render this object.
protected  void render()
          Render the object into the container div.
 void setInfo(EmbeddedObject.EmbeddedObjectInfo info)
          Update the information in the EmbeddedObject and re-render it.
protected  void setInfo(EmbeddedObject.EmbeddedObjectInfo info, boolean render)
          Set the info element and optionally re-render.
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
doAttachChildren, doDetachChildren, getParent, isAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setElement
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setHeight, setPixelSize, setSize, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkEvents, toString, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_SHOCKWAVE

public static final int TYPE_SHOCKWAVE
A shockwave video type.

See Also:
Constant Field Values
Constructor Detail

EmbeddedObject

public EmbeddedObject()
Create an empty embedded object. The object will not be rendered until the setInfo(EmbeddedObjectInfo) method is called, but the container Element will be rendered to the page for display purposes.


EmbeddedObject

public EmbeddedObject(EmbeddedObject.EmbeddedObjectInfo info)
Create a new embedded object based on the info.

Parameters:
info - the information used to create the embedded object
Method Detail

getInfo

public EmbeddedObject.EmbeddedObjectInfo getInfo()
Get the EmbeddedObjectInfo used to render this object.

Returns:
the embedded info

setInfo

public void setInfo(EmbeddedObject.EmbeddedObjectInfo info)
Update the information in the EmbeddedObject and re-render it.

Parameters:
info - the new embedded info

render

protected void render()
Render the object into the container div. Dynamically manipulating embedded elements can have weird results and throw errors, so we just replace the entire contents of the container with a new object.


setInfo

protected void setInfo(EmbeddedObject.EmbeddedObjectInfo info,
                       boolean render)
Set the info element and optionally re-render.

Parameters:
info - the new embedded info
render - true to rerender the object