com.sencha.gxt.widget.core.client

Class WidgetComponent

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

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

public class WidgetComponent
extends Component

Creates a widget from a widget. This allows widgets to be treated as components.

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
WidgetComponent(Widget widget) Creates a new widget wrapper.

Method Summary

Methods

Modifier and Type	Method and Description
XElement	getElement() Gets a handle to the object's underlying DOM element.
Widget	getWidget() Returns the underlying widget.
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)
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, 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

WidgetComponent

public WidgetComponent(Widget widget)

Creates a new widget wrapper.

Parameters:

widget - the widget to be wrapped

Method Detail

getElement

public XElement getElement()

Description copied from class: Component

Gets a handle to the object's underlying DOM element. This method should not be overridden. It is non-final solely to support legacy code that depends upon overriding it. If it is overridden, the subclass implementation must not return a different element than was previously set using UIObject.setElement(com.google.gwt.user.client.Element).

Overrides:

getElement in class Component

Returns:

the object's browser element

getWidget

public Widget getWidget()

Returns the underlying widget.

Returns:

the widget

isAttached

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

Specified by:

isAttached in interface HasAttachHandlers

Overrides:

isAttached in class Widget

Returns:

true if the widget is attached

onBrowserEvent

public void onBrowserEvent(Event event)

Specified by:

onBrowserEvent in interface EventListener

Overrides:

onBrowserEvent in class Component

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

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