com.sencha.gxt.widget.core.client

Class Composite

java.lang.Object

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

com.google.gwt.user.client.ui.Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.Composite

All Implemented Interfaces:

HasAttachHandlers, HasResizeHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId

Direct Known Subclasses:

ColumnHeader, WidgetComponent

public class Composite
extends Component

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

initWidget(Widget) must be called to initialize the composite.

Code snippet:

 public void onModuleLoad() {
   class TestComposite extends Composite {
     public TestComposite() {
       HorizontalLayoutContainer c = new HorizontalLayoutContainer();

       ContentPanel cp1 = new ContentPanel();
       cp1.setHeadingText("Composite Test 1");
       c.add(cp1, new HorizontalLayoutData(.5, 1));

       ContentPanel cp2 = new ContentPanel();
       cp2.setHeadingText("Composite Test 2");
       c.add(cp2, new HorizontalLayoutData(.5, 1));

       initWidget(c);
     }
   }

   Viewport v = new Viewport();
   v.add(new TestComposite());
   RootPanel.get().add(v);
 }
 

Nested Class Summary

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

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
Composite()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isAttached()
void	onBrowserEvent(Event event)
void	setHeight(int height) Sets the widget's height.
void	setPixelSize(int width, int height) Sets the component's size.
void	setWidth(int width) Sets the width of the widget.

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disable, disableEvents, enable, enableEvents, fireEvent, focus, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getStateId, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, removeHandler, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHideMode, setId, setItemId, setPagePosition, setPosition, setShadow, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, show, sync, syncSize, unmask

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, removeFromParent, setLayoutData, sinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

Composite

public Composite()

Method Detail

isAttached

public boolean isAttached()

Specified by:

isAttached in interface HasAttachHandlers

Overrides:

isAttached in class Widget

onBrowserEvent

public void onBrowserEvent(Event event)

Specified by:

onBrowserEvent in interface EventListener

Overrides:

onBrowserEvent in class Component

setWidth

public void setWidth(int width)

Description copied from class: Component

Sets the width of the widget. This method fires the Resize event.

Overrides:

setWidth in class Component

Parameters:

width - the new width to set

setHeight

public void setHeight(int height)

Description copied from class: Component

Sets the widget's height. This method fires the Resize event. element.

Overrides:

setHeight in class Component

Parameters:

height - the new height

setPixelSize

public void setPixelSize(int width,
                int height)

Description copied from class: Component

Sets the component's size. Unlike GWT widget's, when setting sizes, the component's actual size will match exactly the size specified independent of borders and padding.

Overrides:

setPixelSize in class Component

Parameters:

width - new width, in pixels

height - height, in pixels