to.etc.domui.component.layout

Class FloatingDiv

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Window

public class FloatingDiv
extends Div

The base class for all floating thingeries (new style).

Author:

Frits Jalvingh Created on Jul 18, 2011

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFHEIGHT
protected static int	DEFWIDTH
protected static int	MINHEIGHT
protected static int	MINWIDTH
static String	RSN_CLOSE Close reason IWindowClosed.closed(String): the dialog was closed by the close button or by pressing the hider.

Constructor Summary

Constructors

Constructor and Description
FloatingDiv()
FloatingDiv(boolean modal)
FloatingDiv(boolean modal, boolean resizable)
FloatingDiv(boolean modal, boolean resizable, int widthinpx, int heightinpx)

Method Summary

Modifier and Type	Method and Description
protected void	beforeCreateContent()
protected void	callCloseHandler(String closeReason) Internal use: call the registered "close" handler with the close reason.
void	close() Close this floater and cause it to be destroyed from the UI without calling the close handler.
static void	close(NodeBase node) Can be called from panels that know they are inside a FloatingDiv/Window/Dialog to close the surrounding dialog.
void	closePressed() Close the window !AND CALL THE CLOSE HANDLER!.
Dimension	getBrowserWindowSize() Exposed call to get browser window size.
Rect	getClientBounds() Exposed client bounds.
IWindowClosed	getOnClose() Get the current "onClose" handler: a handler to call when the window is closed.
Div	internalGetHider()
void	internalSetHider(Div hider)
boolean	isAutoClose()
boolean	isModal() Returns T if this is a MODAL window, obscuring windows it is on top of.
boolean	isResizable()
FloatingDiv	modal()
FloatingDiv	modal(boolean yes)
protected void	onClosed(String closeReason) Can be overridden to handle close events inside a subclass.
void	onRemoveFromPage(Page p) Overridden to tell the floating thing handler to remove this floater from the stack.
FloatingDiv	resizable()
void	setAutoClose(boolean autoClose) When set (which is the default), clicking outside the dialog will automatically close (cancel) it.
void	setDimensions(int width, int height) Change the width and height for the dialog - only valid before it has been built!! The minimum size is 250x200 pixels.
void	setOnClose(IWindowClosed onClose) Set the current "onClose" handler: a handler to call when the window is closed.
void	setOnSizeAndPositionChange(INotify<NodeBase> onSizeAndPositionChange) Exposed listener setter for notification on size and/or position change.
FloatingDiv	size(int width, int height)
void	verticallyAlignToCenter() Position floater into center of screen vertically.
FloatingDiv	width(int pxsl)

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

public static final String RSN_CLOSE

Close reason IWindowClosed.closed(String): the dialog was closed by the close button or by pressing the hider.

See Also:

Constant Field Values

DEFWIDTH

protected static final int DEFWIDTH

See Also:

Constant Field Values

DEFHEIGHT

protected static final int DEFHEIGHT

See Also:

Constant Field Values

MINWIDTH

protected static final int MINWIDTH

See Also:

Constant Field Values

MINHEIGHT

protected static final int MINHEIGHT

See Also:

Constant Field Values

Constructor Detail

FloatingDiv

public FloatingDiv()

FloatingDiv

public FloatingDiv(boolean modal)

FloatingDiv

public FloatingDiv(boolean modal,
                   boolean resizable)

FloatingDiv

public FloatingDiv(boolean modal,
                   boolean resizable,
                   int widthinpx,
                   int heightinpx)

Method Detail

size

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

resizable

@Nonnull
public FloatingDiv resizable()

modal

@Nonnull
public FloatingDiv modal(boolean yes)

modal

@Nonnull
public FloatingDiv modal()

width

@Nonnull
public FloatingDiv width(int pxsl)

setDimensions

public void setDimensions(int width,
                          int height)

Change the width and height for the dialog - only valid before it has been built!! The minimum size is 250x200 pixels.

Parameters:

width -

height -

isModal

public boolean isModal()

Returns T if this is a MODAL window, obscuring windows it is on top of.

isResizable

public boolean isResizable()

internalGetHider

@Nullable
public Div internalGetHider()

internalSetHider

public void internalSetHider(@Nullable
                             Div hider)

onRemoveFromPage

public void onRemoveFromPage(Page p)

Overridden to tell the floating thing handler to remove this floater from the stack.

Overrides:

onRemoveFromPage in class NodeBase

See Also:

NodeBase.onRemoveFromPage(to.etc.domui.dom.html.Page)

beforeCreateContent

protected void beforeCreateContent()

Overrides:

beforeCreateContent in class NodeBase

isAutoClose

public boolean isAutoClose()

setAutoClose

public void setAutoClose(boolean autoClose)

When set (which is the default), clicking outside the dialog will automatically close (cancel) it.

Parameters:

autoClose -

getOnClose

@Nullable
public final IWindowClosed getOnClose()

Get the current "onClose" handler: a handler to call when the window is closed. This is only called if the window is closed by a user action, not when the window is closed by code (by calling close()).

Returns:

setOnClose

public final void setOnClose(@Nullable
                             IWindowClosed onClose)

Set the current "onClose" handler: a handler to call when the window is closed. This is only called if the window is closed by a user action, not when the window is closed by code (by calling close()).

Parameters:

onClose -

callCloseHandler

protected final void callCloseHandler(@Nonnull
                                      String closeReason)
                               throws Exception

Internal use: call the registered "close" handler with the close reason. For this base class the only reason passed will be RSN_CLOSED. Derived classes can add other string constants to use.

Parameters:

reasonCode -

Throws:

Exception

onClosed

protected void onClosed(@Nonnull
                        String closeReason)
                 throws Exception

Can be overridden to handle close events inside a subclass. This gets called when the close event fires, before the onClose property handler is called.

Parameters:

closeReason -

Throws:

Exception

closePressed

public void closePressed()
                  throws Exception

Close the window !AND CALL THE CLOSE HANDLER!. To close the window without calling the close handler use close(). This code represents the "cancel" action for dialogs.

Throws:

Exception

close

@OverridingMethodsMustInvokeSuper
public void close()

Close this floater and cause it to be destroyed from the UI without calling the close handler. To call the close handler use closePressed().

close

public static void close(@Nonnull
                         NodeBase node)

Can be called from panels that know they are inside a FloatingDiv/Window/Dialog to close the surrounding dialog.

Parameters:

node -

verticallyAlignToCenter

public void verticallyAlignToCenter()

Position floater into center of screen vertically.

getClientBounds

public Rect getClientBounds()

Exposed client bounds. This gets set internally in case that floating div is dragged or resized in client (browser).

Overrides:

getClientBounds in class NodeBase

See Also:

NodeBase.getClientBounds()

getBrowserWindowSize

public Dimension getBrowserWindowSize()

Exposed call to get browser window size. This gets set internally in case that floating div is dragged or resized in client (browser).

Overrides:

getBrowserWindowSize in class NodeBase

See Also:

NodeBase.getClientBounds()

setOnSizeAndPositionChange

public final void setOnSizeAndPositionChange(@Nonnull
                                             INotify<NodeBase> onSizeAndPositionChange)

Exposed listener setter for notification on size and/or position change. This gets changed in case that floating div is dragged or resized in client (browser). Call getClientBounds() in order to read size and position after change.

Overrides:

setOnSizeAndPositionChange in class NodeBase

See Also:

to.etc.domui.dom.html.NodeBase#setOnSizeAndPositionChange()