to.etc.domui.component.layout

Class Window

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DebugWindow, Dialog, FloatingWindow, MsgBox, MsgBox2

public class Window
extends FloatingDiv

This is a basic floating window, with a title area, optional fixed content area's at the top and the bottom, and a scrollable content area in between. It has only presentational characteristics, no logic.

Author:

Frits Jalvingh Created on Jul 19, 2011

Field Summary

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

DEFHEIGHT, DEFWIDTH, MINHEIGHT, MINWIDTH, RSN_CLOSE

Constructor Summary

Constructors

Constructor and Description
Window()
Window(boolean modal, boolean resizable, int width, int height, String title) Full constructor: create a window and be able to set all options at once.
Window(boolean modal, boolean resizable, String title) Create a window of default size, with a specified title, modality and resizability.
Window(boolean resizable, String title) Create a modal window with the specified title and resizable option.
Window(int width, int height, String title) Create a modal, resizable window of the given size and with the specified title.
Window(String title) Create a modal, non-resizable window with the specified title.

Method Summary

Modifier and Type	Method and Description
protected void	createFrame() This creates the title bar frame.
protected void	createTitleBar() Create the title bar for the floater.
Div	getBottomContent() Return the div that is the bottom content area.
Div	getTopContent() Return the div that is the top content area.
String	getWindowTitle() Return the floater's title bar title string.
boolean	isClosable() When set to TRUE, the floater will display a close button on it's title bar, and will close if that thingy is pressed.
Window	modal()
Window	modal(boolean yes)
Window	resizable()
void	setClosable(boolean closable) When set to TRUE, the floater will display a close button on it's title bar, and will close if that thingy is pressed.
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	setIcon(String ico) Set an icon for the title bar, using the absolute path to a web resource.
void	setWindowTitle(String windowTitle) Set the floater's title bar string.
Window	size(int width, int height)
Window	title(String set)
Window	width(int pxsl)

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

Constructor Detail

Window

public Window()

Window

public Window(boolean modal,
              boolean resizable,
              int width,
              int height,
              @Nullable
              String title)

Full constructor: create a window and be able to set all options at once.

Parameters:

modal - T for a modal window.

resizable - T for a window that can be resized by the user.

width - The window width in pixels.

height - The window height in pixels.

title - The window title (or null if no title is required)

Window

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

Create a window of default size, with a specified title, modality and resizability.

Parameters:

modal -

resizable -

title -

Window

public Window(boolean resizable,
              String title)

Create a modal window with the specified title and resizable option.

Parameters:

resizable -

title -

Window

public Window(String title)

Create a modal, non-resizable window with the specified title.

Parameters:

title -

Window

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

Create a modal, resizable window of the given size and with the specified title.

Parameters:

width -

height -

title -

Method Detail

size

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

Overrides:

size in class FloatingDiv

resizable

@Nonnull
public Window resizable()

Overrides:

resizable in class FloatingDiv

modal

@Nonnull
public Window modal(boolean yes)

Overrides:

modal in class FloatingDiv

modal

@Nonnull
public Window modal()

Overrides:

modal in class FloatingDiv

title

@Nonnull
public Window title(@Nonnull
                             String set)

width

@Nonnull
public Window width(int pxsl)

Overrides:

width in class FloatingDiv

createFrame

protected void createFrame()
                    throws Exception

This creates the title bar frame.

Overrides:

createFrame in class NodeContainer

Throws:

Exception

See Also:

NodeContainer.createFrame()

setDimensions

public void setDimensions(int width,
                          int height)

Description copied from class: FloatingDiv

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

Overrides:

setDimensions in class FloatingDiv

createTitleBar

protected void createTitleBar()

Create the title bar for the floater. Also replaces existing title bar in case that new is set.

isClosable

public boolean isClosable()

When set to TRUE, the floater will display a close button on it's title bar, and will close if that thingy is pressed.

Returns:

setClosable

public void setClosable(boolean closable)

When set to TRUE, the floater will display a close button on it's title bar, and will close if that thingy is pressed.

Parameters:

closable -

getWindowTitle

public String getWindowTitle()

Return the floater's title bar title string.

Returns:

setWindowTitle

public void setWindowTitle(String windowTitle)

Set the floater's title bar string.

Parameters:

windowTitle -

setIcon

public void setIcon(String ico)

Set an icon for the title bar, using the absolute path to a web resource. If the name is prefixed with THEME/ it specifies an image from the current THEME's directory.

Parameters:

ico -

getBottomContent

public Div getBottomContent()

Return the div that is the bottom content area. Before it can be used it's heigth must be set manually to a size in pixels. This allows the Javascript layout calculator to calculate the size of the content area. After setting the height any content can be added here.

Returns:

getTopContent

public Div getTopContent()

Return the div that is the top content area. Before it can be used it's heigth must be set manually to a size in pixels. This allows the Javascript layout calculator to calculate the size of the content area. After setting the height any content can be added here.

Returns: