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

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.Composite
All Implemented Interfaces:
Observable, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

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
protected  Component component
           
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
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.
 com.google.gwt.user.client.Element getElement()
           
protected  void initComponent(Component component)
           
 boolean isAttached()
           
protected  void onAttach()
           
 void onBrowserEvent(com.google.gwt.user.client.Event event)
          Components delegate event handling to Component.onComponentEvent(ComponentEvent).
protected  void onDetach()
           
protected  void onDisable()
           
protected  void onEnable()
           
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
 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
adjustPosition, adjustSize, afterRender, createComponentEvent, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onHide, onPosition, onResize, onShow, onUnload, 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
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disable, disableContextMenu, disableEvents, disableTextSelection, doAttachChildren, doDetachChildren, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, notifyHide, notifyShow, onComponentEvent, onDetachHelper, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

component

protected Component component
Constructor Detail

Composite

public Composite()
Method Detail

getComponent

public Component getComponent()
Returns the wrapped component.

Returns:
the component

getElement

public com.google.gwt.user.client.Element getElement()
Overrides:
getElement in class 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

initComponent

protected void initComponent(Component component)

onAttach

protected void onAttach()
Overrides:
onAttach in class Component

onDetach

protected void onDetach()
Overrides:
onDetach in class Component

onDisable

protected void onDisable()
Overrides:
onDisable in class Component

onEnable

protected void onEnable()
Overrides:
onEnable in class Component

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)
Description copied from class: Component
Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:
onRender in class Component
Parameters:
target - the target element
index - the insert location