com.extjs.gxt.ui.client.widget
Class CollapsePanel

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.Container<T>
                      extended by com.extjs.gxt.ui.client.widget.ScrollContainer<Component>
                          extended by com.extjs.gxt.ui.client.widget.LayoutContainer
                              extended by com.extjs.gxt.ui.client.widget.ContentPanel
                                  extended by com.extjs.gxt.ui.client.widget.CollapsePanel
All Implemented Interfaces:
Observable, IconSupport, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class CollapsePanel
extends ContentPanel

The collapse state of a content panel.

Inherited Events:
ContentPanel BeforeExpand
ContentPanel Expand
ContentPanel BeforeCollapse
ContentPanel Collapse
ContentPanel BeforeClose
ContentPanel Close
LayoutContainer AfterLayout
ScrollContainer Scroll
Container BeforeAdd
Container Add
Container BeforeRemove
Container Remove
BoxComponent Move
BoxComponent Resize
Component Enable
Component Disable
Component BeforeHide
Component Hide
Component BeforeShow
Component Show
Component Attach
Component Detach
Component BeforeRender
Component Render
Component BrowserEvent
Component BeforeStateRestore
Component StateRestore
Component BeforeStateSave
Component SaveState


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
protected  int[] adj
           
protected  java.lang.String align
           
protected  ToolButton expandButton
           
protected  ContentPanel panel
           
protected  BorderLayoutData parentData
           
protected  Popup popup
           
protected  Style.LayoutRegion region
           
 
Fields inherited from class com.extjs.gxt.ui.client.widget.ContentPanel
bbarStyle, bodStyle, body, bwrap, bwrapStyle, collapseStyle, fbar, footerStyle, frame, head, headerStyle, headerTextStyle, tbarStyle
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Container
attachChildren, enableLayout, layoutExecuted, layoutNeeded, layoutOnAttach, layoutOnChange
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
CollapsePanel(ContentPanel panel, BorderLayoutData data)
          Creates a new collapse panel.
 
Method Summary
protected  void afterHidePanel(ContentPanel panel)
           
protected  void afterShowPanel(ContentPanel panel)
           
protected  void doAttachChildren()
           
protected  void doDetachChildren()
           
 ToolButton getCollapseButton()
           
 ContentPanel getContentPanel()
          Returns the panel's content panel.
 int getFrameHeight()
          Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and header and footer elements, but not including the body height).
protected  Size getFrameSize()
           
 int getFrameWidth()
          Returns the width in pixels of the framing elements of this panel (not including the body width).
 El getLayoutTarget()
          Override this method to specify the element to be used by the layout as the container.
 boolean isExpanded()
          Returns true if the panel is expanded.
 void onComponentEvent(ComponentEvent ce)
          Any events a component receives will be forwarded to this method.
protected  void onExpand()
           
protected  void onExpandButton(BaseEvent be)
           
protected  void onHidePanel(ContentPanel panel)
           
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
protected  void onShowPanel(ContentPanel panel)
           
 void setExpanded(boolean expanded)
          Sets the panel's expand state.
 
Methods inherited from class com.extjs.gxt.ui.client.widget.ContentPanel
addButton, adjustBodySize, afterCollapse, afterExpand, collapse, createStyles, expand, getAnimCollapse, getBody, getBodyBorder, getBodyStyle, getBottomComponent, getButtonAlign, getButtonBar, getCollapseBtn, getCollapsible, getElement, getFrame, getHeader, getHeading, getIcon, getInnerHeight, getInnerWidth, getMinButtonWidth, getTitleCollapse, getTitleText, getTopComponent, initTools, isCollapsed, isFooter, isHeaderVisible, isHideCollapseTool, layoutBars, notifyHide, notifyShow, onClick, onCollapse, onDisable, onEnable, onResize, remove, setAnimCollapse, setBodyBorder, setBodyStyle, setBodyStyleName, setBottomComponent, setButtonAlign, setCollapsible, setFooter, setFrame, setHeaderVisible, setHeading, setHideCollapseTool, setIcon, setIconStyle, setInsetBorder, setMinButtonWidth, setTitleCollapse, setTopComponent, setUrl
 
