to.etc.domui.dom.html

Class Page

java.lang.Object

to.etc.domui.dom.html.Page

All Implemented Interfaces:

IQContextContainer

public final class Page
extends Object
implements IQContextContainer

This is the main owner of all nodes; this represents all that is needed for a page to render. All nodes that are (indirectly) attached to the page directly connect here. The page maintains a full ident map to all components currently reachable on the page. In addition the page assigns IDs to nodes that have no ID (or a duplicate ID).

Author:

Frits Jalvingh Created on Aug 18, 2007

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Page.NotificationListener<T>

Constructor Summary

Constructors

Constructor and Description
Page(UrlPage pageContent)

Method Summary

Modifier and Type	Method and Description
void	addAfterRequestListener(IExecute x)
void	addBeforeRequestListener(IExecute x)
void	addHeaderContributor(HeaderContributor hc, int order) Call from within the onHeaderContributor call on a node to register any header contributors needed by a node.
void	addRemoveAfterRenderNode(NodeBase node)
String	allocateTestID(String initial)
void	appendJS(CharSequence sq) Add a Javascript statement (MUST be a valid, semicolon-terminated statement or statement list) to execute on return to the browser (once).
void	calculateDefaultFocus(NodeBase node)
void	callRequestFinished()
void	callRequestStarted()
void	clearPopIn() Remove any pending pop-in.
void	controlToModel()
protected void	copyIdMap() Called by all methods that change this tree.
NodeBase	findNodeByID(String id)
List<HeaderContributorEntry>	getAddedContributors()
List<QContextContainer>	getAllContextContainers()
DomApplication	getApplication()
Map<String,NodeBase>	getBeforeMap()
UrlPage	getBody() Return the BODY component for this page.
QContextContainer	getContextContainer(String key)
ConversationContext	getConversation()
<T> T	getData(Class<T> clz)
NodeBase	getDefaultFocusSource()
NodeBase	getFocusComponent() Return the component that currently has a focus request.
List<HeaderContributorEntry>	getHeaderContributorList()
int	getPageExceptionCount()
IPageParameters	getPageParameters() Return the readonly copy of the parameters for this page.
int	getPageTag()
NodeContainer	getPopIn()
int	getRequestCounter()
NodeBase	getTheCurrentControl() This tries to locate the control that the "theCurrentNode" is associated with.
NodeBase	getTheCurrentNode()
void	inBuild()
void	inNull()
void	inRender()
void	internalAddContributors(List<HeaderContributorEntry> full)
void	internalClearDeltaFully()
void	internalContributorsRendered()
void	internalDeltaBuild() This handles the BUILD phase for the DELTA build.
StringBuilder	internalFlushAppendJS()
StringBuilder	internalFlushJavascriptStateChanges() For all nodes that registered a "javascript delta", this calls that node's NodeBase.renderJavascriptDelta(JavascriptStmt) method, then it will reset the state for the node.
void	internalFullBuild() This handles the BUILD phase for a FULL page render.
StringBuilder	internalGetAppendJS()
ConversationContext	internalGetConversation()
Set<NodeBase>	internalGetJavaScriptStateChangedSet()
void	internalIncrementRequestCounter()
void	internalInitialize(IPageParameters pp, ConversationContext cc) Assign required data to the page.
Map<String,NodeBase>	internalNodeMap()
void	internalRemoveFloater(FloatingDiv floater) Callback called by a floating window when it is removed from the page.
void	internalSetPhase(PagePhase phase)
void	internalShelve() Call all onShelve() handlers on all attached components.
void	internalUnshelve() Call all unshelve handlers on all attached components.
boolean	isAllowVectorGraphics()
boolean	isDestroyed()
boolean	isFullRenderCompleted()
boolean	isInjected()
boolean	isRenderAsXHTML()
boolean	isShelved()
boolean	isTestIDAllocated(String id)
void	modelToControl()
void	openWindow(Class<? extends UrlPage> clz, IPageParameters pp, WindowParameters wp) Deprecated.
void	openWindow(String windowURL, WindowParameters wp) Force the browser to open a new window with a user-specified URL.
void	setAllowVectorGraphics(boolean allowVectorGraphics)
<T> void	setData(T inst)
void	setFocusComponent(NodeBase focusComponent)
void	setFullRenderCompleted(boolean fullRenderCompleted)
void	setInjected(boolean injected)
void	setPageExceptionCount(int pageExceptionCount)
void	setPopIn(NodeContainer pin) This sets a new pop-in.
void	setRenderAsXHTML(boolean renderAsXHTML)
void	setTheCurrentNode(NodeBase b)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Page

