|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectto.etc.domui.dom.html.Page
public final class Page
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).
Constructor Summary | |
---|---|
Page(UrlPage pageContent)
|
Method Summary | ||
---|---|---|
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 |
appendJS(java.lang.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 |
clearPopIn()
Remove any pending pop-in. |
|
protected void |
copyIdMap()
Called by all methods that change this tree. |
|
NodeBase |
findNodeByID(java.lang.String id)
|
|
java.util.List<HeaderContributorEntry> |
getAddedContributors()
|
|
DomApplication |
getApplication()
|
|
java.util.Map<java.lang.String,NodeBase> |
getBeforeMap()
|
|
UrlPage |
getBody()
Return the BODY component for this page. |
|
ConversationContext |
getConversation()
|
|
|
getData(java.lang.Class<T> clz)
|
|
NodeBase |
getFocusComponent()
Return the component that currently has a focus request. |
|
java.util.List<HeaderContributorEntry> |
getHeaderContributorList()
|
|
int |
getPageExceptionCount()
|
|
PageParameters |
getPageParameters()
|
|
int |
getPageTag()
|
|
NodeBase |
getTheCurrentControl()
This tries to locate the control that the "theCurrentNode" is associated with. |
|
NodeBase |
getTheCurrentNode()
|
|
void |
internalAddContributors(java.util.List<HeaderContributorEntry> full)
|
|
void |
internalClearDeltaFully()
|
|
void |
internalContributorsRendered()
|
|
void |
internalDeltaBuild()
This handles the BUILD phase for the DELTA build. |
|
void |
internalFullBuild()
This handles the BUILD phase for a FULL page render. |
|
java.lang.StringBuilder |
internalGetAppendedJS()
|
|
ConversationContext |
internalGetConversation()
|
|
QDataContextFactory |
internalGetDataContextFactory()
|
|
QDataContext |
internalGetSharedContext()
|
|
void |
internalInitialize(PageParameters pp,
ConversationContext cc)
Assign required data to the page. |
|
java.util.Map<java.lang.String,NodeBase> |
internalNodeMap()
|
|
void |
internalSetDataContextFactory(QDataContextFactory s)
|
|
void |
internalSetSharedContext(QDataContext c)
|
|
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 |
isRenderAsXHTML()
|
|
boolean |
isShelved()
|
|
void |
openWindow(java.lang.Class<? extends UrlPage> clz,
PageParameters pp,
WindowParameters wp)
Deprecated. |
|
void |
openWindow(java.lang.String windowURL,
WindowParameters wp)
Deprecated. |
|
void |
setAllowVectorGraphics(boolean allowVectorGraphics)
|
|
|
setData(T inst)
|
|
void |
setFocusComponent(NodeBase focusComponent)
|
|
void |
setFullRenderCompleted(boolean fullRenderCompleted)
|
|
void |
setPageExceptionCount(int pageExceptionCount)
|
|
void |
setPopIn(NodeContainer pin)
This sets a new pop-in. |
|
void |
setRenderAsXHTML(boolean renderAsXHTML)
|
|
void |
setTheCurrentNode(NodeBase b)
|
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Page(UrlPage pageContent) throws java.lang.Exception
java.lang.Exception
Method Detail |
---|
public final void internalInitialize(PageParameters pp, ConversationContext cc)
pp
- cc
- public void setTheCurrentNode(NodeBase b)
public NodeBase getTheCurrentNode()
public NodeBase getTheCurrentControl()
public java.util.Map<java.lang.String,NodeBase> internalNodeMap()
public DomApplication getApplication()
public PageParameters getPageParameters()
public final int getPageTag()
public NodeBase findNodeByID(java.lang.String id)
protected final void copyIdMap()
public final java.util.Map<java.lang.String,NodeBase> getBeforeMap()
public void internalClearDeltaFully()
public final void addHeaderContributor(HeaderContributor hc, int order)
hc
- public void internalAddContributors(java.util.List<HeaderContributorEntry> full)
public java.util.List<HeaderContributorEntry> getHeaderContributorList()
public java.util.List<HeaderContributorEntry> getAddedContributors()
public void internalContributorsRendered()
public UrlPage getBody()
public <T> void setData(T inst)
public <T> T getData(java.lang.Class<T> clz)
public void internalFullBuild() throws java.lang.Exception
java.lang.Exception
public void internalDeltaBuild() throws java.lang.Exception
java.lang.Exception
public void appendJS(java.lang.CharSequence sq)
public java.lang.StringBuilder internalGetAppendedJS()
@Deprecated public void openWindow(@Nonnull java.lang.String windowURL, @Nullable WindowParameters wp)
DomUtil.createOpenWindowJS(String, WindowParameters)
.
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.
windowURL
- The url to open. If this is a relative path it will get the webapp
context appended to it.wp
- @Deprecated public void openWindow(@Nonnull java.lang.Class<? extends UrlPage> clz, @Nullable PageParameters pp, @Nullable WindowParameters wp)
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!!!!
clz
- pp
- wp
- public NodeBase getFocusComponent()
public void setFocusComponent(NodeBase focusComponent)
public ConversationContext getConversation()
public ConversationContext internalGetConversation()
public int getPageExceptionCount()
public void setPageExceptionCount(int pageExceptionCount)
public boolean isFullRenderCompleted()
public void setFullRenderCompleted(boolean fullRenderCompleted)
public void internalShelve() throws java.lang.Exception
java.lang.Exception
public void internalUnshelve() throws java.lang.Exception
java.lang.Exception
public boolean isShelved()
public void setPopIn(NodeContainer pin)
pin
- public void clearPopIn()
public java.lang.String toString()
toString
in class java.lang.Object
public boolean isDestroyed()
public QDataContext internalGetSharedContext()
internalGetSharedContext
in interface IQContextContainer
public void internalSetSharedContext(QDataContext c)
internalSetSharedContext
in interface IQContextContainer
IQContextContainer.internalSetSharedContext(to.etc.webapp.query.QDataContext)
public QDataContextFactory internalGetDataContextFactory()
internalGetDataContextFactory
in interface IQContextContainer
public void internalSetDataContextFactory(QDataContextFactory s)
internalSetDataContextFactory
in interface IQContextContainer
public boolean isAllowVectorGraphics()
public void setAllowVectorGraphics(boolean allowVectorGraphics)
public boolean isRenderAsXHTML()
public void setRenderAsXHTML(boolean renderAsXHTML)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |