to.etc.domui.dom.html

Class NodeContainer

java.lang.Object

to.etc.domui.dom.css.CssBase

to.etc.domui.dom.html.NodeBase

to.etc.domui.dom.html.NodeContainer

All Implemented Interfaces:

Iterable<NodeBase>, INodeErrorDelegate

Direct Known Subclasses:

ATag, Button, Div, Form, HTag, InputNodeContainer, Label, Li, SelectOption, Span, Table, TBody, TD, THead, TR, Ul, Underline

public abstract class NodeContainer
extends NodeBase
implements Iterable<NodeBase>

Base node for tags that can contain other nodes.

Author:

Frits Jalvingh Created on Aug 17, 2007

Constructor Summary

Constructors

Constructor and Description
NodeContainer(String tag) Create a container with the specified tag name.

Method Summary

Modifier and Type	Method and Description
void	add(int index, NodeBase nd) Add the child at the specified index in the child list.
NodeContainer	add(NodeBase nd) Add the child at the end of the list.
NodeContainer	add(String txt) Add a #text node.
TBody	addTable(String... headers) Utility method to add a table; it returns the TBody.
TBody	addTableForLayout()
TBody	addTableForLayout(String css)
void	appendTreeErrors(List<UIMessage> errorList)
protected void	canContain(NodeBase node) Override to check if special node types can be contained in this.
protected void	createFrame() EXPERIMENTAL This can be overridden to handle nodes that have an explicit "frame".
void	delegateTo(NodeContainer c) EXPERIMENTAL Set delegation to another node.
void	disableAllChildControlsDeep() Finds all IControl and IActionControl children and set it to readonly/disabled.
int	findChildIndex(NodeBase b) Return the index of the specified child, if present.
void	forceRebuild() This destroys all existing nodes and causes this node to be rebuilt the next time the tree is rendered.
NodeBase	getChild(int i) Get the nth child.
int	getChildCount() Return the #of children of this container.
<T> List<T>	getChildren(Class<T> ofClass) Locate all direct children of this container that are instancesof [ofClass].
<T> List<T>	getDeepChildren(Class<T> ofClass) Get a list of all children in the entire subtree that are an instance of the specified class.
NodeContainer	getDelegate() If this node delegates it's stuff to another, this returns that other node.
IErrorFence	getErrorFence()
String	getTextContents() If this node contains TextNode's only this creates the text string represented by those nodes.
boolean	hasError() Return T if this node currently has an error associated with it.
protected void	internalAdd(int index, NodeBase nd)
void	internalCheckNotDirty() Used for unit tests.
void	internalClearDelta() DO NOT USE.
void	internalClearDeltaFully() DO NOT USE.
protected void	internalCreateFrame() This method is a placeholder for NodeContainer which allows it to handle framed windows somehow.
protected int	internalGetNodeCount(int depth) Count the #of nodes in this tree, recursively until the given depth.
NodeBase[]	internalGetOldChildren() Internal: delta renderer old children set if this node changed.
void	internalOnBeforeRender()
protected void	internalShelve()
protected void	internalUnshelve()
Iterator<NodeBase>	iterator() Return an iterator that iterates over all children, in order.
protected void	onRefresh() Default onRefresh for a container will call refresh on all children.
void	removeAllChildren() Discard all children.
NodeBase	removeChild(int index) Remove the nth child.
void	removeChild(NodeBase child) Remove a child node from me.
void	replaceChild(NodeBase child, NodeBase nw) Swap two children: the "child" (1st) parameter gets removed, and the "nw" (2nd) parameter is put in it's place, at it's position.
void	setErrorFence()
void	setErrorFence(IErrorFence errorFence)
void	setText(String txt) Set the text contained in this node, using tilde replacement.
<T,C extends IConverter<T>> void	setValue(Class<C> conv, T value) Put a converted value in this cell's text.
void	undelegatedAdd(int index, NodeBase nd)
NodeBase	undelegatedGetChild(int i)

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

