com.github.bordertech.wcomponents.examples

Class WDialogExample

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.WBeanComponent

com.github.bordertech.wcomponents.WContainer

com.github.bordertech.wcomponents.WPanel

com.github.bordertech.wcomponents.examples.WDialogExample

All Implemented Interfaces:

AccessKeyable, AjaxInternalTrigger, AjaxTarget, BeanAware, BeanBound, BeanProviderBound, Container, DataBound, DropZone, Marginable, MessageContainer, MutableContainer, NamingContextable, SubordinateTarget, WComponent, WebComponent, Serializable

public class WDialogExample
extends WPanel
implements MessageContainer

This example demonstrates the use of the WDialog component.

Since:

1.0.0, 1.0.0 Added many examples and reordered the examples so that the preferred mechanism for opening a dialog is the primary example.

Author:

Christina Harris, Mark Reeves

See Also:

Serialized Form

Nested Class Summary

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

WPanel.PanelMode, WPanel.PanelModel, WPanel.Type

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

AbstractWComponent.WComponentRef

Field Summary

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 and Description
WDialogExample() Creates a WDialogExample.

Method Summary

Modifier and Type	Method and Description
WMessages	getMessages()
WButton	getModalButton() Gets a button which opens a modal dialog.
String	getModalText() Get the modal dialog marker text.
WButton	getNonModalButton()
String	getNonModalText() Get the non-modal dialog marker text.

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

add, add, getAccessKey, getComponentModel, getDefaultSubmitButton, getLayout, getLayoutConstraints, getMargin, getMode, getOrCreateComponentModel, getTitleText, getType, newComponentModel, remove, setAccessKey, setDefaultSubmitButton, setLayout, setMargin, setMode, setTitleText, setType, toString

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

add, add, getChildAt, getChildCount, getChildren, getIndexOfChild, getNamingContextId, isNamingContext, removeAll, setNamingContext, setTemplate, setTemplate, setTemplateMarkUp

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, handleRequest, hasNoComponentModel, hasTabIndex, initialiseComponentModel, invokeLater, invokeLaters, isDebugStructure, isDefaultState, isFlagSet, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, paintComponent, preparePaint, preparePaintComponent, 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, handleRequest, 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

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

addAll

Constructor Detail

WDialogExample

public WDialogExample()

Creates a WDialogExample.

Method Detail

getMessages

public WMessages getMessages()

Specified by:

getMessages in interface MessageContainer

getModalText

public final String getModalText()

Get the modal dialog marker text. This is used for automated testing only and is not part of the example.

Returns:

the modal marker text

getNonModalText

public final String getNonModalText()

Get the non-modal dialog marker text. This is used for automated testing only and is not part of the example.

Returns:

the non-modal marker text

getModalButton

public final WButton getModalButton()

Gets a button which opens a modal dialog. Used for automated testing only: not part of the example.

Returns:

a modal dialog launch button;

getNonModalButton

public final WButton getNonModalButton()

Returns:

a non modal button