to.etc.domui.component.layout

Class InputDialog<T,C extends NodeBase & IControl<T>>

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

to.etc.domui.component.layout.InputDialog<T,C>

All Implemented Interfaces:

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

public class InputDialog<T,C extends NodeBase & IControl<T>>
extends Dialog

A Dialog that is used to input single value of type <T>, using input control of type <C>. It uses default layout that shows [Save], [Cancel] buttons, and label and input control as main panel data. To customize layout, override createFrame().

Author:

Vladimir Mijic Created on 30 Aug 2011

Field Summary

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

RSN_SAVE

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

DEFHEIGHT, DEFWIDTH, MINHEIGHT, MINWIDTH, RSN_CLOSE

Constructor Summary

Constructors

Constructor and Description
InputDialog(C inputControl, boolean modal, boolean resizable, int width, int height, String title, String label)
InputDialog(C inputControl, boolean modal, boolean resizable, String title, String label)
InputDialog(C inputControl, boolean resizable, String title)
InputDialog(C inputControl, int width, int height, String title)
InputDialog(C inputControl, String title)
InputDialog(C inputControl, String title, String label)

Method Summary

Modifier and Type	Method and Description
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.
void	createContent()
protected void	createFrame() Overridden to create the initial button bar with the "save" button and the "cancel" buttons in place.
C	getInputControl()
protected T	getInstance() The data instance being edited.
String	getLabel()
protected boolean	onSave() Finalized implementation, call to onSaveData with passed input instance.
protected boolean	onSaveBind() This uses the bindings created by createContent to move data in controls back to the instance (the model).
protected boolean	onSaveData(T instance) Override to do save logic on instance before the close event is sent and the window is closed.
protected boolean	onValidate() Finalized implementation, call to onValidateData with passed input instance.
protected boolean	onValidateData(T data) Override to do validation logic on instance before we continue to save method.
void	setLabel(String label)

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

buttonCancel, buttonSave, createCancelButton, createCancelButton, createCancelButton, createSaveButton, createSaveButton, getButtonBar, getOnSave, modal, modal, onCloseException, resizable, setButtonsOnBottom, setOnSave, size, title

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

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, 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

Constructor Detail

InputDialog

public InputDialog(C inputControl,
                   int width,
                   int height,
                   String title)

InputDialog

public InputDialog(C inputControl,
                   String title,
                   String label)

InputDialog

public InputDialog(C inputControl,
                   boolean modal,
                   boolean resizable,
                   int width,
                   int height,
                   String title,
                   String label)

InputDialog

public InputDialog(C inputControl,
                   boolean modal,
                   boolean resizable,
                   String title,
                   String label)

InputDialog

public InputDialog(C inputControl,
                   boolean resizable,
                   String title)

InputDialog

public InputDialog(C inputControl,
                   String title)

Method Detail

createFrame

@OverridingMethodsMustInvokeSuper
protected void createFrame()
                                                      throws Exception

Overridden to create the initial button bar with the "save" button and the "cancel" buttons in place. Also gives default input dialog layout. Overide to set custom layout, but then adding buttons is your responsibility!

Overrides:

createFrame in class Window

Throws:

Exception

See Also:

Window.createFrame()

createContent

public void createContent()
                   throws Exception

Overrides:

createContent in class NodeBase

Throws:

Exception

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!

Overrides:

createButtons in class Dialog

Throws:

Exception

onSaveBind

@OverridingMethodsMustInvokeSuper
protected boolean onSaveBind()
                                                        throws Exception

This uses the bindings created by createContent to move data in controls back to the instance (the model). If more than just those bindings are needed you need to override this and call super too.

Overrides:

onSaveBind in class Dialog

Returns:

Throws:

Exception

See Also:

Dialog.onSaveBind()

onSave

protected final boolean onSave()
                        throws Exception

Finalized implementation, call to onSaveData with passed input instance.

Overrides:

onSave in class Dialog

Throws:

Exception

See Also:

to.etc.domui.component.layout.InputDialog#onSaveData(T)

onSaveData

protected boolean onSaveData(T instance)
                      throws Exception

Override to do save logic on instance before the close event is sent and the window is closed.

Parameters:

instance -

Returns:

Throws:

Exception

onValidate

@OverridingMethodsMustInvokeSuper
protected final boolean onValidate()
                                                              throws Exception

Finalized implementation, call to onValidateData with passed input instance.

Overrides:

onValidate in class Dialog

Returns:

Throws:

Exception

See Also:

to.etc.domui.component.layout.InputDialog#onValidateData(T)

onValidateData

protected boolean onValidateData(T data)
                          throws Exception

Override to do validation logic on instance before we continue to save method.

Parameters:

data -

Returns:

Throws:

Exception

getInstance

protected T getInstance()

The data instance being edited.

Returns:

getInputControl

public C getInputControl()

getLabel

public String getLabel()

setLabel

public void setLabel(String label)