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

Class CardLayoutContainer

java.lang.Object

Widget

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

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

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

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

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

All Implemented Interfaces:

HasGestureRecognizers, HasActiveWidget, HasLayout, 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

public class CardLayoutContainer
extends InsertResizeContainer
implements HasActiveWidget

A layout container that contains multiple widgets, each fit to the container, where only a single widget can be visible at any given time. This layout style is most commonly used for wizards, tab implementations, etc.

Code Snippet:

    final CardLayoutContainer c = new CardLayoutContainer();
    c.add(new Label("Card 1"));
    c.add(new Label("Card 2"));
    RootPanel.get().add(c);
    Scheduler.get().scheduleFixedDelay(new RepeatingCommand() {
       @Override
      public boolean execute() {
        c.setActiveWidget(c.getActiveWidget() == c.getWidget(0) ? c.getWidget(1) : c.getWidget(0));
        return true;
      }
    }, 500);
 

Field Summary

Fields inherited from class com.sencha.gxt.widget.core.client.container.ResizeContainer

forceLayoutCommand, forceLayoutOnResize, hadLayoutRunning, layoutCommand, layoutRequiredThisEventLoop, layoutRunning

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
CardLayoutContainer() Creates a card layout container.

Method Summary

Modifier and Type	Method and Description
void	add(IsWidget child, MarginData layoutData) Adds a widget to a card layout container with specified layout parameters.
protected void	doLayout()
protected void	forceLayoutOnChildren(IndexedPanel widgets)
Widget	getActiveWidget() Returns the active widget.
void	insert(IsWidget w, int beforeIndex, MarginData layoutData) Inserts the widget at the specified index in the card layout container.
protected void	onInsert(int index, Widget child)
protected void	onRemove(Widget child)
void	setActiveWidget(IsWidget widget) Sets the active widget.
void	setActiveWidget(Widget widget) Sets the active widget.

Methods inherited from class com.sencha.gxt.widget.core.client.container.InsertResizeContainer

insert, insert

Methods inherited from class com.sencha.gxt.widget.core.client.container.ResizeContainer

applyLayout, applyLayout, forceLayout, getLeftRightMargins, getParentLayoutWidget, getSideMargins, getTopBottomMargins, isLayoutRunning, isOrWasLayoutRunning, isWidgetVisible, onBeforeDoLayout, onLoad, onResize, onResize

Methods inherited from class com.sencha.gxt.widget.core.client.container.Container

add, add, addAddHandler, addBeforeAddHandler, addBeforeRemoveHandler, addContainerHandler, addRemoveHandler, adjustIndex, adopt, checkIndexBoundsForInsertion, clear, disable, doAttachChildren, doDetachChildren, doPhysicalAttach, doPhysicalDetach, enable, ensureGroupingHandlerRegistration, findWidget, getChildren, getContainerTarget, getItemByItemId, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, iterator, onWidgetHide, onWidgetShow, orphan, remove, remove, remove

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

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disableContextMenu, disableEvents, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getElement, getFocusEl, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, 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, onPosition, onRightClick, onShow, onShowContextMenu, onTouch, 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

CardLayoutContainer

public CardLayoutContainer()

Creates a card layout container.

Method Detail

add

public void add(IsWidget child,
                MarginData layoutData)

Adds a widget to a card layout container with specified layout parameters.

Parameters:

child - the widget to add to the layout container

layoutData - the parameters that describe how to layout the widget

getActiveWidget

public Widget getActiveWidget()

Description copied from interface: HasActiveWidget

Returns the active widget.

Specified by:

getActiveWidget in interface HasActiveWidget

Returns:

the active widget

insert

public void insert(IsWidget w,
                   int beforeIndex,
                   MarginData layoutData)

Inserts the widget at the specified index in the card layout container.

Parameters:

w - the widget to insert in the layout container

beforeIndex - the insert index

layoutData - the parameters that describe how to lay out the widget

setActiveWidget

public void setActiveWidget(IsWidget widget)

Sets the active widget.

Specified by:

setActiveWidget in interface HasActiveWidget

Parameters:

widget - the widget

setActiveWidget

public void setActiveWidget(Widget widget)

Description copied from interface: HasActiveWidget

Sets the active widget.

Specified by:

setActiveWidget in interface HasActiveWidget

Parameters:

widget - the widget

forceLayoutOnChildren

protected void forceLayoutOnChildren(IndexedPanel widgets)

Overrides:

forceLayoutOnChildren in class ResizeContainer

doLayout

protected void doLayout()

Specified by:

doLayout in class ResizeContainer

onInsert

protected void onInsert(int index,
                        Widget child)

Overrides:

onInsert in class Container

onRemove

protected void onRemove(Widget child)

Overrides:

onRemove in class Container