com.sencha.gxt.widget.core.client.container

Class Container

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.container.Container

All Implemented Interfaces:

HasAttachHandlers, HasResizeHandlers, HasHandlers, EventListener, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, IndexedPanel, IndexedPanel.ForIsWidget, IsWidget, AddEvent.HasAddHandlers, BeforeAddEvent.HasBeforeAddHandlers, BeforeHideEvent.HasBeforeHideHandlers, BeforeRemoveEvent.HasBeforeRemoveHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, ContainerHandler.HasContainerHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, RemoveEvent.HasRemoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId, Iterable<Widget>

Direct Known Subclasses:

AbstractHtmlLayoutContainer, InsertContainer, ResizeContainer

public abstract class Container
extends Component
implements HasWidgets.ForIsWidget, IndexedPanel.ForIsWidget, ContainerHandler.HasContainerHandlers

Abstract base for components that can contain child widgets.

Nested Class Summary

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

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

HasWidgets.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

IndexedPanel.ForIsWidget

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
Container()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(IsWidget child) Adds a widget to this panel.
void	add(Widget child) The expectation is that this method would be overridden by a child object.
HandlerRegistration	addAddHandler(AddEvent.AddHandler handler) Adds the AddEvent.AddHandler to the Container
HandlerRegistration	addBeforeAddHandler(BeforeAddEvent.BeforeAddHandler handler) Adds the BeforeAddEvent.BeforeAddHandler to the Container
HandlerRegistration	addBeforeRemoveHandler(BeforeRemoveEvent.BeforeRemoveHandler handler) Adds the BeforeRemoveEvent.BeforeRemoveHandler to the Container
HandlerRegistration	addContainerHandler(ContainerHandler handler) Adds the ContainerHandler to the Container
HandlerRegistration	addRemoveHandler(RemoveEvent.RemoveHandler handler) Adds the RemoveEvent.RemoveHandler to the Container
void	clear() Clears the container's children
void	disable() Disable this widget.
void	enable() Enable this widget.
Widget	findWidget(Element elem) Returns the widget whose element, or child element, matches the given element.
Widget	getItemByItemId(String itemId) Returns the child widget with the specified item id.
Widget	getWidget(int index)
int	getWidgetCount()
int	getWidgetIndex(IsWidget child)
int	getWidgetIndex(Widget child)
Iterator<Widget>	iterator()
boolean	remove(int index)
boolean	remove(IsWidget child)
boolean	remove(Widget child)

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, disableEvents, 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, onBrowserEvent, removeHandler, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, 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

Container

public Container()

Method Detail

add

public void add(IsWidget child)

Adds a widget to this panel.

Specified by:

add in interface HasWidgets.ForIsWidget

Parameters:

child - the child widget to be added

add

public void add(Widget child)

The expectation is that this method would be overridden by a child object. If you are getting an UnsupportedOperationException it is most likely that the child container has not done this properly. See gwt Panel add(Widget) for more details

Specified by:

add in interface HasWidgets

Parameters:

child - the child widget to be added. This panel does not support no-arg add()

Throws:

UnsupportedOperationException - if the derived class has not properly overridden the method

addAddHandler

public HandlerRegistration addAddHandler(AddEvent.AddHandler handler)

Adds the AddEvent.AddHandler to the Container

Specified by:

addAddHandler in interface AddEvent.HasAddHandlers

Parameters:

handler - the handler

Returns:

HandlerRegistration

addBeforeAddHandler

public HandlerRegistration addBeforeAddHandler(BeforeAddEvent.BeforeAddHandler handler)

Adds the BeforeAddEvent.BeforeAddHandler to the Container

Specified by:

addBeforeAddHandler in interface BeforeAddEvent.HasBeforeAddHandlers

Parameters:

handler - the handler

Returns:

HandlerRegistration

addBeforeRemoveHandler

public HandlerRegistration addBeforeRemoveHandler(BeforeRemoveEvent.BeforeRemoveHandler handler)

Adds the BeforeRemoveEvent.BeforeRemoveHandler to the Container

Specified by:

addBeforeRemoveHandler in interface BeforeRemoveEvent.HasBeforeRemoveHandlers

Parameters:

handler - the handler

Returns:

HandlerRegistration

addContainerHandler

public HandlerRegistration addContainerHandler(ContainerHandler handler)

Adds the ContainerHandler to the Container

Specified by:

addContainerHandler in interface ContainerHandler.HasContainerHandlers

Parameters:

handler - the handler

Returns:

HandlerRegistration

addRemoveHandler

public HandlerRegistration addRemoveHandler(RemoveEvent.RemoveHandler handler)

Adds the RemoveEvent.RemoveHandler to the Container

Specified by:

addRemoveHandler in interface RemoveEvent.HasRemoveHandlers

Parameters:

handler - the handler

Returns:

HandlerRegistration

clear

public void clear()

Clears the container's children

Specified by:

clear in interface HasWidgets

disable

public void disable()

Description copied from class: Component

Disable this widget.

Overrides:

disable in class Component

enable

public void enable()

Description copied from class: Component

Enable this widget.

Overrides:

enable in class Component

findWidget

public Widget findWidget(Element elem)

Returns the widget whose element, or child element, matches the given element.

Parameters:

elem - the element

Returns:

the matching widget or null if no match

getItemByItemId

public Widget getItemByItemId(String itemId)

Returns the child widget with the specified item id.

Parameters:

itemId - the item id

Returns:

the widget or null if no match

getWidget

public Widget getWidget(int index)

Specified by:

getWidget in interface IndexedPanel

getWidgetCount

public int getWidgetCount()

Specified by:

getWidgetCount in interface IndexedPanel

getWidgetIndex

public int getWidgetIndex(IsWidget child)

Specified by:

getWidgetIndex in interface IndexedPanel.ForIsWidget

getWidgetIndex

public int getWidgetIndex(Widget child)

Specified by:

getWidgetIndex in interface IndexedPanel

iterator

public Iterator<Widget> iterator()

Specified by:

iterator in interface HasWidgets

Specified by:

iterator in interface Iterable<Widget>

remove

public boolean remove(int index)

Specified by:

remove in interface IndexedPanel

remove

public boolean remove(IsWidget child)

Specified by:

remove in interface HasWidgets.ForIsWidget

remove

public boolean remove(Widget child)

Specified by:

remove in interface HasWidgets