to.etc.domui.component.layout

Class Dialog

java.lang.Object

to.etc.domui.dom.css.CssBase

to.etc.domui.dom.html.NodeBase

to.etc.domui.dom.html.NodeContainer

to.etc.domui.dom.html.Div

to.etc.domui.component.layout.FloatingDiv

to.etc.domui.component.layout.Window

to.etc.domui.component.layout.Dialog

All Implemented Interfaces:

Iterable<NodeBase>, INodeErrorDelegate, IDraggable, IDropBody, IDropTargetable

Direct Known Subclasses:

DefaultLookupInputDialog, EditDialog, InputDialog, SaveSearchFilterDialog

public class Dialog
extends Window

A base class for retrieving any kind of input from a user.

Author:

Frits Jalvingh Created on Jul 18, 2011

Field Summary

Fields

Modifier and Type	Field and Description
static String	RSN_SAVE Close reason IWindowClosed.closed(String): the save button was pressed and onSave() did not die.

Fields inherited from class to.etc.domui.component.layout.FloatingDiv

DEFHEIGHT, DEFWIDTH, MINHEIGHT, MINWIDTH, RSN_CLOSE

Constructor Summary

Constructors

Constructor and Description
Dialog()
Dialog(boolean modal, boolean resizable, int width, int height, String title)
Dialog(boolean modal, boolean resizable, String title)
Dialog(boolean resizable, String title)
Dialog(int width, int height, String title)
Dialog(String title)

Method Summary

Modifier and Type	Method and Description
protected void	buttonCancel() Default handler for the cancel button: this will send the "CLOSE pressed" event (FloatingDiv.RSN_CLOSE).
protected void	buttonSave() The default save() implementation will call onValidate(), onSave(), then it will send a RSN_SAVE close event.
protected void	createButtons() Can be overridden to add extra buttons to the button bar where needed - this default implementation adds the save and cancel buttons.
protected void	createCancelButton()
protected void	createCancelButton(String text)
protected void	createCancelButton(String text, String image)
protected DefaultButton	createSaveButton()
protected DefaultButton	createSaveButton(String caption, String iconUrl)
IButtonBar	getButtonBar() Get the control's button bar.
IExecute	getOnSave()
Dialog	modal()
Dialog	modal(boolean yes)
protected boolean	onCloseException(Exception x) If sending the SAVE message fails with exception it can be handled here.
protected boolean	onSave() Override to validate data before the close event is sent and the window is closed.
protected boolean	onSaveBind() First part of save button handling: this should be overridden to move the data in the dialog's controls into their model.
protected boolean	onValidate() Second part of the save button handling: this should validate all input present in the model and any non-model controls.
Dialog	resizable()
void	setButtonsOnBottom(boolean onbottom) Define the button bar to be on the bottom.
void	setOnSave(IExecute onSave)
Dialog	size(int width, int height)
Dialog	title(String set)

Methods inherited from class to.etc.domui.component.layout.Window

createFrame, createTitleBar, getBottomContent, getTopContent, getWindowTitle, isClosable, setClosable, setDimensions, setIcon, setWindowTitle, width

Methods inherited from class to.etc.domui.component.layout.FloatingDiv

beforeCreateContent, callCloseHandler, close, close, closePressed, getBrowserWindowSize, getClientBounds, getOnClose, internalGetHider, internalSetHider, isAutoClose, isModal, isResizable, onClosed, onRemoveFromPage, setAutoClose, setOnClose, setOnSizeAndPositionChange, verticallyAlignToCenter

Methods inherited from class to.etc.domui.dom.html.Div

afterCreateContent, componentHandleWebAction, fadeIn, fadeOut, getCustomUpdatesCallJS, getDragHandler, getDropBody, getDropHandler, getDropMode, getReturnPressed, setDragHandler, setDropBody, setDropHandler, setReturnPressed, slideDown, slideUp, tb, visit

Methods inherited from class to.etc.domui.dom.html.NodeContainer

