Summary: Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]

public class

HTMLPanel

extends ComplexPanel

java.lang.Object
↳	com.google.gwt.user.client.ui.UIObject
	↳	com.google.gwt.user.client.ui.Widget
		↳	com.google.gwt.user.client.ui.Panel
			↳	com.google.gwt.user.client.ui.ComplexPanel
				↳	com.google.gwt.user.client.ui.HTMLPanel

Class Overview

A panel that contains HTML, and which can attach child widgets to identified elements within that HTML.

Summary

[Expand]

Inherited Constants

From class com.google.gwt.user.client.ui.UIObject

Public Constructors
	HTMLPanel(String html) Creates an HTML panel with the specified HTML contents inside a DIV element.
	HTMLPanel(SafeHtml safeHtml) Initializes the panel's HTML from a given `SafeHtml` object.
	HTMLPanel(String tag, String html) Creates an HTML panel whose root element has the given tag, and with the specified HTML contents.

Public Methods
void	add(Widget widget, Element elem) Adds a child widget to the panel, contained within an HTML element.
void	add(Widget widget, String id) Adds a child widget to the panel, contained within the HTML element specified by a given id.
void	add(Widget widget) Adds a child widget to the panel.
void	addAndReplaceElement(Widget widget, Element toReplace) This method is deprecated. use `addAndReplaceElement(Widget, Element)`
final void	addAndReplaceElement(Widget widget, Element toReplace) Adds a child widget to the panel, replacing the HTML element.
void	addAndReplaceElement(Widget widget, String id) Adds a child widget to the panel, replacing the HTML element specified by a given id.
static String	createUniqueId() A helper method for creating unique IDs for elements within dynamically- generated HTML.
Element	getElementById(String id) Finds an `element` within this panel by its id.

[Expand]

Inherited Methods

From class com.google.gwt.user.client.ui.ComplexPanel

void	add(Widget child, Element container) Adds a new child widget to the panel, attaching its Element to the specified container Element.
int	adjustIndex(Widget child, int beforeIndex) Adjusts beforeIndex to account for the possibility that the given widget is already a child of this panel.
void	checkIndexBoundsForAccess(int index) Checks that `index` is in the range [0, getWidgetCount()), which is the valid range on accessible indexes.
void	checkIndexBoundsForInsertion(int index) Checks that `index` is in the range [0, getWidgetCount()], which is the valid range for indexes on an insertion.
WidgetCollection	getChildren() Gets the list of children contained in this panel.
Widget	getWidget(int index) Gets the child widget at the specified index.
int	getWidgetCount() Gets the number of child widgets in this panel.
int	getWidgetIndex(Widget child) Gets the index of the specified child widget.
int	getWidgetIndex(IsWidget child)
void	insert(Widget child, Element container, int beforeIndex, boolean domInsert) Insert a new child Widget into this Panel at a specified index, attaching its Element to the specified container Element.
void	insert(Widget child, Element container, int beforeIndex) This method is deprecated. Use `insert(Widget, Element, int, boolean)` instead
Iterator<Widget>	iterator()
boolean	remove(Widget w) Removes a child widget.
boolean	remove(int index) Removes the widget at the specified index.

From class com.google.gwt.user.client.ui.Panel

void	add(IsWidget child)
void	add(Widget child) Adds a child widget.
final void	adopt(Widget child) Finalize the attachment of a Widget to this Panel.
void	adopt(Widget w, Element container) This method is deprecated. Use `adopt(Widget)`.
void	clear() Removes all child widgets.
void	disown(Widget w) This method is deprecated. Use `orphan(Widget)`.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
final void	orphan(Widget child) This method must be called as part of the remove method of any Panel.
abstract boolean	remove(Widget child) Removes a child widget.
boolean	remove(IsWidget child)

From class com.google.gwt.user.client.ui.Widget

HandlerRegistration	addAttachHandler(AttachEvent.Handler handler) Adds an `AttachEvent` handler.
final <H extends EventHandler> HandlerRegistration	addDomHandler(H handler, Type<H> type) Adds a native event handler to the widget and sinks the corresponding native event.
final <H extends EventHandler> HandlerRegistration	addHandler(H handler, Type<H> type) Adds this handler to the widget.
Widget	asWidget() Returns the `Widget` aspect of the receiver.
static Widget	asWidgetOrNull(IsWidget w) This convenience method makes a null-safe call to `asWidget()`.
HandlerManager	createHandlerManager() Creates the `HandlerManager` used by this Widget.
void	delegateEvent(Widget target, GwtEvent<?> event) Fires an event on a child widget.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
void	fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
int	getHandlerCount(Type<?> type) Gets the number of handlers listening to the event type.
Object	getLayoutData() Gets the panel-defined layout data associated with this widget.
Widget	getParent() Gets this widget's parent panel.
boolean	isAttached() Determines whether this widget is currently attached to the browser's document (i.e., there is an unbroken chain of widgets between this widget and the underlying browser document).
final boolean	isOrWasAttached() Has this widget ever been attached?
void	onAttach() This method is called when a widget is attached to the browser's document.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	onUnload() This method is called immediately before a widget will be detached from the browser's document.
void	removeFromParent() Removes this widget from its parent widget, if one exists.
void	setLayoutData(Object layoutData) Sets the panel-defined layout data associated with this widget.
void	sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.

From class com.google.gwt.user.client.ui.UIObject

