com.extjs.gxt.ui.client.widget
Class Composite

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.BoxComponent
                  com.extjs.gxt.ui.client.widget.Composite

All Implemented Interfaces:

Observable, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener

public class Composite
extends BoxComponent

A component that wraps another component, hiding the wrapped components public API.

initComponent(Component) must be called to initialize the composite.

If the wrapped components is a LayoutContainer instance, it's layout will be executed as if the composite was a LayoutContainer.

Code snippet:

 public void onModuleLoad() {
   class TestComposite extends Composite {
     public TestComposite() {
       LayoutContainer c = new LayoutContainer();
       c.setLayout(new RowLayout(Orientation.HORIZONTAL));
 
       ContentPanel cp1 = new ContentPanel();
       cp1.setHeading("Composite Test 1");
       c.add(cp1, new RowData(.5, 1));
 
       ContentPanel cp2 = new ContentPanel();
       cp2.setHeading("Composite Test 2");
       c.add(cp2, new RowData(.5, 1));
 
       initComponent(c);
     }
   }
 
   Viewport v = new Viewport();
   v.setLayout(new FitLayout());
   v.add(new TestComposite());
   RootPanel.get().add(v);
 }
 

Inherited Events:

BoxComponent Move

BoxComponent Resize

Component Enable

Component Disable

Component BeforeHide

Component Hide

Component BeforeShow

Component Show

Component Attach

Component Detach

Component BeforeRender

Component Render

Component BrowserEvent

Component BeforeStateRestore

Component StateRestore

Component BeforeStateSave

Component SaveState

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Composite()

Method Summary

Component	getComponent() Returns the wrapped component.
boolean	isAttached()
void	onBrowserEvent(com.google.gwt.user.client.Event event) Components delegate event handling to Component.onComponentEvent(ComponentEvent).
void	setSize(int width, int height) Sets the width and height of the component.
void	setSize(java.lang.String width, java.lang.String height) Sets the width and height of the component.

Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent

getBounds, getHeight, getHeight, getPosition, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, isAutoHeight, isAutoWidth, isDeferHeight, isShim, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setWidth, setWidth, sync, syncSize

Methods inherited from class com.extjs.gxt.ui.client.widget.Component

addListener, addPlugin, addStyleName, addWidgetListener, clearState, disable, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getContextMenu, getData, getElement, getHideMode, getId, getItemId, getListeners, getModel, getState, getStateId, getToolTip, hasListeners, hasListeners, hide, hideToolTip, isDisabledEvents, isEnabled, isRendered, isStateful, isVisible, mask, mask, mask, onComponentEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setBorders, setContextMenu, setData, setElement, setEnabled, setHideMode, setId, setIntStyleAttribute, setItemId, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget

fireEvent, getParent

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, unsinkEvents

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Composite

public Composite()

Method Detail

getComponent

public Component getComponent()

Returns the wrapped component.

Returns:

the component

isAttached

public boolean isAttached()

Overrides:

isAttached in class com.google.gwt.user.client.ui.Widget

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Description copied from class: Component

Components delegate event handling to Component.onComponentEvent(ComponentEvent). Subclasses should not override.

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class Component

Parameters:

event - the dom event

setSize

public void setSize(int width,
                    int height)

Description copied from class: BoxComponent

Sets the width and height of the component. This method fires the Resize event.

Overrides:

setSize in class BoxComponent

Parameters:

width - the new width to set

height - the new height to set

setSize

public void setSize(java.lang.String width,
                    java.lang.String height)

Description copied from class: BoxComponent

Sets the width and height of the component. This method fires the Resize event.

Overrides:

setSize in class BoxComponent

Parameters:

width - the new width to set

height - the new height to set