add, add, add, addTable, addTableForLayout, addTableForLayout, appendTreeErrors, canContain, delegateTo, disableAllChildControlsDeep, findChildIndex, forceRebuild, getChild, getChildCount, getChildren, getDeepChildren, getDelegate, getErrorFence, getTextContents, hasError, internalAdd, internalCheckNotDirty, internalClearDelta, internalClearDeltaFully, internalCreateFrame, internalGetNodeCount, internalGetOldChildren, internalOnBeforeRender, internalShelve, internalUnshelve, iterator, onRefresh, removeAllChildren, removeChild, removeChild, replaceChild, setErrorFence, setErrorFence, setText, setValue, undelegatedAdd, undelegatedGetChild

Methods inherited from class to.etc.domui.dom.html.NodeBase

$, acceptRequestParameter, addBinding, addCssClass, addGlobalMessage, addNotificationListener, alignToLeft, alignToLeft, alignToMiddle, alignToMiddle, alignTopToBottom, alignTopToBottom, alignToRight, alignToRight, alignToTop, alignToTop, appendAfterMe, appendBeforeMe, appendCreateJS, appendJavascript, appendJQuerySelector, appendJsCustomUpdatesContributor, appendShowOverflowTextAsTitleJs, appendStatement, bind, bind, bindErrors, build, calcTestID, changed, changedJavascriptState, clearFocusRequested, clearGlobalMessage, clearGlobalMessage, clearGlobalMessage, clearMessage, clearValidationFailure, componentHandleWebDataRequest, createContent, createStatement, findComponentBundle, findParent, getActualID, getAllocationTracepoint, getBindingErrors, getBindingList, getCalculatedTestID, getClicked, getComponentBundle, getComponentDataURL, getComponentDataURL, getComponentInfo, getComponentJSONURL, getCreateJS, getCssClass, getErrorList, getErrorLocation, getFocusID, getMessage, getOnClickJS, getOnMouseDownJS, getOnSizeAndPositionChange, getPage, getParent, getParent, getParent, getParentOfTypes, getSharedContext, getSharedContextFactory, getSpecialAttribute, getSpecialAttributeList, getTag, getTestID, getTestRepeatId, getThemedResourceRURL, getTitle, getUserObject, handleDrop, hasCssClass, hasParent, internalGetOldParent, internalGetParent, internalHasChangedAttributes, internalNeedClickHandler, internalOnClicked, internalOnValueChanged, internalRenderJavascriptDelta, internalRenderJavascriptState, internalSetHasChangedAttributes, internalSetHasChangedAttributes, internalSetLogAllocations, internalSetTag, isAttached, isBuilt, isFocusable, isFocusRequested, isRendersOwnClose, isStretchHeight, lc, notify, notifyParentOrOpenerPage, onAddedToPage, onBeforeFullRender, onBeforeRender, onForceRebuild, onHeaderContributors, onShelve, onUnshelve, refresh, remove, removeBinding, removeCssClass, renderJavascriptDelta, renderJavascriptState, renderJavascriptState, replaceWith, setBrowserWindowSize, setCalculcatedId, setCalculcatedId, setClicked, setClientBounds, setComponentBundle, setCssClass, setErrorLocation, setFocus, setMessage, setOnClickJS, setOnMouseDownJS, setOverrideTitle, setSpecialAttribute, setStretchHeight, setTestID, setTestRepeatID, setTitle, setUserObject, toString

Methods inherited from class to.etc.domui.dom.css.CssBase

getBackgroundAttachment, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorderBottomColor, getBorderBottomStyle, getBorderBottomWidth, getBorderLeftColor, getBorderLeftStyle, getBorderLeftWidth, getBorderRightColor, getBorderRightStyle, getBorderRightWidth, getBorderTopColor, getBorderTopStyle, getBorderTopWidth, getBottom, getCachedStyle, getClear, getColor, getDisplay, getFloat, getFontFamily, getFontSize, getFontSizeAdjust, getFontStyle, getFontVariant, getFontWeight, getHeight, getLeft, getLineHeight, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOverflow, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPosition, getRight, getTextAlign, getTop, getTransform, getVerticalAlign, getVisibility, getWidth, getZIndex, internalSetDisplay, setBackgroundAttachment, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorder, setBorderBottomColor, setBorderBottomStyle, setBorderBottomWidth, setBorderColor, setBorderLeftColor, setBorderLeftStyle, setBorderLeftWidth, setBorderRightColor, setBorderRightStyle, setBorderRightWidth, setBorderStyle, setBorderTopColor, setBorderTopStyle, setBorderTopWidth, setBorderWidth, setBottom, setBottom, setCachedStyle, setClear, setColor, setDisplay, setFloat, setFontFamily, setFontSize, setFontSizeAdjust, setFontStyle, setFontVariant, setFontWeight, setHeight, setLeft, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPosition, setRight, setRight, setTextAlign, setTop, setTop, setTransform, setVerticalAlign, setVisibility, setWidth, setZIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

