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

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.BoxComponent
                  com.extjs.gxt.ui.client.widget.Container<T>
                      com.extjs.gxt.ui.client.widget.ScrollContainer<Component>
                          com.extjs.gxt.ui.client.widget.LayoutContainer
                              com.extjs.gxt.ui.client.widget.ContentPanel

All Implemented Interfaces:

Observable, com.google.gwt.user.client.EventListener

Direct Known Subclasses:

CollapsePanel, FormPanel, Info, Portlet, Tip, Window

public class ContentPanel
extends LayoutContainer

ContentPanel is a component container that has specific functionality and structural components that make it the perfect building block for application-oriented user interfaces. The Panel contains bottom and top toolbars, along with separate header, footer and body sections. It also provides built-in expandable and collapsible behavior, along with a variety of pre-built tool buttons that can be wired up to provide other customized behavior.

Code snippet:

 ContentPanel cp = new ContentPanel();
 cp.setHeading("Folder Contents");
 cp.setSize(250,140);
 cp.setPosition(10, 10);
 cp.setCollapsible(true);
 cp.setFrame(true);
 cp.setBodyStyle("backgroundColor: white;");
 cp.getHeader().addTool(new ToolButton("x-tool-gear"));
 cp.getHeader().addTool(new ToolButton("x-tool-close"));
 cp.addText(getBogusText());
 cp.addButton(new Button("Ok"));
 cp.setIconStyle("tree-folder-open");
 RootPanel.get().add(cp);
 cp.layout();
 

Events:

BeforeExpand : ComponentEvent(component)

Fires before the panel is expanded. Listeners can set the doit field to false to cancel the expand.

• component : this

Expand : ComponentEvent(component)

Fires after the panel is expanded

• component : this

BeforeCollapse : ComponentEvent(component)

Fires before the panel is collpased. Listeners can set the doit field false to cancel the collapse.

• component : this

Collapse : ComponentEvent(component)

Fires after the panel is collapsed.

• component : this

BeforeClose : ComponentEvent(component)

Fires before a content panel is closed. Listeners can set the doit field to false to cancel the operation.

• component : this

Close : ComponentEvent(component)

Fires after a content panel is closed.

• component : this

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

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

DEBUG_ID_PREFIX

Constructor Summary

ContentPanel()
Creates a new panel instance.

ContentPanel(Layout layout)
Creates a new content panel.

Method Summary

