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

Class Container

java.lang.Object

Widget

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractHtmlLayoutContainer, InsertContainer, ResizeContainer

public abstract class Container
extends Component
implements ContainerHandler.HasContainerHandlers

Abstract base for components that can contain child widgets.

Field Summary

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

adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
Container()

Method Summary

Modifier and Type	Method and Description
void	add(IsWidget child) Adds a widget to this panel.
void	add(Widget child) Adds the specified widget to the container.
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
protected int	adjustIndex(Widget child, int beforeIndex)
protected void	adopt(Widget child)
protected void	checkIndexBoundsForInsertion(int index)
void	clear() Clears the container's children
void	disable() Disable this widget.
protected void	doAttachChildren()
protected void	doDetachChildren()
protected void	doPhysicalAttach(Widget child, int beforeIndex)
protected void	doPhysicalDetach(Widget child)
void	enable() Enable this widget.
protected GroupingHandlerRegistration	ensureGroupingHandlerRegistration(Widget widget)
Widget	findWidget(Element elem) Returns the widget whose element, or child element, matches the given element.
protected WidgetCollection	getChildren() Gets the list of children contained in this panel.
protected XElement	getContainerTarget()
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)
protected void	insert(Widget child, int beforeIndex) Insert a new child Widget into this Panel at a specified index, attaching its Element to the specified container Element.
Iterator<Widget>	iterator()
protected void	onInsert(int index, Widget child)
protected void	onRemove(Widget child)
protected void	onWidgetHide(Widget source)
protected void	onWidgetShow(Widget source)
protected void	orphan(Widget child)
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, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disableContextMenu, disableEvents, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, notifyShow, onAfterFirstAttach, onAttach, onBlur, onBrowserEvent, onDetach, onDisable, onEnable, onFocus, onHide, onHideContextMenu, onLoad, onPosition, onResize, onRightClick, onShow, onShowContextMenu, onUnload, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Container

public Container()

Method Detail

add

public void add(IsWidget child)

Adds a widget to this panel.

Parameters:

child - the child widget to be added

add

public void add(Widget child)

Adds the specified widget to the container.

If you override this method, please see Panel#add(Widget) for a number of things you must take into consideration.

Parameters:

child - the child widget to be added.

Throws:

UnsupportedOperationException - if the derived class has not properly overridden the method. See Panel#add(Widget) for more information.

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

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)

getWidgetCount

public int getWidgetCount()

getWidgetIndex

public int getWidgetIndex(IsWidget child)

getWidgetIndex

public int getWidgetIndex(Widget child)

iterator

public Iterator<Widget> iterator()

remove

public boolean remove(int index)

remove

public boolean remove(IsWidget child)

remove

public boolean remove(Widget child)

adjustIndex

protected int adjustIndex(Widget child,
                          int beforeIndex)

adopt

protected final void adopt(Widget child)

checkIndexBoundsForInsertion

protected void checkIndexBoundsForInsertion(int index)

doAttachChildren

protected void doAttachChildren()

doDetachChildren

protected void doDetachChildren()

doPhysicalAttach

protected void doPhysicalAttach(Widget child,
                                int beforeIndex)

doPhysicalDetach

protected void doPhysicalDetach(Widget child)

ensureGroupingHandlerRegistration

protected GroupingHandlerRegistration ensureGroupingHandlerRegistration(Widget widget)

getChildren

protected WidgetCollection getChildren()

Gets the list of children contained in this panel.

Returns:

a collection of child widgets

getContainerTarget

protected XElement getContainerTarget()

insert

protected void insert(Widget child,
                      int beforeIndex)

Insert a new child Widget into this Panel at a specified index, attaching its Element to the specified container Element. The child Element will either be attached to the container at the same index, or simply appended to the container, depending on the value of domInsert.

Parameters:

child - the child Widget to be added

beforeIndex - the index before which child will be inserted

onInsert

protected void onInsert(int index,
                        Widget child)

onRemove

protected void onRemove(Widget child)

onWidgetHide

protected void onWidgetHide(Widget source)

onWidgetShow

protected void onWidgetShow(Widget source)

orphan

protected final void orphan(Widget child)