com.extjs.gxt.ui.client.widget
Class HtmlContainer

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.Container<Component>
                      extended by com.extjs.gxt.ui.client.widget.HtmlContainer
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

public class HtmlContainer
extends Container<Component>

A specialized container whose contents can be specified as an existing element, an html fragment, or a remote url. When adding children a css selector is used to identify the element the child will be inserted into.

Code snippet:

   HtmlContainer hc = new HtmlContainer("<div><table><tr><td id='foo'></td></tr></div>");
   hc.add(new Button("Test"), ".foo");
   hc.setBorders(true);
   hc.setSize(200, 100);
   hc.setPosition(10, 10);
   RootPanel.get().add(hc);
 
Events:
Load : HtmlContainerEvent(htmlContainer, response, html)
Fires after the component is resized.
LoadException : HtmlContainerEvent(htmlContainer, exception)
Fires after the component is resized.
Inherited Events:
Container BeforeAdd
Container Add
Container BeforeRemove
Container Remove
BoxComponent Move
BoxComponent Resize
Component Enable
Component Disable
Component BeforeHide
Component Hide
Component BeforeShow
Component Show
Component Attach
Component Detach
Component BeforeRender
Component Render
Component BrowserEvent
Component BeforeStateRestore
Component StateRestore
Component BeforeStateSave
Component SaveState


Nested Class Summary
 
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
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Container
attachChildren, enableLayout, layoutExecuted, layoutNeeded, layoutOnAttach, layoutOnChange
 
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
HtmlContainer()
          Creates a new container.
HtmlContainer(com.google.gwt.user.client.Element elem)
          Creates a new container.
HtmlContainer(com.google.gwt.http.client.RequestBuilder requestBuilder)
          Creates a new container.
HtmlContainer(java.lang.String html)
          Creates a container.
 
Method Summary
 void add(com.google.gwt.user.client.ui.Widget widget, java.lang.String selector)
          Adds a component to this Container.
protected  ComponentEvent createComponentEvent(com.google.gwt.user.client.Event event)
           
protected  ContainerEvent createContainerEvent(Component item)
           
 com.google.gwt.http.client.RequestBuilder.Method getHttpMethod()
          Returns the HTTP method.
 java.lang.String getRequestData()
          Returns the request data.
 java.lang.String getTagName()
          Returns the tag name.
protected  void handleError(com.google.gwt.http.client.Request request, java.lang.Throwable exception)
           
protected  void handleResponseReceived(com.google.gwt.http.client.Request request, com.google.gwt.http.client.Response response)
           
 boolean isDeferDownload()
          Returns true if defer download is enabled.
protected  void onBlur(ComponentEvent ce)
           
 void onComponentEvent(ComponentEvent ce)
          Any events a component receives will be forwarded to this method.
protected  void onFocus(ComponentEvent ce)
           
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
protected  void renderAll()
           
protected  void renderItem(Component item, java.lang.String selector)
           
protected  void requestData()
           
 void setDeferDownload(boolean deferDownload)
          True to defer remote requests until the component is rendered (defaults to true).
 void setHtml(java.lang.String html)
          Sets the container's inner html.
 void setHttpMethod(com.google.gwt.http.client.RequestBuilder.Method httpMethod)
          The method used when requesting remote content (defaults to RequestBuilder.GET).
 void setRequestData(java.lang.String requestData)
          The request data to be used in remote calls (defaults to null).
 void setTagName(java.lang.String tagName)
          The HTML tag name that will wrap the text (defaults to 'div').
 void setUrl(java.lang.String url)
          Retrieves and sets the container's content from the given url.
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Container
add, adjustIndex, adopt, disable, doAttachChildren, doDetachChildren, doLayout, doLayout, enable, findItem, getItem, getItemByItemId, getItemCount, getItems, getLayout, getLayoutTarget, getWidget, indexOf, insert, isLayoutNeeded, iterator, layout, layout, notifyHide, notifyShow, onAfterLayout, onAttach, onBeforeLayoutExcecuted, onInsert, onLayoutExcecuted, onRemove, orphan, remove, remove, removeAll, removeAll, scrollIntoView, setLayout, setLayoutNeeded, setLayoutOnChange, wrapWidget
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, afterRender, 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, disableContextMenu, disableEvents, disableTextSelection, el, 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, onBrowserEvent, onDetach, 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
 

