public class

CaptionPanel

extends Composite
implements HasWidgets

java.lang.Object
↳	com.google.gwt.user.client.ui.UIObject
	↳	com.google.gwt.user.client.ui.Widget
		↳	com.google.gwt.user.client.ui.Composite
			↳	com.google.gwt.user.client.ui.CaptionPanel

Class Overview

A panel that wraps its contents in a border with a caption that appears in the upper left corner of the border. This is an implementation of the fieldset HTML element.

Summary

Nested Classes
class	CaptionPanel.CaptionPanelImpl	Implementation class without browser-specific hacks.
class	CaptionPanel.CaptionPanelImplMozilla	Implementation class that handles Mozilla rendering issues.
class	CaptionPanel.CaptionPanelImplSafari	Implementation class that handles Safari rendering issues.

[Expand]

Inherited Constants

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

Public Constructors
	CaptionPanel() Constructs a CaptionPanel with an empty caption.
	CaptionPanel(SafeHtml caption) Constructs a CaptionPanel with specified caption text.
	CaptionPanel(String captionText) Constructs a CaptionPanel with specified caption text.
	CaptionPanel(String caption, boolean asHTML) Constructs a CaptionPanel having the specified caption.

Public Methods
void	add(Widget w) Adds a child widget.
void	clear() Removes the content widget.
String	getCaptionHTML() Returns the caption as HTML; note that if the caption was previously set using `setCaptionText(String)`, the return value is undefined.
String	getCaptionText() Returns the caption as text; note that if the caption was previously set using `setCaptionHTML(String)`, the return value is undefined.
Widget	getContentWidget() Accesses the content widget, if present.
Iterator<Widget>	iterator() Iterates over the singular content widget, if present.
boolean	remove(Widget w) Removes the specified widget, although in practice the specified widget must be the content widget.
void	setCaptionHTML(String html) Sets the caption for the panel using an HTML fragment.
void	setCaptionHTML(SafeHtml html) Sets the caption for the panel using a SafeHtml string.
void	setCaptionText(String text) Sets the caption for the panel using text that will be automatically escaped.
void	setContentWidget(Widget w) Sets or replaces the content widget within the CaptionPanel.

[Expand]

Inherited Methods

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

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.IsWidget

From interface java.lang.Iterable

Public Constructors

public CaptionPanel ()

Constructs a CaptionPanel with an empty caption.

public CaptionPanel (SafeHtml caption)

Constructs a CaptionPanel with specified caption text.

Parameters

caption	the text of the caption

public CaptionPanel (String captionText)

Constructs a CaptionPanel with specified caption text.

Parameters

captionText	the text of the caption, which is automatically escaped

public CaptionPanel (String caption, boolean asHTML)

Constructs a CaptionPanel having the specified caption.

Parameters

caption	the caption to display
asHTML	if `true`, the `caption` param is interpreted as HTML; otherwise, `caption` is treated as text and automatically escaped

Public Methods

public void add (Widget w)

Adds a child widget.

Parameters

w	the widget to be added

public void clear ()

Removes the content widget.

public String getCaptionHTML ()

Returns the caption as HTML; note that if the caption was previously set using setCaptionText(String), the return value is undefined.

public String getCaptionText ()

Returns the caption as text; note that if the caption was previously set using setCaptionHTML(String), the return value is undefined.

public Widget getContentWidget ()

Accesses the content widget, if present.

Returns

the content widget specified previously in setContentWidget(Widget)

public Iterator<Widget> iterator ()

Iterates over the singular content widget, if present.

public boolean remove (Widget w)

Removes the specified widget, although in practice the specified widget must be the content widget.

Parameters

w	the widget to remove; note that anything other than the Widget returned by `getContentWidget()` will have no effect

Returns

true if the widget was present

public void setCaptionHTML (String html)

Sets the caption for the panel using an HTML fragment. Pass in empty string to remove the caption completely, leaving just the unadorned panel.

Parameters

html	HTML for the new caption; must not be `null`

public void setCaptionHTML (SafeHtml html)

Sets the caption for the panel using a SafeHtml string.

Parameters

html	HTML for the new caption; must not be `null`

public void setCaptionText (String text)

Sets the caption for the panel using text that will be automatically escaped. Pass in empty string to remove the caption completely, leaving just the unadorned panel.

Parameters

text	text for the new caption; must not be `null`

public void setContentWidget (Widget w)

Sets or replaces the content widget within the CaptionPanel.

Parameters

w	the content widget to be set

Interfaces

Classes

Annotations

Enums

Exceptions

CaptionPanel

Class Overview

Summary

Public Constructors

public CaptionPanel ()

public CaptionPanel (SafeHtml caption)

Parameters

public CaptionPanel (String captionText)

Parameters

public CaptionPanel (String caption, boolean asHTML)

Parameters

Public Methods

public void add (Widget w)

Parameters

public void clear ()

public String getCaptionHTML ()

public String getCaptionText ()

public Widget getContentWidget ()

Returns

public Iterator<Widget> iterator ()

public boolean remove (Widget w)

Parameters

Returns

public void setCaptionHTML (String html)

Parameters

public void setCaptionHTML (SafeHtml html)

Parameters

public void setCaptionText (String text)

Parameters

public void setContentWidget (Widget w)

Parameters