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

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
                  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:

HasAttachHandlers, HasResizeHandlers, HasHandlers, EventListener, HasEnabled, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, IndexedPanel, IndexedPanel.ForIsWidget, InsertPanel, InsertPanel.ForIsWidget, IsWidget, ProvidesResize, RequiresResize, 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, java.lang.Iterable<Widget>

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

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

InsertPanel.ForIsWidget

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

HasWidgets.ForIsWidget

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

CardLayoutContainer()
Creates a card layout container.

Method Summary

void	add(IsWidget child, MarginData layoutData) Adds a widget to a card layout container with specified layout parameters.
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.
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

forceLayout, isLayoutRunning, isOrWasLayoutRunning, onResize

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

add, add, addAddHandler, addBeforeAddHandler, addBeforeRemoveHandler, addContainerHandler, addRemoveHandler, clear, disable, enable, findWidget, getItemByItemId, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, iterator, remove, remove, remove

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, 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

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

add

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel

add

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

getWidgetIndex

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel

getWidget, getWidgetCount, getWidgetIndex, remove

Constructor Detail

CardLayoutContainer

public CardLayoutContainer()

Creates a card layout container.

Method Detail

add

@UiChild(tagname="child")
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.

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