Methods inherited from class com.extjs.gxt.ui.client.widget.LayoutContainer
add, add, addText, findComponent, getLayout, getWindowResizeDelay, insert, insert, isLayoutOnChange, isMonitorWindowResize, layout, layout, onBlur, onFocus, remove, removeAll, setLayout, setLayoutData, setLayoutOnChange, setMonitorWindowResize, setWindowResizeDelay
 
Methods inherited from class com.extjs.gxt.ui.client.widget.ScrollContainer
addScrollListener, afterRender, getHScrollPosition, getScrollMode, getVScrollPosition, removeScrollListener, scrollIntoView, setHScrollPosition, setScrollMode, setVScrollPosition
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Container
add, adjustIndex, adopt, createContainerEvent, disable, doLayout, doLayout, enable, findItem, getItem, getItemByItemId, getItemCount, getItems, getWidget, indexOf, insert, isLayoutNeeded, iterator, onAfterLayout, onAttach, onBeforeLayoutExcecuted, onInsert, onLayoutExcecuted, onRemove, orphan, remove, removeAll, scrollIntoView, setLayoutNeeded, wrapWidget
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, createComponentEvent, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onHide, onPosition, onShow, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, disableContextMenu, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, onBrowserEvent, onDetach, onDetachHelper, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

adj

protected int[] adj

align

protected java.lang.String align

expandButton

protected ToolButton expandButton

panel

protected ContentPanel panel

parentData

protected BorderLayoutData parentData

popup

protected Popup popup

region

protected Style.LayoutRegion region
Constructor Detail

CollapsePanel

public CollapsePanel(ContentPanel panel,
                     BorderLayoutData data)
Creates a new collapse panel.

Parameters:
panel - the parent content panel
data - the border layout data
Method Detail

getCollapseButton

public ToolButton getCollapseButton()

getContentPanel

public ContentPanel getContentPanel()
Returns the panel's content panel.

Returns:
the content panel

getFrameHeight

public int getFrameHeight()
Description copied from class: ContentPanel
Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and header and footer elements, but not including the body height). To retrieve the body height see ContentPanel.getInnerHeight().

Overrides:
getFrameHeight in class ContentPanel
Returns:
the frame height

getFrameWidth

public int getFrameWidth()
Description copied from class: ContentPanel
Returns the width in pixels of the framing elements of this panel (not including the body width). To retrieve the body width see ContentPanel.getInnerWidth().

Overrides:
getFrameWidth in class ContentPanel
Returns:
The frame width

getLayoutTarget

public El getLayoutTarget()
Description copied from class: LayoutContainer
Override this method to specify the element to be used by the layout as the container. Allows the container to be decorated.

Overrides:
getLayoutTarget in class ContentPanel
Returns:
the element to be used as the panel's container

isExpanded

public boolean isExpanded()
Description copied from class: ContentPanel
Returns true if the panel is expanded.

Overrides:
isExpanded in class ContentPanel
Returns:
the expand state

onComponentEvent

public void onComponentEvent(ComponentEvent ce)
Description copied from class: Component
Any events a component receives will be forwarded to this method. Subclasses should override as needed. The Component.onBrowserEvent(com.google.gwt.user.client.Event) method should not be overridden or modified.

Overrides:
onComponentEvent in class ContentPanel
Parameters:
ce - the base event

setExpanded

public void setExpanded(boolean expanded)
Description copied from class: ContentPanel
Sets the panel's expand state.

Overrides:
setExpanded in class ContentPanel
Parameters:
expanded - true true to expand

afterHidePanel

protected void afterHidePanel(ContentPanel panel)

afterShowPanel

protected void afterShowPanel(ContentPanel panel)

doAttachChildren

protected void doAttachChildren()
Overrides:
doAttachChildren in class ContentPanel

doDetachChildren

protected void doDetachChildren()
Overrides:
doDetachChildren in class ContentPanel

getFrameSize

protected Size getFrameSize()
Overrides:
getFrameSize in class ContentPanel

onExpand

protected void onExpand()
Overrides:
onExpand in class ContentPanel

onExpandButton

protected void onExpandButton(BaseEvent be)

onHidePanel

protected void onHidePanel(ContentPanel panel)

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)
Description copied from class: Component
Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:
onRender in class ContentPanel
Parameters:
target - the target element
index - the insert location

onShowPanel

protected void onShowPanel(ContentPanel panel)