void	addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix.
void	addStyleName(String style) Adds a secondary or dependent style name to this object.
static void	ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element.
final void	ensureDebugId(String id) Ensure that the main `Element` for this `UIObject` has an ID property set, which allows it to integrate with third-party libraries and test tools.
static void	ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools.
int	getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area.
int	getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area.
Element	getElement() Gets a handle to the object's underlying DOM element.
int	getOffsetHeight() Gets the object's offset height in pixels.
int	getOffsetWidth() Gets the object's offset width in pixels.
Element	getStyleElement() Template method that returns the element to which style names will be applied.
String	getStyleName() Gets all of the object's style names, as a space-separated list.
static String	getStyleName(Element elem) Gets all of the element's style names, as a space-separated list.
String	getStylePrimaryName() Gets the primary style name associated with the object.
static String	getStylePrimaryName(Element elem) Gets the element's primary style name.
String	getTitle() Gets the title associated with this object.
boolean	isVisible() Determines whether or not this object is visible.
static boolean	isVisible(Element elem)
void	onEnsureDebugId(String baseID) Called when the user sets the id using the `ensureDebugId(String)` method.
void	removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix.
void	removeStyleName(String style) Removes a style name.
final void	setElement(Element elem) Sets this object's browser element.
void	setElement(Element elem) Sets this object's browser element.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setSize(String width, String height) Sets the object's size.
void	setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix.
static void	setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style.
static void	setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element.
void	setStyleName(String style) Clears all of the object's style names and sets it to the given style.
void	setStyleName(String style, boolean add) Adds or removes a style name.
void	setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names.
static void	setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names.
void	setTitle(String title) Sets the title associated with this object.
void	setVisible(boolean visible) Sets whether this object is visible.
static void	setVisible(Element elem, boolean visible)
void	setWidth(String width) Sets the object's width.
void	sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object.
String	toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet.
void	unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.

From class java.lang.Object

From interface com.google.gwt.event.logical.shared.HasAttachHandlers

From interface com.google.gwt.event.shared.HasHandlers

From interface com.google.gwt.user.client.EventListener

From interface com.google.gwt.user.client.ui.HasWidgets

From interface com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

From interface com.google.gwt.user.client.ui.IndexedPanel

From interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

From interface com.google.gwt.user.client.ui.IsWidget

From interface java.lang.Iterable

Public Constructors

public HTMLPanel (String html)

Creates an HTML panel with the specified HTML contents inside a DIV element. Any element within this HTML that has a specified id can contain a child widget.

Parameters

html	the panel's HTML

public HTMLPanel (SafeHtml safeHtml)

Initializes the panel's HTML from a given SafeHtml object. Similar to HTMLPanel(String)

Parameters

safeHtml	the html to set.

public HTMLPanel (String tag, String html)

Creates an HTML panel whose root element has the given tag, and with the specified HTML contents. Any element within this HTML that has a specified id can contain a child widget.

Parameters

tag	the tag of the root element
html	the panel's HTML

Public Methods

public void add (Widget widget, Element elem)

Adds a child widget to the panel, contained within an HTML element. It is up to the caller to ensure that the given element is a child of this panel's root element.

Parameters

widget	the widget to be added
elem	the element within which it will be contained

public void add (Widget widget, String id)

Adds a child widget to the panel, contained within the HTML element specified by a given id.

Parameters

widget	the widget to be added
id	the id of the element within which it will be contained

public void add (Widget widget)

Adds a child widget to the panel.

Parameters

widget	the widget to be added

public void addAndReplaceElement (Widget widget, Element toReplace)

This method is deprecated.
use addAndReplaceElement(Widget, Element)

Adds a child widget to the panel, replacing the HTML element.

Parameters

widget	the widget to be added
toReplace	the element to be replaced by the widget

public final void addAndReplaceElement (Widget widget, Element toReplace)

Adds a child widget to the panel, replacing the HTML element.

Parameters

widget	the widget to be added
toReplace	the element to be replaced by the widget

public void addAndReplaceElement (Widget widget, String id)

Adds a child widget to the panel, replacing the HTML element specified by a given id.

Parameters

widget	the widget to be added
id	the id of the element to be replaced by the widget

public static String createUniqueId ()

A helper method for creating unique IDs for elements within dynamically- generated HTML. This is important because no two elements in a document should have the same id.

Returns

a new unique identifier

public Element getElementById (String id)

Finds an element within this panel by its id. This method uses getElementById(String), so the id must still be unique within the document.

Parameters

id	the id of the element to be found

Returns

the element with the given id, or null if none is found

Interfaces

Classes

Annotations

Enums

Exceptions

HTMLPanel

Class Overview

Summary

Public Constructors

public HTMLPanel (String html)

Parameters

public HTMLPanel (SafeHtml safeHtml)

Parameters

public HTMLPanel (String tag, String html)

Parameters

Public Methods

public void add (Widget widget, Element elem)

Parameters

public void add (Widget widget, String id)

Parameters

public void add (Widget widget)

Parameters

public void addAndReplaceElement (Widget widget, Element toReplace)

Parameters

public final void addAndReplaceElement (Widget widget, Element toReplace)

Parameters

public void addAndReplaceElement (Widget widget, String id)

Parameters

public static String createUniqueId ()

Returns

public Element getElementById (String id)

Parameters

Returns