void	addButton(Button button) Adds a button the the panel.
void	collapse() Collapses the panel body so that it becomes hidden.
void	expand() Expands the panel body so that it becomes visible.
boolean	getAnimCollapse() Returns true if animation is enabled for expand / collapse.
El	getBody() Returns the panel's body element.
boolean	getBodyBorder() Returns true if the body border is enabled.
java.lang.String	getBodyStyle() Returns the body style.
Component	getBottomComponent() Returns the panel's bottom component.
Style.HorizontalAlignment	getButtonAlign() Returns the panel's button alignment.
ButtonBar	getButtonBar() Returns the panel's button bar.
ToolButton	getCollapseBtn() Returns the panel's collapse button.
boolean	getCollapsible() Returns true if the panel is collapsible.
com.google.gwt.user.client.Element	getElement(java.lang.String name) Provides access to internal elements.
boolean	getFooter()
boolean	getFrame() Returns true if framing is enabled.
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).
int	getFrameWidth() Returns the width in pixels of the framing elements of this panel (not including the body width).
Header	getHeader() Returns the panel's header.
java.lang.String	getHeading() Returns the panel's heading.
java.lang.String	getIconStyle() Returns the panel's icon style.
int	getInnerHeight() Returns the height in pixels of the body element (not including the height of any framing elements).
int	getInnerWidth() Returns the width in pixels of the body element (not including the width of any framing elements).
El	getLayoutTarget() Override this method to specify the element to be used by the layout as the container.
boolean	getTitleCollapse()
java.lang.String	getTitleText() Deprecated. use getHeading()
Component	getTopComponent() Returns the panels top component.
boolean	isExpanded() Returns true if the panel is expanded.
boolean	isHeaderVisible() Returns true if the header is visible.
boolean	isHideCollapseTool() Returns true if the collapse tool is hidden.
void	onComponentEvent(ComponentEvent ce) Any events a component receives will be forwarded to this method.
void	setAnimCollapse(boolean animCollapse) Sets whether exand and collapse is animating (defaults to true, pre-render).
void	setBodyBorder(boolean bodyBorder) True to display the borders of the panel's body element, false to hide them (defaults to true, pre-render).
void	setBodyStyle(java.lang.String bodyStyle) Custom CSS styles to be applied to the body element in the format expected by El.applyStyles(java.lang.String) (pre-render).
void	setBodyStyleName(java.lang.String style) A style name that is added to the panel's body element (pre-render).
void	setBottomComponent(Component bottomComponent) Sets the panel's bottom component (pre-render).
void	setButtonAlign(Style.HorizontalAlignment buttonAlign) Sets the button alignment of any buttons added to this panel (defaults to RIGHT, pre-render).
void	setButtonBar(ButtonBar buttonBar)
void	setCollapsible(boolean collapsible) True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header tool button area, false to keep the panel statically sized with no button (defaults to false, pre-render).
void	setExpanded(boolean expanded) Sets the panel's expand state.
void	setFooter(boolean footer) True to create the footer element explicitly, false to skip creating it (pre-render).
void	setFrame(boolean frame) True to render the panel with custom rounded borders, false to render with plain 1px square borders (defaults to false, pre-render).
void	setHeaderVisible(boolean headerVisible) True to create the header element explicitly, false to skip creating it (defaults to true, pre-render).
void	setHeading(java.lang.String text) Sets the title text for the panel.
void	setHideCollapseTool(boolean hideCollapseTool) Sets whether the collapse tool should be displayed when the panel is collapsible.
void	setIconStyle(java.lang.String iconStyle) Sets the item's icon style.
void	setInsetBorder(boolean insetBorder) Deprecated. behavior not implemented
void	setTitleCollapse(boolean titleCollapse) True to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in the header bar, false to allow it only by clicking to tool button (defaults to false, pre-render).
void	setTopComponent(Component topComponent) Sets the panel's top component (pre-render).
com.google.gwt.user.client.ui.Frame	setUrl(java.lang.String url) Adds the content from the given url.

Methods inherited from class com.extjs.gxt.ui.client.widget.LayoutContainer

add, add, addText, findComponent, getLayout, getLayoutOnChange, insert, insert, isMonitorResize, isMonitorWindowResize, layout, remove, removeAll, setLayout, setLayoutData, setLayoutOnChange, setMonitorWindowResize

Methods inherited from class com.extjs.gxt.ui.client.widget.ScrollContainer

addScrollListener, getHScrollPosition, getScrollMode, getVScrollPosition, removeScrollListener, scrollIntoView, setHScrollPosition, setScrollMode, setVScrollPosition

Methods inherited from class com.extjs.gxt.ui.client.widget.Container

disable, enable, findItem, getItem, getItemByItemId, getItemCount, getItems, getWidget, indexOf, iterator, scrollIntoView

Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent

getBounds, getHeight, getHeight, getPosition, getShadow, getSize, getWidth, getWidth, isAutoHeight, isAutoWidth, isDeferHeight, isShim, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShim, setSize, setSize, setWidth, setWidth

Methods inherited from class com.extjs.gxt.ui.client.widget.Component

addListener, addPlugin, addStyleName, addWidgetListener, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getData, getData, getElement, getId, getItemId, getModel, getState, getToolTip, hide, hideToolTip, isDisabledEvents, isEnabled, isRendered, isVisible, onBrowserEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeWidgetListener, render, render, saveState, setBorders, setData, setData, setElement, setEnabled, setEnableState, setId, setIntStyleAttribute, setItemId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, show, sinkEvents, toString