public Page(@Nonnull
            UrlPage pageContent)
     throws Exception

Throws:

Exception

Method Detail

internalSetPhase

public void internalSetPhase(@Nonnull
                             PagePhase phase)

inNull

public void inNull()

inRender

public void inRender()

inBuild

public void inBuild()

internalInitialize

public final void internalInitialize(@Nonnull
                                     IPageParameters pp,
                                     @Nonnull
                                     ConversationContext cc)

Assign required data to the page.

Parameters:

pp -

cc -

setTheCurrentNode

public void setTheCurrentNode(@Nullable
                              NodeBase b)

getTheCurrentNode

@Nullable
public NodeBase getTheCurrentNode()

getTheCurrentControl

@Nullable
public NodeBase getTheCurrentControl()

This tries to locate the control that the "theCurrentNode" is associated with. If no control can be found it returns the node verbatim.

Returns:

internalNodeMap

@Nonnull
public Map<String,NodeBase> internalNodeMap()

getApplication

@Nonnull
public DomApplication getApplication()

getPageParameters

@Nonnull
public IPageParameters getPageParameters()

Return the readonly copy of the parameters for this page.

Returns:

getRequestCounter

public int getRequestCounter()

internalIncrementRequestCounter

public void internalIncrementRequestCounter()

getPageTag

public final int getPageTag()

findNodeByID

@Nullable
public NodeBase findNodeByID(@Nonnull
                                       String id)

copyIdMap

protected final void copyIdMap()

Called by all methods that change this tree. As soon as this gets called it checks to see if a before-image is present. If not then it gets created so that the structure before the changes is maintained.

getBeforeMap

@Nullable
public final Map<String,NodeBase> getBeforeMap()

internalClearDeltaFully

public void internalClearDeltaFully()

addRemoveAfterRenderNode

public void addRemoveAfterRenderNode(@Nonnull
                                     NodeBase node)

allocateTestID

@Nonnull
public String allocateTestID(@Nonnull
                                      String initial)

isTestIDAllocated

public boolean isTestIDAllocated(@Nonnull
                                 String id)

addHeaderContributor

public final void addHeaderContributor(@Nonnull
                                       HeaderContributor hc,
                                       int order)

Call from within the onHeaderContributor call on a node to register any header contributors needed by a node.

Parameters:

hc -

internalAddContributors

public void internalAddContributors(@Nonnull
                                    List<HeaderContributorEntry> full)

getHeaderContributorList

@Nonnull
public List<HeaderContributorEntry> getHeaderContributorList()

getAddedContributors

@Nonnull
public List<HeaderContributorEntry> getAddedContributors()

internalContributorsRendered

public void internalContributorsRendered()

getBody

@Nonnull
public UrlPage getBody()

Return the BODY component for this page.

Returns:

setData

public <T> void setData(@Nonnull
                        T inst)

getData

@Nullable
public <T> T getData(@Nonnull
                               Class<T> clz)

modelToControl

public void modelToControl()
                    throws Exception

Throws:

Exception

controlToModel

public void controlToModel()
                    throws Exception

Throws:

Exception

internalRemoveFloater

public void internalRemoveFloater(@Nonnull
                                  FloatingDiv floater)

Callback called by a floating window when it is removed from the page.

Parameters:

floater -

internalFullBuild

public void internalFullBuild()
                       throws Exception

This handles the BUILD phase for a FULL page render.

Throws:

Exception

internalDeltaBuild

public void internalDeltaBuild()
                        throws Exception

This handles the BUILD phase for the DELTA build. It walks only the nodes that are marked as changed initially and does not descend subtrees that are unchanged.

Throws:

Exception

appendJS

public void appendJS(@Nonnull
                     CharSequence sq)

Add a Javascript statement (MUST be a valid, semicolon-terminated statement or statement list) to execute on return to the browser (once).

internalFlushAppendJS

@Nullable
public StringBuilder internalFlushAppendJS()

internalGetAppendJS

