Package com.google.gwt.user.client.ui

Class HTMLPanel

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
All Implemented Interfaces:
HasAttachHandlers, HasHandlers, EventListener, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, IndexedPanel, IndexedPanel.ForIsWidget, IsWidget, Iterable<Widget>
public class HTMLPanel extends ComplexPanel
A panel that contains HTML, and which can attach child widgets to identified elements within that HTML.

  • Constructor Details

    • HTMLPanel

      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

    • HTMLPanel

      public HTMLPanel(SafeHtml safeHtml)
      Initializes the panel's HTML from a given SafeHtml object. Similar to HTMLPanel(String)
      Parameters:
      safeHtml - the html to set.

    • HTMLPanel

      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

  • Method Details

    • createUniqueId

      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

    • wrap

      public static HTMLPanel wrap(Element element)
      Creates an HTML panel that wraps an existing element. This element must already be attached to the document. If the element is removed from the document, you must call Widget.removeFromParent().
      Parameters:
      element - the element to be wrapped

    • add

      public void add(Widget widget)
      Adds a child widget to the panel.
      Specified by:
      add in interface HasWidgets
      Overrides:
      add in class Panel
      Parameters:
      widget - the widget to be added
      See Also:

    • add

      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

    • add

      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.
      Overrides:
      add in class ComplexPanel
      Parameters:
      widget - the widget to be added
      elem - the element within which it will be contained

    • addAndReplaceElement

      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

    • addAndReplaceElement

      @Deprecated public void addAndReplaceElement(Widget widget, Element toReplace)
      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

    • addAndReplaceElement

      @Deprecated public void addAndReplaceElement(IsWidget widget, Element toReplace)
      Deprecated.
      use addAndReplaceElement(IsWidget, Element)
      Overloaded version for IsWidget.
      See Also:

    • addAndReplaceElement

      public void addAndReplaceElement(IsWidget widget, Element toReplace)
      Overloaded version for IsWidget.
      See Also:

    • addAndReplaceElement

      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

    • addAndReplaceElement

      public void addAndReplaceElement(IsWidget widget, String id)
      Overloaded version for IsWidget.
      See Also:

    • getElementById

      public Element getElementById(String id)
      Finds an element within this panel by its id. This method uses Document.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