Class WPushButton
public class WPushButton extends WFormWidget
To act on a button click, connect a slot to the WInteractWidget.clicked()
signal.
WPushButton is an inline
widget.
CSS
The widget corresponds to the HTML <button>
tag (with some exceptions in
the bootstrap theme).
-
Nested Class Summary
Nested classes/interfaces inherited from class eu.webtoolkit.jwt.WObject
WObject.FormData
-
Field Summary
Fields inherited from class eu.webtoolkit.jwt.WInteractWidget
dragTouchEndSlot_, dragTouchSlot_
-
Constructor Summary
Constructors Constructor Description WPushButton()
Creates a push button.WPushButton(WContainerWidget parent)
Creates a push button.WPushButton(java.lang.CharSequence text)
Creates a push button with given label text.WPushButton(java.lang.CharSequence text, TextFormat format)
Creates a push button with given label text.WPushButton(java.lang.CharSequence text, TextFormat format, WContainerWidget parent)
Creates a push button with given label text.WPushButton(java.lang.CharSequence text, WContainerWidget parent)
Creates a push button with given label text. -
Method Summary
Modifier and Type Method Description EventSignal
checked()
Signal emitted when the button gets checked.protected void
enableAjax()
Progresses to an Ajax-enabled widget.protected void
getDomChanges(java.util.List<DomElement> result, WApplication app)
Get DOM changes for this widget.WLink
getIcon()
Returns the icon.WLink
getLink()
Returns the destination link.AnchorTarget
getLinkTarget()
Returns the location where the linked content should be displayed.WPopupMenu
getMenu()
Returns an associated popup menu.java.lang.String
getRef()
Deprecated.WResource
getResource()
Deprecated.UsegetLink()
instead.WString
getText()
Returns the button text.TextFormat
getTextFormat()
Returns the text format.java.lang.String
getValueText()
Returns the current value.boolean
isCheckable()
Returns whether a button is checkable.boolean
isChecked()
Returns the button state.boolean
isDefault()
Returns whether the button is a default button.boolean
isSetFirstFocus()
Set focus on the widget's first descendant.protected void
propagateSetEnabled(boolean enabled)
Propagates that a widget was enabled or disabled through children.void
refresh()
Refresh the widget.void
remove()
Destructor.void
setCheckable(boolean checkable)
Sets whether the button is checkable.void
setChecked()
Checks the button.void
setChecked(boolean checked)
Sets the button state.void
setDefault(boolean enabled)
Sets the default property.void
setIcon(WLink link)
Sets an icon.void
setLink(WLink link)
Sets a destination link.void
setLinkTarget(AnchorTarget target)
Sets the link target.void
setMenu(WPopupMenu popupMenu)
Links a popup menu to the button.void
setRef(java.lang.String url)
Deprecated.UsesetLink()
insteadd.void
setResource(WResource resource)
Deprecated.UsesetLink()
instead.boolean
setText(java.lang.CharSequence text)
Sets the button text.boolean
setTextFormat(TextFormat textFormat)
Sets the text format.void
setUnChecked()
Unchecks the button.void
setValueText(java.lang.String value)
Sets the current value.EventSignal
unChecked()
Signal emitted when the button gets unchecked.Methods inherited from class eu.webtoolkit.jwt.WFormWidget
changed, getEmptyText, getLabel, getPlaceholderText, getTabIndex, getValidator, isCanReceiveFocus, isReadOnly, render, selected, setEmptyText, setEnabled, setHidden, setPlaceholderText, setReadOnly, setToolTip, setValidator, validate, validated
Methods inherited from class eu.webtoolkit.jwt.WInteractWidget
clicked, doubleClicked, enterPressed, escapePressed, gestureChanged, gestureEnded, gestureStarted, getMouseOverDelay, isEnabled, keyPressed, keyWentDown, keyWentUp, load, mouseDragged, mouseMoved, mouseWentDown, mouseWentOut, mouseWentOver, mouseWentUp, mouseWheel, setDraggable, setDraggable, setDraggable, setDraggable, setMouseOverDelay, setPopup, touchEnded, touchMoved, touchStarted, unsetDraggable
Methods inherited from class eu.webtoolkit.jwt.WWebWidget
addStyleClass, blurred, callJavaScriptMember, childrenChanged, createDomElement, doJavaScript, escapeText, escapeText, escapeText, escapeText, find, findById, focussed, getAttributeValue, getBaseZIndex, getChildren, getClearSides, getDecorationStyle, getFloatSide, getHeight, getHtmlTagName, getId, getJavaScriptMember, getLineHeight, getMargin, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumWidth, getOffset, getPositionScheme, getScrollVisibilityMargin, getStyleClass, getToolTip, getVerticalAlignment, getVerticalAlignmentLength, getWidth, hasFocus, hasStyleClass, isDisabled, isHidden, isHiddenKeepsGeometry, isInline, isLoaded, isPopup, isRendered, isScrollVisibilityEnabled, isScrollVisible, isThemeStyleEnabled, isVisible, jsStringLiteral, jsStringLiteral, parentResized, parentResized, propagateSetVisible, removeScript, removeStyleClass, resize, scrollVisibilityChanged, setAttributeValue, setBaseZIndex, setCanReceiveFocus, setClearSides, setDecorationStyle, setDeferredToolTip, setDisabled, setFloatSide, setFocus, setHiddenKeepsGeometry, setHtmlTagName, setId, setInline, setJavaScriptMember, setLineHeight, setLoadLaterWhenInvisible, setMargin, setMaximumSize, setMinimumSize, setOffsets, setPositionScheme, setScrollVisibilityEnabled, setScrollVisibilityMargin, setSelectable, setStyleClass, setTabIndex, setThemeStyleEnabled, setVerticalAlignment, updateSignalConnection, voidEventSignal
Methods inherited from class eu.webtoolkit.jwt.WWidget
acceptDrops, acceptDrops, addCssRule, addCssRule, addJSignal, addStyleClass, animateHide, animateShow, boxBorder, boxPadding, createJavaScript, disable, dropEvent, enable, getDropTouch, getJsRef, getParent, hide, htmlText, isExposed, isLayoutSizeAware, layoutSizeChanged, needsRerender, positionAt, positionAt, removeChild, removeStyleClass, render, resize, scheduleRender, scheduleRender, scheduleRender, setClearSides, setDeferredToolTip, setFocus, setHeight, setHidden, setLayoutSizeAware, setMargin, setMargin, setMargin, setMargin, setMargin, setObjectName, setOffsets, setOffsets, setOffsets, setOffsets, setOffsets, setToolTip, setVerticalAlignment, setWidth, show, stopAcceptDrops, toggleStyleClass, toggleStyleClass, tr
Methods inherited from class eu.webtoolkit.jwt.WObject
addChild, getObjectName, setFormData
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
WPushButton
Creates a push button. -
WPushButton
public WPushButton()Creates a push button. -
WPushButton
Creates a push button with given label text.The default text format is PlainText.
-
WPushButton
public WPushButton(java.lang.CharSequence text)Creates a push button with given label text. -
WPushButton
Creates a push button with given label text. -
WPushButton
Creates a push button with given label text.
-
-
Method Details
-
remove
public void remove()Description copied from class:WFormWidget
Destructor.If a label was associated with the widget, its buddy is reset to
null
.- Overrides:
remove
in classWFormWidget
- See Also:
WContainerWidget.removeWidget(WWidget widget)
-
setDefault
public void setDefault(boolean enabled)Sets the default property.This has only a functional meaning for a button in a dialog footer, as it becomes associated with pressing 'enter' in the dialog.
A default button may be rendered in a different style, depending on the theme.
-
isDefault
public boolean isDefault()Returns whether the button is a default button.- See Also:
setDefault(boolean enabled)
-
setCheckable
public void setCheckable(boolean checkable)Sets whether the button is checkable.A checkable button can be checked and unchecked, and clicking will toggle between these two states.
- See Also:
setChecked(boolean checked)
-
isCheckable
public boolean isCheckable()Returns whether a button is checkable.- See Also:
setCheckable(boolean checkable)
-
setChecked
public void setChecked(boolean checked)Sets the button state.This is ignored for a button which is not checkable.
This method does not emit one of the
checked()
orunChecked()
signals. -
setChecked
public void setChecked()Checks the button.Does not emit the
checked()
signal.- See Also:
setChecked(boolean checked)
-
setUnChecked
public void setUnChecked()Unchecks the button.Does not emit the
unChecked()
signal.- See Also:
setChecked(boolean checked)
-
isChecked
public boolean isChecked()Returns the button state.- See Also:
setChecked()
-
setText
public boolean setText(java.lang.CharSequence text)Sets the button text.The default text format is
TextFormat.PlainText
.When the current text format is
TextFormat.XHTMLText
, andtext
is literal (not created usingWString#tr()
), it is parsed using an XML parser which discards malicious tags and attributes silently. When the parser encounters an XML parse error, the textFormat is changed toTextFormat.PlainText
.Returns whether the text could be set using the current textFormat. A return value of
false
indicates that the text format was changed in order to be able to accept the new text.- See Also:
setTextFormat(TextFormat textFormat)
-
getText
Returns the button text.- See Also:
setText(CharSequence text)
-
setTextFormat
Sets the text format.The textFormat controls how the string should be interpreted: either as plain text, which is displayed literally, or as XHTML-markup.
When changing the textFormat to
TextFormat.XHTMLText
, and the current text is literal (not created usingWString#tr()
), the current text is parsed using an XML parser which discards malicious tags and attributes silently. When the parser encounters an XML parse error, the textFormat is left unchanged, and this method returns false.Returns whether the textFormat could be set for the current text.
The default format is
TextFormat.PlainText
. -
getTextFormat
Returns the text format.- See Also:
setTextFormat(TextFormat textFormat)
-
setIcon
Sets an icon.The icon is placed to the left of the text.
-
getIcon
Returns the icon.- See Also:
setIcon(WLink link)
-
setLink
Sets a destination link.This method can be used to make the button behave like a
WAnchor
(or conversely, an anchor look like a button) and redirect to another URL when clicked.The
link
may be to a URL, a resource, or an internal path.By default, a button does not link to an URL and you should listen to the
WInteractWidget.clicked()
signal to react to a click event.Warning: In Bootstrap theme, you should set a link before it's rendered since it commit's the button to be rendered as an anchor. (see also http://redmine.emweb.be/issues/1802).
-
getLink
Returns the destination link.- See Also:
setLink(WLink link)
-
setRef
public void setRef(java.lang.String url)Deprecated.UsesetLink()
insteadd.Sets a destination URL (deprecated). -
getRef
public java.lang.String getRef()Deprecated.UsegetLink()
instead.Returns the destination URL (deprecated).When the button refers to a resource, the current resource URL is returned. Otherwise, the URL is returned that was set using
setRef()
.- See Also:
setRef(String url)
,WResource.getUrl()
-
setResource
Deprecated.UsesetLink()
instead.Sets a destination resource (deprecated).This method can be used to make the button behave like a
WAnchor
(or conversely, an anchor look like a button) and redirect to another resource when clicked.A resource specifies application-dependent content, which may be generated by your application on demand.
This sets the
resource
as the destination of the button, and is an alternative tosetRef()
. The resource may be cleared by passingresource
=null
.The button does not assume ownership of the resource.
- See Also:
setRef(String url)
-
getResource
Deprecated.UsegetLink()
instead.Returns the destination resource (deprecated).Returns
null
if no resource has been set.- See Also:
setResource(WResource resource)
-
getValueText
public java.lang.String getValueText()Returns the current value.Returns an empty string, since a button has no value.
- Specified by:
getValueText
in classWFormWidget
-
setValueText
public void setValueText(java.lang.String value)Sets the current value.Has no effect, since a button has not value.
- Specified by:
setValueText
in classWFormWidget
-
setLinkTarget
Sets the link target.This sets the target where the linked contents should be displayed. The default target is TargetSelf.
-
getLinkTarget
Returns the location where the linked content should be displayed.- See Also:
setLinkTarget(AnchorTarget target)
-
setMenu
Links a popup menu to the button.When the button is clicked, the linked popup menu is shown.
-
getMenu
Returns an associated popup menu.- See Also:
setMenu(WPopupMenu popupMenu)
-
refresh
public void refresh()Description copied from class:WWidget
Refresh the widget.The refresh method is invoked when the locale is changed using
WApplication#setLocale()
or when the user hit the refresh button.The widget must actualize its contents in response.
Note: This does *not* rerender the widget! Calling
refresh()
usually does not have any effect (unless you've reimplementedrefresh()
to attach to it an effect).- Overrides:
refresh
in classWFormWidget
-
checked
Signal emitted when the button gets checked.This signal is emitted when the user checks the button.
You can use the
WInteractWidget.clicked()
signal to react to any change of the button state.- See Also:
setCheckable(boolean checkable)
-
unChecked
Signal emitted when the button gets unchecked.This signal is emitted when the user unchecks the button.
You can use the
WInteractWidget.clicked()
signal to react to any change of the button state.- See Also:
setCheckable(boolean checkable)
-
isSetFirstFocus
public boolean isSetFirstFocus()Description copied from class:WWidget
Set focus on the widget's first descendant.Set focus on the widget itself, or on a first descendant which can receive focus.
Returns whether focus could be set.
- Overrides:
isSetFirstFocus
in classWWebWidget
-
getDomChanges
Description copied from class:WWebWidget
Get DOM changes for this widget.This is an internal function, and should not be called directly, or be overridden!
- Overrides:
getDomChanges
in classWWebWidget
-
propagateSetEnabled
protected void propagateSetEnabled(boolean enabled)Description copied from class:WWidget
Propagates that a widget was enabled or disabled through children.When enabling or disabling a widget, you usually also want to disable contained children. This method is called by
setDisabled()
to propagate its state to all children.You may want to reimplement this method if they wish to render differently when a widget is disabled. The default implementation will propagate the signal to all children.
- Overrides:
propagateSetEnabled
in classWFormWidget
-
enableAjax
protected void enableAjax()Description copied from class:WWidget
Progresses to an Ajax-enabled widget.This method is called when the progressive bootstrap method is used, and support for AJAX has been detected. The default behavior will upgrade the widget's event handling to use AJAX instead of full page reloads, and propagate the call to its children.
You may want to reimplement this method if you want to make changes to widget when AJAX is enabled. You should always call the base implementation.
- Overrides:
enableAjax
in classWFormWidget
- See Also:
WApplication.enableAjax()
-
getLink()
instead.