Constructor Detail

HtmlContainer

public HtmlContainer()
Creates a new container.


HtmlContainer

public HtmlContainer(com.google.gwt.user.client.Element elem)
Creates a new container.

Parameters:
elem - the component's element

HtmlContainer

public HtmlContainer(com.google.gwt.http.client.RequestBuilder requestBuilder)
Creates a new container.

Parameters:
requestBuilder - the request to be used when setting a url

HtmlContainer

public HtmlContainer(java.lang.String html)
Creates a container.

Parameters:
html - the containers inner html
Method Detail

add

public void add(com.google.gwt.user.client.ui.Widget widget,
                java.lang.String selector)
Adds a component to this Container. Fires the BeforeAdd event before adding, then fires the Add event after the component has been added.

Parameters:
widget - the widget to add. If the widget is not a Component it will be wrapped in a WidgetComponent
selector - the css selector (ie div.class) used to identify the components parent

getHttpMethod

public com.google.gwt.http.client.RequestBuilder.Method getHttpMethod()
Returns the HTTP method. Only applies when specifying a setUrl(String)

Returns:
the HTTP method

getRequestData

public java.lang.String getRequestData()
Returns the request data.

Returns:
the request data

getTagName

public java.lang.String getTagName()
Returns the tag name.

Returns:
the tagName

isDeferDownload

public boolean isDeferDownload()
Returns true if defer download is enabled.

Returns:
true for deferred download

onComponentEvent

public void onComponentEvent(ComponentEvent ce)
Description copied from class: Component
Any events a component receives will be forwarded to this method. Subclasses should override as needed. The Component.onBrowserEvent(com.google.gwt.user.client.Event) method should not be overridden or modified.

Overrides:
onComponentEvent in class Component
Parameters:
ce - the base event

setDeferDownload

public void setDeferDownload(boolean deferDownload)
True to defer remote requests until the component is rendered (defaults to true).

Parameters:
deferDownload - true to defer

setHtml

public void setHtml(java.lang.String html)
Sets the container's inner html.

Parameters:
html - the html

setHttpMethod

public void setHttpMethod(com.google.gwt.http.client.RequestBuilder.Method httpMethod)
The method used when requesting remote content (defaults to RequestBuilder.GET). Only applies when specifying a setUrl(String)

Parameters:
httpMethod -

setRequestData

public void setRequestData(java.lang.String requestData)
The request data to be used in remote calls (defaults to null).

Parameters:
requestData - the request data

setTagName

public void setTagName(java.lang.String tagName)
The HTML tag name that will wrap the text (defaults to 'div'). For inline behavior set the tag name to 'span'.

Parameters:
tagName - the new tag name

setUrl

public void setUrl(java.lang.String url)
Retrieves and sets the container's content from the given url.

Parameters:
url - the url

createComponentEvent

protected ComponentEvent createComponentEvent(com.google.gwt.user.client.Event event)
Overrides:
createComponentEvent in class BoxComponent

createContainerEvent

protected ContainerEvent createContainerEvent(Component item)
Overrides:
createContainerEvent in class Container<Component>

handleError

protected void handleError(com.google.gwt.http.client.Request request,
                           java.lang.Throwable exception)

handleResponseReceived

protected void handleResponseReceived(com.google.gwt.http.client.Request request,
                                      com.google.gwt.http.client.Response response)

onBlur

protected void onBlur(ComponentEvent ce)

onFocus

protected void onFocus(ComponentEvent ce)

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

renderAll

protected void renderAll()

renderItem

protected void renderItem(Component item,
                          java.lang.String selector)

requestData

protected void requestData()