Methods inherited from class com.google.gwt.user.client.ui.Widget

getParent, isAttached

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

addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, unsinkEvents

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ContentPanel

public ContentPanel()

Creates a new panel instance.

ContentPanel

public ContentPanel(Layout layout)

Creates a new content panel.

Parameters:

layout - the panel's layout

Method Detail

addButton

public void addButton(Button button)

Adds a button the the panel.

Parameters:

button - the button to add

collapse

public void collapse()

Collapses the panel body so that it becomes hidden. Fires the BeforeCollapse before collapsing, then the Collapse event after collapsing.

expand

public void expand()

Expands the panel body so that it becomes visible. Fires the BeforeExpand before expanding, then the Expand event after expanding.

getAnimCollapse

public boolean getAnimCollapse()

Returns true if animation is enabled for expand / collapse.

Returns:

the animCollapse true for animations

getBody

public El getBody()

Returns the panel's body element.

Returns:

the body

getBodyBorder

public boolean getBodyBorder()

Returns true if the body border is enabled.

Returns:

the body border state

getBodyStyle

public java.lang.String getBodyStyle()

Returns the body style.

Returns:

the body style

getBottomComponent

public Component getBottomComponent()

Returns the panel's bottom component.

Returns:

the bottom component

getButtonAlign

public Style.HorizontalAlignment getButtonAlign()

Returns the panel's button alignment.

Returns:

the button alignment

getButtonBar

public ButtonBar getButtonBar()

Returns the panel's button bar.

Returns:

the button bar

getCollapseBtn

public ToolButton getCollapseBtn()

Returns the panel's collapse button.

Returns:

the collapse button

getCollapsible

public boolean getCollapsible()

Returns true if the panel is collapsible.

Returns:

the collapsible state

getElement

public com.google.gwt.user.client.Element getElement(java.lang.String name)

Provides access to internal elements.

Valid values are:

• "body"
• "header"
• "bwrap"

Parameters:

name - the element name

Returns:

the element

getFooter

public boolean getFooter()

Returns:

the footer

getFrame

public boolean getFrame()

Returns true if framing is enabled.

Returns:

the frame state

getFrameHeight

public 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). To retrieve the body height see getInnerHeight().

Returns:

the frame height

getFrameWidth

public int getFrameWidth()

Returns the width in pixels of the framing elements of this panel (not including the body width). To retrieve the body width see getInnerWidth().

Returns:

The frame width

getHeader

public Header getHeader()

Returns the panel's header.

Returns:

the header

getHeading

public java.lang.String getHeading()

Returns the panel's heading.

Returns:

the heading

getIconStyle

public java.lang.String getIconStyle()

Returns the panel's icon style.

Returns:

the icon style

getInnerHeight

public int getInnerHeight()

Returns the height in pixels of the body element (not including the height of any framing elements). For the frame height see getFrameHeight().

Returns:

the inner height

getInnerWidth

public int getInnerWidth()

Returns the width in pixels of the body element (not including the width of any framing elements). For the frame width see getFrameWidth().

Returns:

the body 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 LayoutContainer

Returns:

the element to be used as the panel's container

getTitleCollapse

public boolean getTitleCollapse()

Returns:

the titleCollapse

getTitleText

public java.lang.String getTitleText()

Deprecated. use getHeading()

Returns the panel's title text.

Returns:

the title text

getTopComponent

public Component getTopComponent()

Returns the panels top component.

Returns:

the top component

isExpanded

public boolean isExpanded()

Returns true if the panel is expanded.

Returns:

the expand state

isHeaderVisible

public boolean isHeaderVisible()

Returns true if the header is visible.

Returns:

the header visible state

isHideCollapseTool

public boolean isHideCollapseTool()

Returns true if the collapse tool is hidden.

Returns:

the hide collapse tool 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 ScrollContainer<Component>

Parameters:

ce - the base event

