public class ContentPanel extends SimpleContainer implements BeforeExpandEvent.HasBeforeExpandHandlers, ExpandEvent.HasExpandHandlers, BeforeCollapseEvent.HasBeforeCollapseHandlers, CollapseEvent.HasCollapseHandlers, Collapsible
addButton(Widget)
. The body contains a single widget,
added using SimpleContainer.add(com.google.gwt.user.client.ui.Widget)
. The widget is resized to match the size of the container. A content panel provides built-in
expandable and collapsible behavior.
Code snippet:
public void onModuleLoad() { ContentPanel cp = new ContentPanel(); cp.setHeadingText("Content Panel"); cp.setPixelSize(250, 140); cp.setPosition(10, 10); cp.setCollapsible(true); cp.addTool(new ToolButton(ToolButton.GEAR)); cp.addTool(new ToolButton(ToolButton.CLOSE)); cp.setWidget(new HTML("This is an HTML Widget in a ContentPanel.")); cp.addButton(new TextButton("Ok")); RootPanel.get().add(cp); }
Modifier and Type | Class and Description |
---|---|
static interface |
ContentPanel.ContentPanelAppearance
The appearance of a content panel.
|
static interface |
ContentPanel.ContentPanelMessages
Provides access to content panel messages.
|
static interface |
ContentPanel.PanelHeaderAppearance
Provides support for deferred binding for the panel header appearance.
|
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
HasWidgets.ForIsWidget
IndexedPanel.ForIsWidget
DEBUG_ID_PREFIX
Constructor and Description |
---|
ContentPanel()
Creates a content panel with default appearance.
|
ContentPanel(ContentPanel.ContentPanelAppearance appearance)
Creates a content panel with the specified appearance.
|
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(Widget widget)
Adds a widget the the button bar.
|
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 widget.
|
void |
expand()
Expands the widget.
|
void |
forceLayout()
Forces a class that implements
HasLayout to lay out its child
widgets. |
int |
getAnimationDuration()
Gets the duration for the expand/collapse animations
|
ContentPanel.ContentPanelAppearance |
getAppearance()
Gets a reference to the appearance this object was instantiated with
|
XElement |
getBody()
Returns the panel's body element.
|
BoxLayoutContainer.BoxLayoutPack |
getButtonAlign()
Returns the panel's button alignment.
|
ButtonBar |
getButtonBar()
Returns the content panel button bar.
|
Header |
getHeader()
Returns the content panel header.
|
String |
getHTML()
Returns the HTML displayed in the header.
|
ContentPanel.ContentPanelMessages |
getMessages()
Returns the content panel messages.
|
int |
getMinButtonWidth()
Returns the minimum button width.
|
String |
getText()
Returns the content panel header text set by a previous call to
setHeadingText(String) . |
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 widget 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 |
setAnimationDuration(int animationDuration)
Sets the duration for the expand/collapse animations.
|
void |
setAnimCollapse(boolean animCollapse)
Sets whether expand and collapse is animating (defaults to true).
|
void |
setBodyBorder(boolean border)
Displays or hides the body border.
|
void |
setBodyStyle(String style)
Sets multiple style properties on the body element.
|
void |
setBodyStyleName(String style)
Adds a style class name to the body element.
|
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 (defaults to false, pre-render).
|
void |
setExpanded(boolean expanded)
Sets the panel's expand state.
|
void |
setHeaderVisible(boolean visible)
Shows or hides the content panel header.
|
void |
setHeadingHtml(SafeHtml html)
Sets the heading.
|
void |
setHeadingHtml(String html)
Sets the heading.
|
void |
setHeadingText(String text)
Sets the heading.
|
void |
setHideCollapseTool(boolean hideCollapseTool)
Sets whether the collapse tool should be displayed (when
setCollapsible(boolean) = true) (defaults to false, pre-render). |
void |
setMessages(ContentPanel.ContentPanelMessages messages)
Sets the content panel 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). |
add, add, getWidget, isResize, setResize, setWidget, setWidget
isLayoutRunning, isOrWasLayoutRunning, onResize
add, addAddHandler, addBeforeAddHandler, addBeforeRemoveHandler, addContainerHandler, addRemoveHandler, clear, disable, enable, findWidget, getItemByItemId, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, iterator, remove, remove, remove
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, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString
public ContentPanel()
public ContentPanel(ContentPanel.ContentPanelAppearance appearance)
appearance
- the appearance of the content panel.public HandlerRegistration addBeforeCollapseHandler(BeforeCollapseEvent.BeforeCollapseHandler handler)
BeforeCollapseEvent.HasBeforeCollapseHandlers
BeforeCollapseEvent.BeforeCollapseHandler
handler for BeforeCollapseEvent
events.addBeforeCollapseHandler
in interface BeforeCollapseEvent.HasBeforeCollapseHandlers
handler
- the handlerpublic HandlerRegistration addBeforeExpandHandler(BeforeExpandEvent.BeforeExpandHandler handler)
BeforeExpandEvent.HasBeforeExpandHandlers
BeforeExpandEvent.BeforeExpandHandler
handler for BeforeExpandEvent
events.addBeforeExpandHandler
in interface BeforeExpandEvent.HasBeforeExpandHandlers
handler
- the handler@UiChild public void addButton(Widget widget)
widget
- the widget to addpublic HandlerRegistration addCollapseHandler(CollapseEvent.CollapseHandler handler)
CollapseEvent.HasCollapseHandlers
CollapseEvent.CollapseHandler
handler for CollapseEvent
events.addCollapseHandler
in interface CollapseEvent.HasCollapseHandlers
handler
- the handlerpublic HandlerRegistration addExpandHandler(ExpandEvent.ExpandHandler handler)
ExpandEvent.HasExpandHandlers
ExpandEvent.ExpandHandler
handler for ExpandEvent
events.addExpandHandler
in interface ExpandEvent.HasExpandHandlers
handler
- the handler@UiChild public void addTool(Widget tool)
tool
- the tool to addpublic void collapse()
Collapsible
collapse
in interface Collapsible
public void expand()
Collapsible
expand
in interface Collapsible
public void forceLayout()
HasLayout
HasLayout
to lay out its child
widgets.forceLayout
in interface HasLayout
forceLayout
in class ResizeContainer
public int getAnimationDuration()
public void setAnimationDuration(int animationDuration)
animationDuration
- the duration of the expand/collapse animations in millisecondspublic ContentPanel.ContentPanelAppearance getAppearance()
public XElement getBody()
public BoxLayoutContainer.BoxLayoutPack getButtonAlign()
public void setButtonAlign(BoxLayoutContainer.BoxLayoutPack buttonAlign)
buttonAlign
- the button alignmentpublic ButtonBar getButtonBar()
public Header getHeader()
public String getHTML()
public ContentPanel.ContentPanelMessages getMessages()
public void setMessages(ContentPanel.ContentPanelMessages messages)
messages
- the messagespublic int getMinButtonWidth()
public void setMinButtonWidth(int width)
width
- the button widthpublic String getText()
setHeadingText(String)
.public boolean isAnimCollapse()
public void setAnimCollapse(boolean animCollapse)
animCollapse
- true to enable animationspublic boolean isCollapsed()
public boolean isCollapsible()
public void setCollapsible(boolean collapsible)
collapsible
- the collapsible statepublic boolean isExpanded()
Collapsible
isExpanded
in interface Collapsible
public void setExpanded(boolean expanded)
expanded
- true true to expand
public boolean isHideCollapseTool()
public void setHideCollapseTool(boolean hideCollapseTool)
setCollapsible(boolean)
= true) (defaults to false, pre-render).hideCollapseTool
- true if the tool is hiddenpublic boolean isTitleCollapse()
public void setTitleCollapse(boolean titleCollapse)
setCollapsible(boolean)
= true) by clicking
anywhere in the header bar, false to allow it only by clicking to tool button (defaults to false).titleCollapse
- the titleCollapse to setpublic void onBrowserEvent(Event event)
onBrowserEvent
in interface EventListener
onBrowserEvent
in class Component
public void setBodyBorder(boolean border)
border
- true to display the borderpublic void setBodyStyle(String style)
style
- the style(s) to setpublic void setBodyStyleName(String style)
style
- the style class namepublic void setHeaderVisible(boolean visible)
visible
- true to show the header.public void setHeadingHtml(SafeHtml html)
html
- the heading as HTMLpublic void setHeadingHtml(String html)
html
- the heading as HTMLpublic void setHeadingText(String text)
text
- the heading textCopyright © 2015. All rights reserved.