to.etc.domui.dom.html

Class UrlPage

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.dom.html.UrlPage

All Implemented Interfaces:

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

Direct Known Subclasses:

AccessDeniedPage, BasicPage, CurrentlyLoggedInUsersPage, DataAccessViolationPage, DateInputTestPage, ExpiredDataPage, ExpiredSessionPage, LoggerConfigPage, ServerLogPage, TestLoggerPage

@DefaultNonNull
public class UrlPage
extends Div

The base for all pages that can be accessed thru URL's. This is mostly a dummy class which ensures that all pages/fragments properly extend from DIV, ensuring that the Page logic can replace the "div" tag with a "body" tag for root fragments.

Author:

Frits Jalvingh Created on Sep 1, 2008

Constructor Summary

Constructors

Constructor and Description
UrlPage()

Method Summary

Modifier and Type	Method and Description
void	closeWindow() Adds javascript to close page window.
void	componentHandleWebAction(RequestContextImpl ctx, String action) Handle the action sent by the return pressed Javascript thingerydoo.
protected void	fixStretchBody() In case that stretch layout is used, this needs to be called for UrlPage that does not have already set height on its body (usually case for normal UrlPage that is shown inside new browser popup window - it is not needed for regular subclasses of Window).
protected void	fixStretchBodyUnkludged() In case that stretch layout is used, for page that does not use default ui-content padding (unkludged), this needs to be called for UrlPage that does not have already set height on its body.
void	forceReloadData()
INotifyPageEvent	getNotifyPageEvent()
String	getPageTitle() Get the page name used for AppPageTitleBar and BreadCrumb related code.
QDataContext	getSharedContext() This is the root implementation to get the "shared context" for database access.
QDataContext	getSharedContext(String key)
QDataContextFactory	getSharedContextFactory()
QDataContextFactory	getSharedContextFactory(String key)
String	getTestRepeatId() EXPERIMENTAL: If this is part of some "repeating" structure this must hold a repeat ID, which is a page-unique id for the repeating thing.
IThemeVariant	getThemeVariant()
ILogicContext	lc() EXPERIMENTAL Returns the business logic context for the current form.
void	onDestroy() Called when the page gets destroyed (navigation or such).
protected void	onForceRebuild() Called when forceRebuild is done on this node.
void	onReload() Gets called when a page is reloaded (for ROOT pages only).
void	resetAllSharedContexts() Use this only in cases when you really want to have fresh shared context -> in order to fetch all data fresh from database.
void	setNotifyPageEvent(INotifyPageEvent notifyPageEvent)
void	setPageTitle(String pageTitle) Set the page name used for AppPageTitleBar and BreadCrumb related code.
void	setThemeVariant(IThemeVariant themeVariant) Set the style of the theme to use for the entire page.
void	unkludge() Deprecated.

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

afterCreateContent, 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, beforeCreateContent, bind, bind, bindErrors, build, calcTestID, changed, changedJavascriptState, clearFocusRequested, clearGlobalMessage, clearGlobalMessage, clearGlobalMessage, clearMessage, clearValidationFailure, componentHandleWebDataRequest, createContent, createStatement, findComponentBundle, findParent, getActualID, getAllocationTracepoint, getBindingErrors, getBindingList, getBrowserWindowSize, getCalculatedTestID, getClicked, getClientBounds, getComponentBundle, getComponentDataURL, getComponentDataURL, getComponentInfo, getComponentJSONURL, getCreateJS, getCssClass, getErrorList, getErrorLocation, getFocusID, getMessage, getOnClickJS, getOnMouseDownJS, getOnSizeAndPositionChange, getPage, getParent, getParent, getParent, getParentOfTypes, getSpecialAttribute, getSpecialAttributeList, getTag, getTestID, getThemedResourceRURL, getTitle, getUserObject, handleDrop, hasCssClass, hasParent, internalGetOldParent, internalGetParent, internalHasChangedAttributes, internalNeedClickHandler, internalOnClicked, internalOnValueChanged, internalRenderJavascriptDelta, internalRenderJavascriptState, internalSetHasChangedAttributes, internalSetHasChangedAttributes, internalSetLogAllocations, internalSetTag, isAttached, isBuilt, isFocusable, isFocusRequested, isRendersOwnClose, isStretchHeight, notify, notifyParentOrOpenerPage, onAddedToPage, onBeforeFullRender, onBeforeRender, onHeaderContributors, onRemoveFromPage, onShelve, onUnshelve, refresh, remove, removeBinding, removeCssClass, renderJavascriptDelta, renderJavascriptState, renderJavascriptState, replaceWith, setBrowserWindowSize, setCalculcatedId, setCalculcatedId, setClicked, setClientBounds, setComponentBundle, setCssClass, setErrorLocation, setFocus, setMessage, setOnClickJS, setOnMouseDownJS, setOnSizeAndPositionChange, 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