$, acceptRequestParameter, addBinding, addCssClass, addGlobalMessage, addNotificationListener, afterCreateContent, 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, componentHandleWebAction, 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, 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, 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, visit

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

NodeContainer

public NodeContainer(@Nonnull
                     String tag)

Create a container with the specified tag name.

Parameters:

tag -

Method Detail

internalCheckNotDirty

public final void internalCheckNotDirty()

Used for unit tests.

internalClearDelta

public final void internalClearDelta()

DO NOT USE. Internal: clear all delta information.

Overrides:

internalClearDelta in class NodeBase

See Also:

NodeBase.internalClearDelta()

internalClearDeltaFully

public final void internalClearDeltaFully()

DO NOT USE. Internal: clear delta including children's delta.

Overrides:

internalClearDeltaFully in class NodeBase

See Also:

NodeBase.internalClearDeltaFully()

internalGetOldChildren

public final NodeBase[] internalGetOldChildren()

Internal: delta renderer old children set if this node changed. Null if this node has not seen changes.

Returns:

internalGetNodeCount

protected int internalGetNodeCount(int depth)

Count the #of nodes in this tree, recursively until the given depth.

Overrides:

internalGetNodeCount in class NodeBase

See Also:

NodeBase.internalGetNodeCount(int)

iterator

@Nonnull
public final Iterator<NodeBase> iterator()

Return an iterator that iterates over all children, in order.

Specified by:

iterator in interface Iterable<NodeBase>

See Also:

Iterable.iterator()

getChildCount

public final int getChildCount()

Return the #of children of this container.

Returns:

findChildIndex

public final int findChildIndex(@Nonnull
                                NodeBase b)

Return the index of the specified child, if present. Returns -1 if not found.

Parameters:

b -

Returns:

getChild

@Nonnull
public final NodeBase getChild(int i)

Get the nth child.

Parameters:

i -

Returns:

undelegatedGetChild

public final NodeBase undelegatedGetChild(int i)

canContain

@OverridingMethodsMustInvokeSuper
protected void canContain(@Nonnull
                                                            NodeBase node)

Override to check if special node types can be contained in this.

Parameters:

node -

add

@Nonnull
public final NodeContainer add(@Nonnull
                                        NodeBase nd)

Add the child at the end of the list.

Parameters:

nd -

add

public final void add(int index,
                      @Nonnull
                      NodeBase nd)

Add the child at the specified index in the child list.

Parameters:

index -

nd -

undelegatedAdd

public final void undelegatedAdd(int index,
                                 @Nonnull
                                 NodeBase nd)

internalAdd

protected final void internalAdd(int index,
                                 @Nonnull
                                 NodeBase nd)

add

@Nonnull
public final NodeContainer add(@Nullable
                                        String txt)

Add a #text node.

Parameters:

txt -

removeChild

public final void removeChild(@Nonnull
                              NodeBase child)

Remove a child node from me. This also removes ALL descendants from the current page's view.

Parameters:

child -

removeChild

@Nonnull
public final NodeBase removeChild(int index)

Remove the nth child. The removed child is returned and can be reused (added) somewhere else.

Parameters:

index -

Returns:

replaceChild

public final void replaceChild(@Nonnull
                               NodeBase child,
                               @Nonnull
                               NodeBase nw)

Swap two children: the "child" (1st) parameter gets removed, and the "nw" (2nd) parameter is put in it's place, at it's position.

Parameters:

child -

nw -

removeAllChildren

public final void removeAllChildren()

Discard all children.

forceRebuild

@OverridingMethodsMustInvokeSuper
public final void forceRebuild()

This destroys all existing nodes and causes this node to be rebuilt the next time the tree is rendered.

Overrides:

forceRebuild in class NodeBase

setText

public void setText(@Nullable
                    String txt)

Set the text contained in this node, using tilde replacement. Before the new text node is added to the container the container will first be fully emptied, i.e. any contained node will be deleted. Setting a null or empty string text will just clear the node's contents without a TextNode being added. FIXME This must be renamed and made final.

Parameters:

txt -

getTextContents

@Nullable
public String getTextContents()

If this node contains TextNode's only this creates the text string represented by those nodes. If other nodes are found this returns null.

Returns:

internalShelve

protected final void internalShelve()
                             throws Exception

Overrides:

internalShelve in class NodeBase

Throws:

Exception

internalUnshelve

protected final void internalUnshelve()
                               throws Exception

Overrides:

internalUnshelve in class NodeBase

Throws:

Exception

addTable

public TBody addTable(String... headers)

Utility method to add a table; it returns the TBody.

Parameters:

headers - When not null this is set as the css class for the TABLE tag.

Returns:

addTableForLayout

@Nonnull
public TBody addTableForLayout(String css)

addTableForLayout

@Nonnull
public TBody addTableForLayout()

getChildren

public final <T> List<T> getChildren(@Nonnull
                                     Class<T> ofClass)

Locate all direct children of this container that are instancesof [ofClass].

Type Parameters:

T -

Parameters:

ofClass -

Returns:

getDeepChildren

@Nonnull
public final <T> List<T> getDeepChildren(@Nonnull
                                                  Class<T> ofClass)

Get a list of all children in the entire subtree that are an instance of the specified class.

Type Parameters:

T -

Parameters:

ofClass -

Returns:

onRefresh

protected void onRefresh()
                  throws Exception

Default onRefresh for a container will call refresh on all children.

Overrides:

onRefresh in class NodeBase

Throws:

Exception

See Also:

NodeBase.onRefresh()

setValue

public <T,C extends IConverter<T>> void setValue(@Nonnull
                                                 Class<C> conv,
                                                 @Nullable
                                                 T value)
                                          throws Exception

Put a converted value in this cell's text.

Type Parameters:

T -

C -

Parameters:

conv -

value -

Throws:

Exception

getErrorFence

@Nullable
public final IErrorFence getErrorFence()

setErrorFence

public final void setErrorFence(@Nullable
                                IErrorFence errorFence)

setErrorFence

public final void setErrorFence()

internalOnBeforeRender

public final void internalOnBeforeRender()
                                  throws Exception

Overrides:

internalOnBeforeRender in class NodeBase

Throws:

Exception

delegateTo

public final void delegateTo(@Nullable
                             NodeContainer c)

EXPERIMENTAL Set delegation to another node. This causes all "child" operations to delegate to the "to" node, it means that all nodes added to this node will actually be added to the "to" node. This is used to "delegate" content rendering for framed controls, so the content model of the control can be treated as the control itself.

Parameters:

c -

getDelegate

public NodeContainer getDelegate()

If this node delegates it's stuff to another, this returns that other node. See delegateTo(NodeContainer) for details.

Returns:

internalCreateFrame

protected final void internalCreateFrame()
                                  throws Exception

Description copied from class: NodeBase

This method is a placeholder for NodeContainer which allows it to handle framed windows somehow.

Overrides:

internalCreateFrame in class NodeBase

Throws:

Exception

createFrame

@OverridingMethodsMustInvokeSuper
protected void createFrame()
                                                      throws Exception

EXPERIMENTAL This can be overridden to handle nodes that have an explicit "frame".

Throws:

Exception

appendTreeErrors

public void appendTreeErrors(@Nonnull
                             List<UIMessage> errorList)

Overrides:

appendTreeErrors in class NodeBase

hasError

public boolean hasError()

Description copied from class: NodeBase

Return T if this node currently has an error associated with it.

Overrides:

hasError in class NodeBase

Returns:

disableAllChildControlsDeep

public void disableAllChildControlsDeep()
                                 throws Exception

Finds all IControl and IActionControl children and set it to readonly/disabled.

Throws:

Exception