Package com.github.bordertech.wcomponents

Class WCancelButton

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.WBeanComponent

com.github.bordertech.wcomponents.WButton

com.github.bordertech.wcomponents.WCancelButton

All Implemented Interfaces:

AccessKeyable, AjaxTarget, AjaxTrigger, BeanAware, BeanBound, BeanProviderBound, Container, DataBound, DialogOpenTrigger, Disableable, SubordinateTarget, WComponent, WebComponent, Serializable

public class WCancelButton
extends WButton

This component is a specialised version of a WButton that provides additional client-side functionality commonly associated with a "cancel" button.

Themes will typically display a confirmation prompt if there any "unsaved changes" when the button is clicked. The following are considered as unsaved changes:

• Any data which has been entered on the client and has not been sent to the server.
• Programmatically calling setUnsavedChanges(uic, true) on the cancel button.
• Programmatically calling setUnsavedChanges(uic, true) on the root WApplication.

Since:

1.0.0

Author:

Adam Millard

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.github.bordertech.wcomponents.WButton

WButton.ButtonModel, WButton.ImagePosition

Nested classes/interfaces inherited from class com.github.bordertech.wcomponents.AbstractWComponent

AbstractWComponent.WComponentRef

Field Summary

Fields inherited from class com.github.bordertech.wcomponents.WButton

NO_VALUE

Fields inherited from interface com.github.bordertech.wcomponents.WComponent

DEFAULT_APPLICATION_ID, DEFAULT_INTERNAL_ID, DEFAULT_NO_ID, ID_CONTEXT_SEPERATOR, ID_FRAMEWORK_ASSIGNED_SEPERATOR, ID_VALIDATION_PATTERN

Constructor Summary

Constructors

Constructor	Description
WCancelButton()	Creates a WCancelButton with the default text.
WCancelButton(String text)	Creates a WCancelButton with the specified text.
WCancelButton(String text, char accessKey)	Creates a WCancelButton with the specified text and access key.

Method Summary

Methods inherited from class com.github.bordertech.wcomponents.WButton

afterActionExecute, beforeActionExecute, clearPressed, focusMe, getAccessKey, getAction, getActionCommand, getActionObject, getAjaxTarget, getChildAt, getChildCount, getChildren, getComponentModel, getImage, getImageHolder, getImagePosition, getImageUrl, getIndexOfChild, getMessage, getOrCreateComponentModel, getText, getValue, handleRequest, isAjax, isCancel, isClientCommandOnly, isDisabled, isPopupTrigger, isPressed, isRenderAsLink, isUnsavedChanges, newComponentModel, preparePaintComponent, setAccessKey, setAction, setActionCommand, setActionObject, setAjaxTarget, setCancel, setClientCommandOnly, setDisabled, setImage, setImage, setImagePosition, setImageUrl, setMessage, setPopupTrigger, setPressed, setRenderAsLink, setText, setUnsavedChanges, setValue, toString

Methods inherited from class com.github.bordertech.wcomponents.WBeanComponent

addBeanToScratchMap, doUpdateBeanValue, getBean, getBeanFromScratchMap, getBeanId, getBeanProperty, getBeanProvider, getBeanScratchMap, getBeanValue, getData, isBeanInScratchMap, isChanged, isSearchAncestors, isUseRequestScopeScratchMap, removeBeanFromScratchMap, resetData, setBean, setBeanId, setBeanProperty, setBeanProvider, setData, setSearchAncestors, updateBeanValue

Methods inherited from class com.github.bordertech.wcomponents.AbstractWComponent

addHtmlClass, addHtmlClass, addNotify, afterPaint, assertAddSupported, beforePaint, createErrorDiagnostic, createErrorDiagnostic, forward, getAccessibleText, getAttribute, getBaseUrl, getDefaultModel, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getParent, getScratchMap, getTabIndex, getTag, getTemplate, getTemplateMarkUp, getToolTip, hasNoComponentModel, hasTabIndex, initialiseComponentModel, invokeLater, invokeLaters, isDebugStructure, isDefaultState, isFlagSet, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, paintComponent, preparePaint, removeAttribute, removeComponentModel, removeHtmlClass, removeHtmlClass, removeNotify, replaceWComponent, reset, serviceRequest, setAccessibleText, setAttribute, setEnvironment, setFlag, setFocussed, setHidden, setHtmlClass, setHtmlClass, setIdName, setInitialised, setLocked, setTag, setToolTip, setTrackingEnabled, setValidate, setVisible, showErrorIndicators, showErrorIndicatorsForComponent, showWarningIndicators, showWarningIndicatorsForComponent, tidyUpUIContext, tidyUpUIContextForTree, validate, validateComponent, writeReplace

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.bordertech.wcomponents.AccessKeyable

getAccessKeyAsString

Methods inherited from interface com.github.bordertech.wcomponents.WComponent

addHtmlClass, addHtmlClass, forward, getAccessibleText, getAttribute, getBaseUrl, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getParent, getTabIndex, getTag, getToolTip, hasTabIndex, invokeLater, isDefaultState, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, preparePaint, removeAttribute, removeHtmlClass, removeHtmlClass, reset, serviceRequest, setAccessibleText, setAttribute, setEnvironment, setFocussed, setHtmlClass, setHtmlClass, setIdName, setInitialised, setLocked, setTag, setToolTip, setTrackingEnabled, setValidate, setVisible, showErrorIndicators, showWarningIndicators, tidyUpUIContextForTree, validate

Constructor Detail

WCancelButton

public WCancelButton()

Creates a WCancelButton with the default text.

WCancelButton

public WCancelButton(String text)

Creates a WCancelButton with the specified text.

Parameters:

text - the button text

WCancelButton

public WCancelButton(String text,
                     char accessKey)

Creates a WCancelButton with the specified text and access key.

Parameters:

text - the button text.

accessKey - the access key.