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

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.BoxComponent
                  com.extjs.gxt.ui.client.widget.Container<Component>
                      com.extjs.gxt.ui.client.widget.HtmlContainer

All Implemented Interfaces:

Observable, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener

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 class=text style='padding:5px'>"
     + "<h1>Heading1</h1>"
     + "<i>Some text</i></br>"
     + "<div class=b1></div>"
     + "<u>Final text</u></div>");
   hc.add(new Button("Test"), "div.b1");
   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.

• htmlContainer : this
• html : the html
• response : the response

LoadException : HtmlContainerEvent(htmlContainer, exception)

Fires after the component is resized.

• htmlContainer : this
• exception : the load exception

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.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.
com.google.gwt.http.client.RequestBuilder.Method	getHttpMethod() Returns the HTTP method.
java.lang.String	getRequestData() Returns the request data.
java.lang.String	getTagName()
boolean	isDeferDownload() Returns true if defer download is enabled.
void	setDeferDownload(boolean deferDownload) True to defer remote requests until the component is rendered (defaults to false).
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

disable, enable, findItem, getItem, getItemByItemId, getItemCount, getItems, getLayoutTarget, getWidget, indexOf, iterator, removeAll, scrollIntoView

Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent

getBounds, getHeight, getHeight, getPosition, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, isAutoHeight, isAutoWidth, isDeferHeight, isShim, 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

addListener, addPlugin, addStyleName, addWidgetListener, clearState, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getContextMenu, getData, getElement, getHideMode, getId, getItemId, getListeners, getModel, getState, getStateId, getToolTip, hasListeners, hasListeners, hide, hideToolTip, isDisabledEvents, isEnabled, isRendered, isStateful, isVisible, mask, mask, mask, onBrowserEvent, onComponentEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setBorders, setContextMenu, setData, setElement, setEnabled, setHideMode, setId, setIntStyleAttribute, setItemId, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget

fireEvent, getParent, isAttached

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, unsinkEvents

Methods inherited from class java.lang.Object

equals, 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 tagName

isDeferDownload

public boolean isDeferDownload()

Returns true if defer download is enabled.

Returns:

true for deferred download

setDeferDownload

public void setDeferDownload(boolean deferDownload)

True to defer remote requests until the component is rendered (defaults to false).

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