setAnimCollapse

public void setAnimCollapse(boolean animCollapse)

Sets whether exand and collapse is animating (defaults to true, pre-render).

Parameters:

animCollapse - true to enable animations

setBodyBorder

public void setBodyBorder(boolean bodyBorder)

True to display the borders of the panel's body element, false to hide them (defaults to true, pre-render). Only applies to non-framed panels.

Parameters:

bodyBorder - true for a body border

setBodyStyle

public void setBodyStyle(java.lang.String bodyStyle)

Custom CSS styles to be applied to the body element in the format expected by El.applyStyles(java.lang.String) (pre-render).

Parameters:

bodyStyle - the body style

setBodyStyleName

public void setBodyStyleName(java.lang.String style)

A style name that is added to the panel's body element (pre-render).

Parameters:

style - the style name

setBottomComponent

public void setBottomComponent(Component bottomComponent)

Sets the panel's bottom component (pre-render). The component's natural height will be used and will not be changed by the panel.

Parameters:

bottomComponent - the bottom component

setButtonAlign

public void setButtonAlign(Style.HorizontalAlignment buttonAlign)

Sets the button alignment of any buttons added to this panel (defaults to RIGHT, pre-render).

Parameters:

buttonAlign - the button alignment

setButtonBar

public void setButtonBar(ButtonBar buttonBar)

setCollapsible

public void setCollapsible(boolean collapsible)

True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header tool button area, false to keep the panel statically sized with no button (defaults to false, pre-render).

Parameters:

collapsible - the collapsible to set

setExpanded

public void setExpanded(boolean expanded)

Sets the panel's expand state.

Parameters:

expanded - true true to expand

setFooter

public void setFooter(boolean footer)

True to create the footer element explicitly, false to skip creating it (pre-render). By default, when footer is not specified, if one or more buttons have been added to the panel the footer will be created automatically, otherwise it will not.

Parameters:

footer - the footer state

setFrame

public void setFrame(boolean frame)

True to render the panel with custom rounded borders, false to render with plain 1px square borders (defaults to false, pre-render).

Parameters:

frame - true to use the frame style

setHeaderVisible

public void setHeaderVisible(boolean headerVisible)

True to create the header element explicitly, false to skip creating it (defaults to true, pre-render). By default, when header is not specified, if a setHeading(String) is set the header will be created automatically, otherwise it will not. If a title is set but header is explicitly set to false, the header will not be rendered.

Parameters:

headerVisible - true to show the header

setHeading

public void setHeading(java.lang.String text)

Sets the title text for the panel.

Parameters:

text - the title text

setHideCollapseTool

public void setHideCollapseTool(boolean hideCollapseTool)

Sets whether the collapse tool should be displayed when the panel is collapsible.

Parameters:

hideCollapseTool - true if the tool is hidden

setIconStyle

public void setIconStyle(java.lang.String iconStyle)

Sets the item's icon style. The style name should match a CSS style that specifies a background image using the following format:

 .my-icon { background: url(images/icons/my-icon.png) no-repeat
 center left !important; } 

Parameters:

iconStyle - the icon style

setInsetBorder

public void setInsetBorder(boolean insetBorder)

Deprecated. behavior not implemented

True to display an interior border on the body element of the panel, false to hide it (defaults to true, pre-render). This only applies when setBodyBorder(boolean) == true.

Parameters:

insetBorder - true to display the interior border

setTitleCollapse

public void setTitleCollapse(boolean titleCollapse)

True to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in the header bar, false to allow it only by clicking to tool button (defaults to false, pre-render).

Parameters:

titleCollapse - the titleCollapse to set

setTopComponent

public void setTopComponent(Component topComponent)

Sets the panel's top component (pre-render).

Parameters:

topComponent - the component

setUrl

public com.google.gwt.user.client.ui.Frame setUrl(java.lang.String url)

Adds the content from the given url.

Parameters:

url - the url

Returns:

the new frame instance