@Nonnull
public StringBuilder internalGetAppendJS()

openWindow

public void openWindow(@Nonnull
                       String windowURL,
                       @Nullable
                       WindowParameters wp)

Force the browser to open a new window with a user-specified URL. The new window does NOT inherit any DomUI session data, of course, and has no WindowSession. After creation the window cannot be manipulated by DomUI code.

Parameters:

windowURL - The url to open. If this is a relative path it will get the webapp context appended to it.

wp -

openWindow

@Deprecated
public void openWindow(@Nonnull
                                   Class<? extends UrlPage> clz,
                                   @Nullable
                                   IPageParameters pp,
                                   @Nullable
                                   WindowParameters wp)

Deprecated.

DEPRECATED: Should use DomUtil#createOpenWindowJS(Class, PageParameters, WindowParameters). Open a DomUI page in a separate browser popup window. This window will create it's own WindowSession. FIXME URGENT This code needs to CREATE the window session BEFORE referring to it!!!!

Parameters:

clz -

pp -

wp -

getFocusComponent

@Nullable
public NodeBase getFocusComponent()

Return the component that currently has a focus request.

Returns:

setFocusComponent

public void setFocusComponent(@Nullable
                              NodeBase focusComponent)

getConversation

@Nonnull
public ConversationContext getConversation()

internalGetConversation

@Nullable
public ConversationContext internalGetConversation()

getPageExceptionCount

public int getPageExceptionCount()

setPageExceptionCount

public void setPageExceptionCount(int pageExceptionCount)

isFullRenderCompleted

public boolean isFullRenderCompleted()

setFullRenderCompleted

public void setFullRenderCompleted(boolean fullRenderCompleted)

internalShelve

public void internalShelve()
                    throws Exception

Call all onShelve() handlers on all attached components.

Throws:

Exception

internalUnshelve

public void internalUnshelve()
                      throws Exception

Call all unshelve handlers on all attached components.

Throws:

Exception

isShelved

public boolean isShelved()

internalGetJavaScriptStateChangedSet

@Nonnull
public Set<NodeBase> internalGetJavaScriptStateChangedSet()

internalFlushJavascriptStateChanges

@Nullable
public StringBuilder internalFlushJavascriptStateChanges()
                                                            throws Exception

For all nodes that registered a "javascript delta", this calls that node's NodeBase.renderJavascriptDelta(JavascriptStmt) method, then it will reset the state for the node. Because calls might cause other nodes to become invalid this code loops max 10 times checking the set of delta nodes.

Throws:

Exception

setPopIn

public void setPopIn(@Nullable
                     NodeContainer pin)

This sets a new pop-in. This does NOT add the popin to the tree, that must be done manually.

Parameters:

pin -

clearPopIn

public void clearPopIn()

Remove any pending pop-in.

getPopIn

@Nullable
public NodeContainer getPopIn()

toString

public String toString()

Overrides:

toString in class Object

isDestroyed

public boolean isDestroyed()

isInjected

public boolean isInjected()

setInjected

public void setInjected(boolean injected)

getAllContextContainers

@Nonnull
public List<QContextContainer> getAllContextContainers()

Specified by:

getAllContextContainers in interface IQContextContainer

getContextContainer

@Nonnull
public QContextContainer getContextContainer(@Nonnull
                                                      String key)

Specified by:

getContextContainer in interface IQContextContainer

isAllowVectorGraphics

public boolean isAllowVectorGraphics()

setAllowVectorGraphics

public void setAllowVectorGraphics(boolean allowVectorGraphics)

isRenderAsXHTML

public boolean isRenderAsXHTML()

setRenderAsXHTML

public void setRenderAsXHTML(boolean renderAsXHTML)

calculateDefaultFocus

public void calculateDefaultFocus(NodeBase node)

getDefaultFocusSource

@Nullable
public NodeBase getDefaultFocusSource()

addAfterRequestListener

public void addAfterRequestListener(@Nonnull
                                    IExecute x)

Parameters:

x -

addBeforeRequestListener

public void addBeforeRequestListener(@Nonnull
                                     IExecute x)

callRequestFinished

public void callRequestFinished()
                         throws Exception

Throws:

Exception

callRequestStarted

public void callRequestStarted()
                        throws Exception

Throws:

Exception