com.sencha.gxt.widget.core.client

Class ContentPanel

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

com.sencha.gxt.widget.core.client.ContentPanel

All Implemented Interfaces:

HasAttachHandlers, HasResizeHandlers, HasHandlers, EventListener, AcceptsOneWidget, HasOneWidget, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, IndexedPanel, IndexedPanel.ForIsWidget, IsWidget, ProvidesResize, RequiresResize, Collapsible, HasLayout, AddEvent.HasAddHandlers, BeforeAddEvent.HasBeforeAddHandlers, BeforeCollapseEvent.HasBeforeCollapseHandlers, BeforeExpandEvent.HasBeforeExpandHandlers, BeforeHideEvent.HasBeforeHideHandlers, BeforeRemoveEvent.HasBeforeRemoveHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, CollapseEvent.HasCollapseHandlers, ContainerHandler.HasContainerHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, ExpandEvent.HasExpandHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, RemoveEvent.HasRemoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId, Iterable<Widget>

Direct Known Subclasses:

FramedPanel, Window

public class ContentPanel
extends SimpleContainer
implements BeforeExpandEvent.HasBeforeExpandHandlers, ExpandEvent.HasExpandHandlers, BeforeCollapseEvent.HasBeforeCollapseHandlers, CollapseEvent.HasCollapseHandlers, Collapsible

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ContentPanel.ContentPanelAppearance
static interface	ContentPanel.ContentPanelMessages
static interface	ContentPanel.PanelHeaderAppearance

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

HasWidgets.ForIsWidget

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

