Class WPanel
public class WPanel extends WCompositeWidget
The panel provides a container with an optional title bar, and an optional collapse icon.
Two panels: one collapsed and one expanded (default theme)
Two panels: one collapsed and one expanded (polished theme)
-
Nested Class Summary
Nested classes/interfaces inherited from class eu.webtoolkit.jwt.WObject
WObject.FormData
-
Constructor Summary
Constructors Constructor Description WPanel()
Creates a panel.WPanel(WContainerWidget parent)
Creates a panel. -
Method Summary
Modifier and Type Method Description void
collapse()
Collapses the panel.Signal
collapsed()
Signal emitted when the panel is collapsed.void
expand()
Collapses the panel.Signal
expanded()
Signal emitted when the panel is expanded.WWidget
getCentralWidget()
Returns the central widget.WString
getTitle()
Returns the title.WContainerWidget
getTitleBarWidget()
Returns the title bar widget.boolean
isCollapsed()
Returns if the panel is collapsed.boolean
isCollapsible()
Returns if the panel can be collapsed by the user.boolean
isTitleBar()
Returns if a title bar is set.void
setAnimation(WAnimation transition)
Sets an animation.void
setCentralWidget(WWidget w)
Sets the central widget.void
setCollapsed(boolean on)
Sets the panel expanded or collapsed.void
setCollapsible(boolean on)
Makes the panel collapsible.void
setTitle(java.lang.CharSequence title)
Sets a title.void
setTitleBar(boolean enable)
Shows or hides the title bar for the panel.Methods inherited from class eu.webtoolkit.jwt.WCompositeWidget
addStyleClass, boxBorder, boxPadding, callJavaScriptMember, doJavaScript, enableAjax, find, findById, getAttributeValue, getBaseZIndex, getClearSides, getDecorationStyle, getFloatSide, getHeight, getId, getImplementation, getJavaScriptMember, getLineHeight, getMargin, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumWidth, getObjectName, getOffset, getPositionScheme, getScrollVisibilityMargin, getStyleClass, getTabIndex, getTakeImplementation, getToolTip, getVerticalAlignment, getVerticalAlignmentLength, getWidth, hasFocus, hasStyleClass, isCanReceiveFocus, isDisabled, isEnabled, isHidden, isHiddenKeepsGeometry, isInline, isLoaded, isPopup, isScrollVisibilityEnabled, isScrollVisible, isSetFirstFocus, isThemeStyleEnabled, isVisible, load, propagateSetEnabled, propagateSetVisible, refresh, remove, removeStyleClass, render, resize, scrollVisibilityChanged, setAttributeValue, setCanReceiveFocus, setClearSides, setDecorationStyle, setDeferredToolTip, setDisabled, setFloatSide, setFocus, setHidden, setHiddenKeepsGeometry, setId, setImplementation, setInline, setJavaScriptMember, setLineHeight, setMargin, setMaximumSize, setMinimumSize, setObjectName, setOffsets, setPopup, setPositionScheme, setScrollVisibilityEnabled, setScrollVisibilityMargin, setSelectable, setStyleClass, setTabIndex, setThemeStyleEnabled, setToolTip, setVerticalAlignment
Methods inherited from class eu.webtoolkit.jwt.WWidget
acceptDrops, acceptDrops, addCssRule, addCssRule, addJSignal, addStyleClass, animateHide, animateShow, createJavaScript, disable, dropEvent, enable, getDropTouch, getJsRef, getParent, hide, htmlText, isExposed, isLayoutSizeAware, isRendered, layoutSizeChanged, needsRerender, positionAt, positionAt, removeChild, removeStyleClass, render, resize, scheduleRender, scheduleRender, scheduleRender, setClearSides, setDeferredToolTip, setFocus, setHeight, setHidden, setLayoutSizeAware, setMargin, setMargin, setMargin, setMargin, setMargin, setOffsets, setOffsets, setOffsets, setOffsets, setOffsets, setToolTip, setVerticalAlignment, setWidth, show, stopAcceptDrops, toggleStyleClass, toggleStyleClass, tr
Methods inherited from class eu.webtoolkit.jwt.WObject
addChild, setFormData
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
WPanel
Creates a panel. -
WPanel
public WPanel()Creates a panel.
-
-
Method Details
-
setTitle
public void setTitle(java.lang.CharSequence title)Sets a title.The panel title is set in the title bar. This method also makes the title bar visible by calling setTitleBar(true).
The default value is "" (no title).
- See Also:
getTitle()
,setTitleBar(boolean enable)
-
getTitle
Returns the title.- See Also:
setTitle(CharSequence title)
-
setTitleBar
public void setTitleBar(boolean enable)Shows or hides the title bar for the panel.The title bar appears at the top of the panel.
The default value is
false:
the title bar is not shown unless a title is set or the panel is made collapsible. -
isTitleBar
public boolean isTitleBar()Returns if a title bar is set.- See Also:
setTitleBar(boolean enable)
-
getTitleBarWidget
Returns the title bar widget.The title bar widget contains the collapse/expand icon (if the panel
isCollapsible()
), and the title text (if a title was set usingsetTitle()
). You can access the title bar widget to customize the contents of the title.The method returns
null
ifisTitleBar()
isfalse
. You need to callsetTitleBar()
first.- See Also:
setTitleBar(boolean enable)
-
setCollapsible
public void setCollapsible(boolean on)Makes the panel collapsible.When
on
istrue
, a collapse/expand icon is added to the title bar. This also calls setTitleBar(true) to enable the title bar.The default value is
false
. -
isCollapsible
public boolean isCollapsible()Returns if the panel can be collapsed by the user.- See Also:
setCollapsible(boolean on)
-
setCollapsed
public void setCollapsed(boolean on)Sets the panel expanded or collapsed.When
on
istrue
, equivalent tocollapse()
, otherwise toexpand()
.The default value is
false
.- See Also:
setCollapsible(boolean on)
-
isCollapsed
public boolean isCollapsed()Returns if the panel is collapsed.- See Also:
setCollapsed(boolean on)
,collapsed()
,expanded()
-
collapse
public void collapse()Collapses the panel.When
isCollapsible()
is true, the panel is collapsed to minimize screen real-estate.- See Also:
setCollapsible(boolean on)
,expand()
-
expand
public void expand()Collapses the panel.When
isCollapsible()
is true, the panel is expanded to its original state.- See Also:
setCollapsible(boolean on)
,expand()
-
setAnimation
Sets an animation.The animation is used when collapsing or expanding the panel.
-
setCentralWidget
Sets the central widget.Sets the widget that is the contents of the panel. When a widget was previously set, the old widget is deleted first.
The default value is
null
(no widget set). -
getCentralWidget
Returns the central widget.- See Also:
setCentralWidget(WWidget w)
-
collapsed
Signal emitted when the panel is collapsed.Signal emitted when the panel is collapsed. The signal is only emitted when the panel is collapsed by the user using the collapse icon in the tible bar, not when calling
setCollapsed()
.- See Also:
expanded()
-
expanded
Signal emitted when the panel is expanded.Signal emitted when the panel is expanded. The signal is only emitted when the panel is expanded by the user using the expand icon in the title bar, not when calling
setCollapsed()
.- See Also:
collapsed()
-