Package eu.webtoolkit.jwt

Class WToolBar

java.lang.Object

eu.webtoolkit.jwt.WObject

eu.webtoolkit.jwt.WWidget

eu.webtoolkit.jwt.WCompositeWidget

eu.webtoolkit.jwt.WToolBar

public class WToolBar
extends WCompositeWidget

A toolbar.

By default, a toolbar is rendered as "compact" leaving no margin between buttons. By adding a separator or a split button, the toolbar also supports separation between buttons.

Nested Class Summary

Nested classes/interfaces inherited from class eu.webtoolkit.jwt.WObject

WObject.FormData

Field Summary

Fields inherited from class eu.webtoolkit.jwt.WWidget

WT_GETEXTRAMS_JS

Constructor Summary

Constructors

Constructor	Description
WToolBar()	Constructor.
WToolBar(WContainerWidget parentContainer)	Constructor.

Method Summary

Modifier and Type	Method	Description
WPushButton	addButton(WPushButton button)	Adds a button.
WPushButton	addButton(WPushButton button, AlignmentFlag alignmentFlag)	Adds a button.
WSplitButton	addButton(WSplitButton button)	Adds a split button.
WSplitButton	addButton(WSplitButton button, AlignmentFlag alignmentFlag)	Adds a split button.
void	addSeparator()	Adds a separator.
void	addWidget(WWidget widget)	Adds a widget.
void	addWidget(WWidget widget, AlignmentFlag alignmentFlag)	Adds a widget.
int	getCount()	Returns the number of widgets.
boolean	isCompact()	Returns whether the toolbar was rendered compact.
WWidget	removeWidget(WWidget widget)	Removes a child widget.
protected void	render(java.util.EnumSet<RenderFlag> flags)	Renders the widget.
void	setCompact(boolean compact)	Sets the toolbar to be rendered compact.
void	setOrientation(Orientation orientation)	Set vertical or horizontal orientation.
WWidget	widget(int index)	Returns a button.

Methods inherited from class eu.webtoolkit.jwt.WCompositeWidget

addStyleClass, boxBorder, boxPadding, callJavaScriptMember, doJavaScript, enableAjax, find, findById, getAttributeValue, getBaseZIndex, getChildren, 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, resize, scrollVisibilityChanged, setAttributeValue, setCanReceiveFocus, setClearSides, setDecorationStyle, setDeferredToolTip, setDisabled, setFloatSide, setFocus, setHidden, setHiddenKeepsGeometry, setId, setImplementation, setInline, setJavaScriptMember, setLineHeight, setMargin, setMaximumSize, setMinimumSize, setObjectName, setOffsets, setParentWidget, 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, applyThemeStyles, createJavaScript, disable, dropEvent, enable, getDropTouch, getJsRef, getParent, hide, htmlText, isExposed, isGlobalWidget, isLayoutSizeAware, isRendered, layoutSizeChanged, needsRerender, positionAt, positionAt, positionAt, positionAt, removeFromParent, removeStyleClass, render, resize, scheduleRender, scheduleRender, scheduleRender, scheduleThemeStyleApply, 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

setFormData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WToolBar

public WToolBar(WContainerWidget parentContainer)

Constructor.

WToolBar

public WToolBar()

Constructor.

Calls this((WContainerWidget)null)

Method Detail

setOrientation

public void setOrientation(Orientation orientation)

Set vertical or horizontal orientation.

Use bootstrap btn-group-vertical style for vertical orientation.

addButton

public WPushButton addButton(WPushButton button,
                             AlignmentFlag alignmentFlag)

Adds a button.

addButton

public final WPushButton addButton(WPushButton button)

Adds a button.

Returns addButton(button, AlignmentFlag.Left)

addButton

public WSplitButton addButton(WSplitButton button,
                              AlignmentFlag alignmentFlag)

Adds a split button.

When adding a split button, the toolbar automatically becomes non-compact, since otherwise the split button functionality cannot be distinguished from other buttons.

See Also:

setCompact(boolean compact)

addButton

public final WSplitButton addButton(WSplitButton button)

Adds a split button.

Returns addButton(button, AlignmentFlag.Left)

addWidget

public void addWidget(WWidget widget,
                      AlignmentFlag alignmentFlag)

Adds a widget.

The toolbar automatically becomes non-compact.

addWidget

public final void addWidget(WWidget widget)

Adds a widget.

Calls addWidget(widget, AlignmentFlag.Left)

removeWidget

public WWidget removeWidget(WWidget widget)

Description copied from class: WWidget

Removes a child widget.

Overrides:

removeWidget in class WCompositeWidget

addSeparator

public void addSeparator()

Adds a separator.

The toolbar automatically becomes non-compact.

See Also:

setCompact(boolean compact)

getCount

public int getCount()

Returns the number of widgets.

The counted widgets are either a WPushButton or WSplitButton added by addButton() or a widget added by addWidget().

See Also:

widget(int index)

widget

public WWidget widget(int index)

Returns a button.

The returned widget is a WPushButton or WSplitButton added by addButton() or a widget added by addWidget().

setCompact

public void setCompact(boolean compact)

Sets the toolbar to be rendered compact.

The default value is true, but setCompact(true) is called automatically when calling addButton(WSplitButton *) or addSeparator().

isCompact

public boolean isCompact()

Returns whether the toolbar was rendered compact.

See Also:

setCompact(boolean compact)

render

protected void render(java.util.EnumSet<RenderFlag> flags)

Description copied from class: WWidget

Renders the widget.

This function renders the widget (or an update for the widget), after this has been scheduled using scheduleRender().

The default implementation will render the widget by serializing changes to JavaScript and HTML. You may want to reimplement this widget if you have been postponing some of the layout / rendering implementation until the latest moment possible. In that case you should make sure you call the base implementation however.

Overrides:

render in class WCompositeWidget