RSN_SAVE

public static final String RSN_SAVE

Close reason IWindowClosed.closed(String): the save button was pressed and onSave() did not die.

See Also:

Constant Field Values

Constructor Detail

Dialog

public Dialog()

Dialog

public Dialog(boolean modal,
              boolean resizable,
              int width,
              int height,
              String title)

Dialog

public Dialog(boolean modal,
              boolean resizable,
              String title)

Dialog

public Dialog(boolean resizable,
              String title)

Dialog

public Dialog(String title)

Dialog

public Dialog(int width,
              int height,
              String title)

Method Detail

size

@Nonnull
public Dialog size(int width,
                            int height)

Overrides:

size in class Window

resizable

@Nonnull
public Dialog resizable()

Overrides:

resizable in class Window

modal

@Nonnull
public Dialog modal(boolean yes)

Overrides:

modal in class Window

modal

@Nonnull
public Dialog modal()

Overrides:

modal in class Window

title

@Nonnull
public Dialog title(@Nonnull
                             String set)

Overrides:

title in class Window

setButtonsOnBottom

public void setButtonsOnBottom(boolean onbottom)

Define the button bar to be on the bottom. Must be called before the button bar is created or used.

Parameters:

onbottom -

createButtons

protected void createButtons()
                      throws Exception

Can be overridden to add extra buttons to the button bar where needed - this default implementation adds the save and cancel buttons. If you override you should decide on their fate yourself!

Throws:

Exception

getButtonBar

public IButtonBar getButtonBar()

Get the control's button bar. If it does not already exists it will be created and added to the top content area.

Returns:

createCancelButton

protected void createCancelButton()

createCancelButton

protected void createCancelButton(@Nonnull
                                  String text)

createCancelButton

protected void createCancelButton(@Nonnull
                                  String text,
                                  @Nonnull
                                  String image)

createSaveButton

@Nonnull
protected DefaultButton createSaveButton()

createSaveButton

@Nonnull
protected DefaultButton createSaveButton(String caption,
                                                  String iconUrl)

buttonCancel

protected void buttonCancel()
                     throws Exception

Default handler for the cancel button: this will send the "CLOSE pressed" event (FloatingDiv.RSN_CLOSE).

Throws:

Exception

buttonSave

protected void buttonSave()
                   throws Exception

The default save() implementation will call onValidate(), onSave(), then it will send a RSN_SAVE close event. If the close event itself fails with exception the code will ask onCloseException() to see if we need to throw the exception or if it gets handled and shown as an error message or something like that.

Throws:

Exception

onSaveBind

protected boolean onSaveBind()
                      throws Exception

First part of save button handling: this should be overridden to move the data in the dialog's controls into their model.

Returns:

Throws:

Exception

onValidate

protected boolean onValidate()
                      throws Exception

Second part of the save button handling: this should validate all input present in the model and any non-model controls.

Returns:

Throws:

Exception

onCloseException

protected boolean onCloseException(Exception x)
                            throws Exception

If sending the SAVE message fails with exception it can be handled here. If the exception is handled here it must return true, else it should return false in which case the exception will pass through to toplevel. The default implementation returns false and does nothing.

Parameters:

x -

Returns:

Throws:

Exception

onSave

protected boolean onSave()
                  throws Exception

Override to validate data before the close event is sent and the window is closed.

Throws:

Exception

getOnSave

@Nullable
public IExecute getOnSave()

setOnSave

public void setOnSave(@Nullable
                      IExecute onSave)