IndexedPanel.ForIsWidget

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
ContentPanel()
ContentPanel(ContentPanel.ContentPanelAppearance appearance)

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addBeforeCollapseHandler(BeforeCollapseEvent.BeforeCollapseHandler handler) Adds a BeforeCollapseEvent.BeforeCollapseHandler handler for BeforeCollapseEvent events.
HandlerRegistration	addBeforeExpandHandler(BeforeExpandEvent.BeforeExpandHandler handler) Adds a BeforeExpandEvent.BeforeExpandHandler handler for BeforeExpandEvent events.
void	addButton(CellButtonBase<?> button) Adds a button the the panel.
HandlerRegistration	addCollapseHandler(CollapseEvent.CollapseHandler handler) Adds a CollapseEvent.CollapseHandler handler for CollapseEvent events.
HandlerRegistration	addExpandHandler(ExpandEvent.ExpandHandler handler) Adds a ExpandEvent.ExpandHandler handler for ExpandEvent events.
void	addTool(Widget tool) Adds a Tool to Header
void	collapse() Collapses the panel body so that it becomes hidden.
void	expand() Expands the panel body so that it becomes visible.
XElement	getBody() Returns the panel's body element.
BoxLayoutContainer.BoxLayoutPack	getButtonAlign() Returns the panel's button alignment.
ButtonBar	getButtonBar()
Header	getHeader()
String	getHTML()
ContentPanel.ContentPanelMessages	getMessages()
int	getMinButtonWidth() Returns the minimum button width.
String	getText()
boolean	isAnimCollapse() Returns true if animated collapsing is enabled.
boolean	isCollapsed() Returns true if the panel is collapsed.
boolean	isCollapsible() Returns true if the panel is collapsible.
boolean	isExpanded() Returns true if the panel is expanded.
boolean	isHideCollapseTool() Returns true if the collapse tool is hidden.
boolean	isTitleCollapse() Returns true if title collapsing has been enabled.
void	onBrowserEvent(Event event)
void	setAnimCollapse(boolean animCollapse) Sets whether expand and collapse is animating (defaults to true).
void	setBodyBorder(boolean border)
void	setBodyStyle(String style)
void	setBodyStyleName(String style)
void	setButtonAlign(BoxLayoutContainer.BoxLayoutPack buttonAlign) Sets the button alignment of any buttons added to this panel (defaults to RIGHT, pre-render).
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	setHeaderVisible(boolean visible)
void	setHeadingHtml(SafeHtml html)
void	setHeadingHtml(String html)
void	setHeadingText(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	setMessages(ContentPanel.ContentPanelMessages messages)
void	setMinButtonWidth(int width) Sets the minimum button width.
void	setTitleCollapse(boolean titleCollapse) True to allow expanding and collapsing the panel (when setCollapsible(boolean) = true) by clicking anywhere in the header bar, false to allow it only by clicking to tool button (defaults to false).

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

add, add, getWidget, isResize, setResize, setWidget, setWidget

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, addAddHandler, addBeforeAddHandler, addBeforeRemoveHandler, addContainerHandler, addRemoveHandler, clear, 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, disable, disableEvents, enable, 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, removeHandler, 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

Constructor Detail

ContentPanel

public ContentPanel()

ContentPanel

public ContentPanel(ContentPanel.ContentPanelAppearance appearance)

Method Detail

addBeforeCollapseHandler

public HandlerRegistration addBeforeCollapseHandler(BeforeCollapseEvent.BeforeCollapseHandler handler)

Description copied from interface: BeforeCollapseEvent.HasBeforeCollapseHandlers

Adds a BeforeCollapseEvent.BeforeCollapseHandler handler for BeforeCollapseEvent events.

Specified by:

addBeforeCollapseHandler in interface BeforeCollapseEvent.HasBeforeCollapseHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

addBeforeExpandHandler

public HandlerRegistration addBeforeExpandHandler(BeforeExpandEvent.BeforeExpandHandler handler)

Description copied from interface: BeforeExpandEvent.HasBeforeExpandHandlers

Adds a BeforeExpandEvent.BeforeExpandHandler handler for BeforeExpandEvent events.

Specified by:

addBeforeExpandHandler in interface BeforeExpandEvent.HasBeforeExpandHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

addButton

@UiChild
public void addButton(CellButtonBase<?> button)

Adds a button the the panel.

Parameters:

button - the button to add

addTool

@UiChild
public void addTool(Widget tool)

Adds a Tool to Header

Parameters:

tool - the tool to add

addCollapseHandler

public HandlerRegistration addCollapseHandler(CollapseEvent.CollapseHandler handler)

Description copied from interface: CollapseEvent.HasCollapseHandlers

Adds a CollapseEvent.CollapseHandler handler for CollapseEvent events.

Specified by:

addCollapseHandler in interface CollapseEvent.HasCollapseHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

addExpandHandler

public HandlerRegistration addExpandHandler(ExpandEvent.ExpandHandler handler)

Description copied from interface: ExpandEvent.HasExpandHandlers

Adds a ExpandEvent.ExpandHandler handler for ExpandEvent events.

Specified by:

addExpandHandler in interface ExpandEvent.HasExpandHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

collapse

public void collapse()

Collapses the panel body so that it becomes hidden.

Specified by:

collapse in interface Collapsible

expand

public void expand()

Expands the panel body so that it becomes visible.

getBody

public XElement getBody()

Returns the panel's body element.

Returns:

the body

getButtonAlign

public BoxLayoutContainer.BoxLayoutPack getButtonAlign()

Returns the panel's button alignment.

Returns:

the button alignment

getButtonBar

public ButtonBar getButtonBar()

getHeader

public Header getHeader()

getHTML

public String getHTML()

getMessages

public ContentPanel.ContentPanelMessages getMessages()

getMinButtonWidth

public int getMinButtonWidth()

Returns the minimum button width.

Returns:

the minimum button width

getText

public String getText()

isAnimCollapse

public boolean isAnimCollapse()

Returns true if animated collapsing is enabled.

Returns:

true if animating

isCollapsed

public boolean isCollapsed()

Returns true if the panel is collapsed.

Returns:

the collapsed state

isCollapsible

public boolean isCollapsible()

Returns true if the panel is collapsible.

Returns:

the collapsible state

isExpanded

public boolean isExpanded()

Returns true if the panel is expanded.

Returns:

the expand state

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 collapsing has been enabled.

Returns:

true for title collapse

onBrowserEvent

public void onBrowserEvent(Event event)

Specified by:

onBrowserEvent in interface EventListener

Overrides:

onBrowserEvent in class Component

setAnimCollapse

public void setAnimCollapse(boolean animCollapse)

Sets whether expand and collapse is animating (defaults to true).

Parameters:

animCollapse - true to enable animations

setBodyBorder

public void setBodyBorder(boolean border)

setBodyStyle

public void setBodyStyle(String style)

setBodyStyleName

public void setBodyStyleName(String style)

setButtonAlign

public void setButtonAlign(BoxLayoutContainer.BoxLayoutPack buttonAlign)

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

Parameters:

buttonAlign - the button alignment

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

setHeaderVisible

public void setHeaderVisible(boolean visible)

setHeadingHtml

public void setHeadingHtml(SafeHtml html)

setHeadingHtml

public void setHeadingHtml(String html)

setHeadingText

public void setHeadingText(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

setMessages

public void setMessages(ContentPanel.ContentPanelMessages messages)

setMinButtonWidth

public void setMinButtonWidth(int width)

Sets the minimum button width.

Parameters:

width - the button width

setTitleCollapse

public void setTitleCollapse(boolean titleCollapse)

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

Parameters:

titleCollapse - the titleCollapse to set