UrlPage

public UrlPage()

Method Detail

setThemeVariant

public final void setThemeVariant(@Nonnull
                                  IThemeVariant themeVariant)

Set the style of the theme to use for the entire page. The normal style is "default", represented by DefaultThemeVariant.INSTANCE.

Parameters:

themeVariant -

getThemeVariant

public final IThemeVariant getThemeVariant()

unkludge

@Deprecated
public void unkludge()

Deprecated.

WILL BE REMOVED IN 5.2 - do not use. Remove the styles that cause the margin kludge to be applied to all pages.

onReload

public void onReload()
              throws Exception

Gets called when a page is reloaded (for ROOT pages only).

Throws:

Exception

onDestroy

public void onDestroy()
               throws Exception

Called when the page gets destroyed (navigation or such).

Throws:

Exception

getPageTitle

@Nullable
public String getPageTitle()

Get the page name used for AppPageTitleBar and BreadCrumb related code. To set the head title use the "title" property.

Returns:

getTestRepeatId

@Nonnull
public String getTestRepeatId()

Description copied from class: NodeBase

EXPERIMENTAL: If this is part of some "repeating" structure this must hold a repeat ID, which is a page-unique id for the repeating thing.

Overrides:

getTestRepeatId in class NodeBase

Returns:

setPageTitle

public void setPageTitle(@Nullable
                         String pageTitle)

Set the page name used for AppPageTitleBar and BreadCrumb related code. To set the head title use the "title" property.

Parameters:

pageTitle -

closeWindow

public void closeWindow()

Adds javascript to close page window.

fixStretchBody

protected void fixStretchBody()

In case that stretch layout is used, this needs to be called for UrlPage that does not have already set height on its body (usually case for normal UrlPage that is shown inside new browser popup window - it is not needed for regular subclasses of Window).

fixStretchBodyUnkludged

protected void fixStretchBodyUnkludged()

In case that stretch layout is used, for page that does not use default ui-content padding (unkludged), this needs to be called for UrlPage that does not have already set height on its body. Usual case is that UrlPage is shown inside new browser popup window - so, it is not needed for regular subclasses of Window.

getSharedContext

@Nonnull
public QDataContext getSharedContext()
                                       throws Exception

This is the root implementation to get the "shared context" for database access. Override this to get a different "default".

Overrides:

getSharedContext in class NodeBase

Returns:

Throws:

Exception

See Also:

NodeBase.getSharedContext()

getSharedContext

@Nonnull
public QDataContext getSharedContext(@Nonnull
                                              String key)
                                       throws Exception

Throws:

Exception

getSharedContextFactory

@Nonnull
public QDataContextFactory getSharedContextFactory()

Overrides:

getSharedContextFactory in class NodeBase

getSharedContextFactory

@Nonnull
public QDataContextFactory getSharedContextFactory(@Nonnull
                                                            String key)

onForceRebuild

protected void onForceRebuild()

Description copied from class: NodeBase

Called when forceRebuild is done on this node.

Overrides:

onForceRebuild in class NodeBase

lc

@Nonnull
public ILogicContext lc()
                          throws Exception

EXPERIMENTAL Returns the business logic context for the current form.

Overrides:

lc in class NodeBase

Returns:

Throws:

Exception

See Also:

NodeBase.lc()

forceReloadData

public void forceReloadData()
                     throws Exception

Throws:

Exception

resetAllSharedContexts

public void resetAllSharedContexts()

Use this only in cases when you really want to have fresh shared context -> in order to fetch all data fresh from database.

componentHandleWebAction

public void componentHandleWebAction(@Nonnull
                                     RequestContextImpl ctx,
                                     @Nonnull
                                     String action)
                              throws Exception

Description copied from class: Div

Handle the action sent by the return pressed Javascript thingerydoo.

Overrides:

componentHandleWebAction in class Div

Throws:

Exception

See Also:

NodeBase.componentHandleWebAction(to.etc.domui.server.RequestContextImpl, java.lang.String)

getNotifyPageEvent

@Nullable
public INotifyPageEvent getNotifyPageEvent()

setNotifyPageEvent

public void setNotifyPageEvent(@Nonnull
                               INotifyPageEvent notifyPageEvent)