Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.google.gwt.user.client.ui
Class Composite

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

All Implemented Interfaces:
  EventListener

Direct Known Subclasses:
  DisclosurePanel, SuggestBox, TabBar, TabPanel

    public abstract class Composite

extends Widget

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

>     public class CompositeExample implements EntryPoint {

>       /**
>        * A composite of a TextBox and a CheckBox that optionally enables it.
>        */
>       private static class OptionalTextBox extends Composite implements
>           ClickListener {

>         private TextBox textBox = new TextBox();
>         private CheckBox checkBox = new CheckBox();

>         /**
>          * Constructs an OptionalTextBox with the given caption on the check.
>          *
>          * @param caption the caption to be displayed with the check box
>          */
>         public OptionalTextBox(String caption) {
>           // Place the check above the text box using a vertical panel.
>           VerticalPanel panel = new VerticalPanel();
>           panel.add(checkBox);
>           panel.add(textBox);

>           // Set the check box's caption, and check it by default.
>           checkBox.setText(caption);
>           checkBox.setChecked(true);
>           checkBox.addClickListener(this);

>           // All composites must call initWidget() in their constructors.
>           initWidget(panel);

>           // Give the overall composite a style name.
>           setStyleName("example-OptionalCheckBox");
>         }

>         public void onClick(Widget sender) {
>           if (sender == checkBox) {
>             // When the check box is clicked, update the text box's enabled state.
>             textBox.setEnabled(checkBox.isChecked());
>           }
>         }

>         /**
>          * Sets the caption associated with the check box.
>          *
>          * @param caption the check box's caption
>          */
>         public void setCaption(String caption) {
>           // Note how we use the use composition of the contained widgets to provide
>           // only the methods that we want to.
>           checkBox.setText(caption);
>         }

>         /**
>          * Gets the caption associated with the check box.
>          *
>          * @return the check box's caption
>          */
>         public String getCaption() {
>           return checkBox.getText();
>         }
>       }

>       public void onModuleLoad() {
>         // Create an optional text box and add it to the root panel.
>         OptionalTextBox otb = new OptionalTextBox("Check this to enable me");
>         RootPanel.get().add(otb);
>       }
>     }

Constructor Summary
`Composite()`

Method Summary
`Element` | `getElement()` This override checks to ensure `initWidget(Widget)` has been called.
`protected Widget` | `getWidget()` Provides subclasses access to the topmost widget that defines this composite.
`protected void` | `initWidget(Widget widget)` Sets the widget to be wrapped by the composite.
`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).
`protected void` | `onAttach()` This method is called when a widget is attached to the browser's document.
`protected void` | `onDetach()` This method is called when a widget is detached from the browser's document.
`protected void` | `setWidget(Widget widget)` Deprecated. this method is deprecated, and will be removed (use `initWidget(Widget)` instead)

Methods inherited from class com.google.gwt.user.client.ui.Widget
`doAttachChildren, doDetachChildren, getParent, onBrowserEvent, onLoad, onUnload, removeFromParent, setElement`

Methods inherited from class com.google.gwt.user.client.ui.UIObject
`addStyleDependentName, addStyleName, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, setHeight, setPixelSize, setSize, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkEvents, toString, unsinkEvents`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### Composite

    public Composite()

Method Detail

### getElement

    public Element getElement()

  This override checks to ensure `initWidget(Widget)` has been called.

  Overrides:
    `getElement` in class `UIObject`
  Returns:
    the object's browser element

### isAttached

    public boolean isAttached()

  Description copied from class: `Widget`
  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).

  Overrides:
    `isAttached` in class `Widget`
  Returns:
    `true` if the widget is attached

### getWidget

    protected Widget getWidget()

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

  Returns:
    the widget

### initWidget

    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

### onAttach

    protected void onAttach()

  Description copied from class: `Widget`
  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 `Widget.onLoad()` method.

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

  Overrides:
    `onAttach` in class `Widget`

### onDetach

    protected void onDetach()

  Description copied from class: `Widget`
  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 `Widget.onUnload()` method.

  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.

  Overrides:
    `onDetach` in class `Widget`

### setWidget

    protected void setWidget(Widget widget)

  Deprecated. this method is deprecated, and will be removed (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)`.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD