public abstract class

Composite

extends Widget

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

Known Direct Subclasses

AbstractCellTree, AbstractPager, CalendarView, CaptionPanel, DateBox, DatePicker, DisclosurePanel, MonthSelector, NotificationMole, ResizeComposite, SuggestBox, TabBar, TabPanel, ValueBoxEditorDecorator<T>, ValueListBox<T>, ValuePicker<T>

AbstractCellTree	An abstract representation of a tree widget that renders items using `Cell`s.
AbstractPager	An abstract pager that exposes many methods useful for paging.
CalendarView	The CalendarView is a calendar grid that represents the current view of a `DatePicker`.
CaptionPanel	A panel that wraps its contents in a border with a caption that appears in the upper left corner of the border.
DateBox	A text box that shows a `DatePicker` when the user focuses on it.
DatePicker	Standard GWT date picker.
DisclosurePanel	A widget that consists of a header and a content panel that discloses the content when a user clicks on the header.
MonthSelector	Abstract month selector widget.
NotificationMole	Simple widget for providing notification feedback.
ResizeComposite	A `Composite` implementation that implements `RequiresResize` and automatically delegates that interface's methods to its wrapped widget, which must itself implement `RequiresResize`.
SuggestBox	A `SuggestBox` is a text box or text area which displays a pre-configured set of selections that match the user's input.
TabBar	A horizontal bar of folder-style tabs, most commonly used as part of a `TabPanel`.
TabPanel	A panel that represents a tabbed set of pages, each of which contains another widget.
ValueBoxEditorDecorator<T>	A simple decorator to display leaf widgets with an error message.
ValueListBox<T>	Implementation of `HasConstrainedValue` based on a `SelectElement`.
ValuePicker<T>	Allows the user to pick a single value from a list.

Known Indirect Subclasses

CellBrowser, CellTree, DecoratedTabBar, DecoratedTabPanel, DefaultCalendarView, DefaultMonthSelector, PageSizePager, SimplePager, StackLayoutPanel, TabLayoutPanel

Class Overview

A type of widget that can wrap another widget, hiding the wrapped widget's methods. When added to a panel, a composite behaves exactly as if the widget it wraps had been added.

The composite is useful for creating a single widget out of an aggregate of multiple other widgets contained in a single panel.

Example

{@example com.google.gwt.examples.CompositeExample}

Summary

[Expand]

Inherited Constants

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

Public Constructors
	Composite()

Public Methods
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).
void	onBrowserEvent(Event event) Fired whenever a browser event is received.

Protected Methods
Widget	getWidget() Provides subclasses access to the topmost widget that defines this composite.
void	initWidget(Widget widget) Sets the widget to be wrapped by the composite.
void	onAttach() This method is called when a widget is attached to the browser's document.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	setWidget(Widget widget) This method is deprecated. Use `initWidget(Widget)` instead

[Expand]

Inherited Methods

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

Public Constructors

public Composite ()

Public Methods

public 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).

Returns

true if the widget is attached

public void onBrowserEvent (Event event)

Fired whenever a browser event is received.

Parameters

event	the event received

Protected Methods

protected Widget getWidget ()

Provides subclasses access to the topmost widget that defines this composite.

Returns

the widget

protected void initWidget (Widget widget)

Sets the widget to be wrapped by the composite. The wrapped widget must be set before calling any Widget methods on this object, or adding it to a panel. This method may only be called once for a given composite.

Parameters

widget	the widget to be wrapped

protected void onAttach ()

This method is called when a widget is attached to the browser's document. To receive notification after a Widget has been added to the document, override the onLoad() method or use addAttachHandler(AttachEvent.Handler).

It is strongly recommended that you override onLoad() or doAttachChildren() instead of this method to avoid inconsistencies between logical and physical attachment states.

Subclasses that override this method must call super.onAttach() to ensure that the Widget has been attached to its underlying Element.

protected void onDetach ()

This method is called when a widget is detached from the browser's document. To receive notification before a Widget is removed from the document, override the onUnload() method or use addAttachHandler(AttachEvent.Handler).

It is strongly recommended that you override onUnload() or doDetachChildren() instead of this method to avoid inconsistencies between logical and physical attachment states.

Subclasses that override this method must call super.onDetach() to ensure that the Widget has been detached from the underlying Element. Failure to do so will result in application memory leaks due to circular references between DOM Elements and JavaScript objects.

protected void setWidget (Widget widget)

This method is deprecated.
Use initWidget(Widget) instead

This method was for initializing the Widget to be wrapped by this Composite, but has been deprecated in favor of initWidget(Widget).

Interfaces

Classes

Annotations

Enums

Exceptions

Composite

Class Overview

Example

Summary

Public Constructors

public Composite ()

Public Methods

public boolean isAttached ()

Returns

public void onBrowserEvent (Event event)

Parameters

Protected Methods

protected Widget getWidget ()

Returns

protected void initWidget (Widget widget)

Parameters

protected void onAttach ()

protected void onDetach ()

protected void setWidget (Widget widget)