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

Class AccordionLayoutContainer

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

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 AccordionLayoutContainer
extends InsertResizeContainer
implements HasActiveWidget

A layout container that manages multiple content panels in an expandable accordion style such that only one panel can be expanded at any given time (by default). Each panel has built-in support for expanding and collapsing.

Note: Only ContentPanel's and subclasses may be used in an accordion layout container. Each content panel should be created with AccordionLayoutContainer.AccordionLayoutAppearance to produce the expected accordion panel look and feel. The AccordionLayoutAppearance must be created using the GWT#create(Class) method to enable GWT class substitution, as illustrated in the following code snippet.

Code snippet:

 AccordionLayoutContainer con = new AccordionLayoutContainer();
 AccordionLayoutAppearance appearance = GWT.<AccordionLayoutAppearance> create(AccordionLayoutAppearance.class);

 ContentPanel cp = new ContentPanel(appearance);
 cp.setHeading("Accordion Item 1");
 cp.add(new Label("Accordion Content 1"));
 con.add(cp);
 con.setActiveWidget(cp);

 cp = new ContentPanel(appearance);
 cp.setHeading("Accordion Item 2");
 cp.add(new Label("Accordion Content 2"));
 con.add(cp);

 cp = new ContentPanel(appearance);
 cp.setHeading("Accordion Item 3");
 cp.add(new Label("Accordion Content 3"));
 con.add(cp);

 Viewport v = new Viewport();
 v.add(con);
 RootPanel.get().add(v);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AccordionLayoutContainer.AccordionLayoutAppearance AccordionLayoutContainer appearance.
static class	AccordionLayoutContainer.ExpandMode Defines the expand modes.

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
AccordionLayoutContainer() Creates a new accordion layout container.

Method Summary

Modifier and Type	Method and Description
protected void	doLayout()
boolean	getActiveOnTop() Returns true if the active item if first.
Widget	getActiveWidget() Returns the active widget.
AccordionLayoutContainer.ExpandMode	getExpandMode() Returns the expand mode.
boolean	isHideCollapseTool() Returns true if the collapse tool is hidden.
boolean	isTitleCollapse() Returns true if title collapse is enabled.
protected void	onBeforeExpand(BeforeExpandEvent event)
protected void	onExpand(ExpandEvent event)
protected void	onInsert(int index, Widget child)
protected void	onRemove(Widget child)
void	setActiveOnTop(boolean activeOnTop) True to swap the position of each panel as it is expanded so that it becomes the first item in the container, false to keep the panels in the rendered order (defaults to false).
void	setActiveWidget(Widget widget) Sets the active widget.
void	setExpandMode(AccordionLayoutContainer.ExpandMode expandMode) Sets the expand mode (defaults to AccordionLayoutContainer.ExpandMode.SINGLE_FILL).
void	setHideCollapseTool(boolean hideCollapseTool) True to hide the contained panels' collapse/expand toggle buttons, false to display them (defaults to false).
void	setTitleCollapse(boolean titleCollapse) True to allow expand/collapse of each contained panel by clicking anywhere on the title bar, false to allow expand/collapse only when the toggle tool button is clicked (defaults to true).

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

AccordionLayoutContainer

public AccordionLayoutContainer()

Creates a new accordion layout container.

Method Detail

getActiveOnTop

public boolean getActiveOnTop()

Returns true if the active item if first.

Returns:

the active on top state

getActiveWidget

public Widget getActiveWidget()

Description copied from interface: HasActiveWidget

Returns the active widget.

Specified by:

getActiveWidget in interface HasActiveWidget

Returns:

the active widget

getExpandMode

public AccordionLayoutContainer.ExpandMode getExpandMode()

Returns the expand mode.

Returns:

the expand mode

isHideCollapseTool

public boolean isHideCollapseTool()

Returns true if the collapse tool is hidden.

Returns:

the hide collapse tool state

isTitleCollapse

public boolean isTitleCollapse()

Returns true if title collapse is enabled.

Returns:

the title collapse state

setActiveOnTop

public void setActiveOnTop(boolean activeOnTop)

True to swap the position of each panel as it is expanded so that it becomes the first item in the container, false to keep the panels in the rendered order (defaults to false).

Parameters:

activeOnTop - true to keep the active item on top

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

setExpandMode

public void setExpandMode(AccordionLayoutContainer.ExpandMode expandMode)

Sets the expand mode (defaults to AccordionLayoutContainer.ExpandMode.SINGLE_FILL).

Parameters:

expandMode - the mode

setHideCollapseTool

public void setHideCollapseTool(boolean hideCollapseTool)

True to hide the contained panels' collapse/expand toggle buttons, false to display them (defaults to false). When set to true, titleCollapse should be true also.

Parameters:

hideCollapseTool - true to hide the collapse tool

setTitleCollapse

public void setTitleCollapse(boolean titleCollapse)

True to allow expand/collapse of each contained panel by clicking anywhere on the title bar, false to allow expand/collapse only when the toggle tool button is clicked (defaults to true). When set to false, hideCollapseTool should be false also.

Parameters:

titleCollapse - true for title collapse

doLayout

protected void doLayout()

Specified by:

doLayout in class ResizeContainer

onBeforeExpand

protected void onBeforeExpand(BeforeExpandEvent event)

onExpand

protected void onExpand(ExpandEvent event)

onInsert

protected void onInsert(int index,
                        Widget child)

Overrides:

onInsert in class Container

onRemove

protected void onRemove(Widget child)

Overrides:

onRemove in class Container