org.apache.myfaces.trinidadinternal.ui
Class LogicalNodeRenderingContext

java.lang.Object
  org.apache.myfaces.trinidadinternal.ui.LogicalNodeRenderingContext

All Implemented Interfaces:

java.lang.Cloneable, UIXRenderingContext

Direct Known Subclasses:

RenderedNodeRenderingContext

Deprecated. This class comes from the old Java 1.2 UIX codebase and should not be used anymore.

@Deprecated
public abstract class LogicalNodeRenderingContext
extends java.lang.Object
implements UIXRenderingContext

Abstract RenderingContext implementation providing support for managing logical ancestors and DataProviders. Although this class supports both root and child RenderingContexts, it is configured by default to support child-style RenderingContexts.

Version:

$Name: $ ($Revision: adfrt/faces/adf-faces-impl/src/main/java/oracle/adfinternal/view/faces/ui/LogicalNodeRenderingContext.java#0 $) $Date: 10-nov-2005.18:50:13 $

Field Summary

Fields inherited from interface org.apache.myfaces.trinidadinternal.ui.UIXRenderingContext

CONTEXT_PATH_PROPERTY, CONTEXT_URI_PROPERTY

Constructor Summary

LogicalNodeRenderingContext()
Deprecated. Creates a AbstractRenderingContext.

Method Summary

java.lang.Object	clone() Deprecated. Returns a clone of the RenderingContext.
UINode	getAncestorNode(int index) Deprecated. Returns an ancestor of the node currently being processed.
int	getAncestorNodeCount() Deprecated. Returns the number of nodes in the path form the current node to the root of the tree of nodes being rendered.
DataObject	getCurrentDataObject() Deprecated. Returns a DataObject for the current node (such as a row of a table).
DataObject	getDataObject(java.lang.String namespaceURI, java.lang.String name) Deprecated. Returns the DataObject for the given namespace and name pair.
DataObject	getDataObject(UIXRenderingContext context, java.lang.String namespaceURI, java.lang.String name) Deprecated. Internal version of getDataObject().
protected int	getDefaultNodeStackSize() Deprecated. Returns the default initial number of nodes in the stack of nodes.
javax.faces.context.FacesContext	getFacesContext() Deprecated.
Path	getPath() Deprecated. Returns the path to the current node.
protected java.lang.String	getSkinResourceMappedKey(java.lang.String key) Deprecated. Given a key, look in the skin resource key map for the mapped value.
void	popChild() Deprecated. Removes a UINode from the stack.
void	popRenderedChild(UIXRenderingContext currentContext) Deprecated. Removes the UINode to actually use to render from the rendered UINode stack.
void	pushChild(UINode child, java.lang.String childName, int childIndex) Deprecated. Adds the UINode about to be rendered to the rendering stack.
void	pushRenderedChild(UIXRenderingContext currentContext, UINode child) Deprecated. Adds the UINode to actually use to render to the rendered UINode stack.
protected void	reset() Deprecated. Reset the state of the RenderingContext for reuse, even in case where RenderingContext did not complete cleanly.
DataObject	setCurrentDataObject(DataObject newDataObject) Deprecated. Sets the new currentDataObject, returning the current currentDataObject.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.myfaces.trinidadinternal.ui.UIXRenderingContext

getAgent, getConfiguration, getFormEncoder, getIcon, getImageContext, getLocaleContext, getLocalProperty, getLookAndFeel, getParentContext, getPartialPageContext, getProperty, getRenderedAncestorNode, getRenderedAncestorNodeCount, getRendererManager, getResponseWriter, getSkin, getSkinResourceKeyMap, getStyleClass, getStyleContext, getTranslatedString, getTranslatedValue, getURLEncoder, getVariableResolver, setLocalProperty, setProperty, setResponseWriter, setSkinResourceKeyMap

Constructor Detail

LogicalNodeRenderingContext

public LogicalNodeRenderingContext()

Deprecated.

Creates a AbstractRenderingContext.

Method Detail

getFacesContext

public javax.faces.context.FacesContext getFacesContext()

Deprecated.

Specified by:

getFacesContext in interface UIXRenderingContext

getCurrentDataObject

public DataObject getCurrentDataObject()

Deprecated.

Returns a DataObject for the current node (such as a row of a table).

Specified by:

getCurrentDataObject in interface UIXRenderingContext

setCurrentDataObject

public DataObject setCurrentDataObject(DataObject newDataObject)

Deprecated.

Description copied from interface: UIXRenderingContext

Sets the new currentDataObject, returning the current currentDataObject.

Specified by:

setCurrentDataObject in interface UIXRenderingContext

See Also:

UIXRenderingContext.getCurrentDataObject()

getAncestorNodeCount

public int getAncestorNodeCount()

Deprecated.

Returns the number of nodes in the path form the current node to the root of the tree of nodes being rendered.

Specified by:

getAncestorNodeCount in interface UIXRenderingContext

See Also:

UIXRenderingContext.getAncestorNode(int), UIXRenderingContext.getRenderedAncestorNodeCount(), UIXRenderingContext.getPath()

getAncestorNode

public UINode getAncestorNode(int index)

Deprecated.

Returns an ancestor of the node currently being processed. The zero-based index from least to most distant - getAncestorNode(0) will always return the current node. Returns null if the index is greater than or equal to the number of ancestors.

Specified by:

getAncestorNode in interface UIXRenderingContext

See Also:

UIXRenderingContext.getAncestorNodeCount(), UIXRenderingContext.getRenderedAncestorNode(int), UIXRenderingContext.getPath()

getPath

public Path getPath()

Deprecated.

Returns the path to the current node.

Specified by:

getPath in interface UIXRenderingContext

See Also:

UIXRenderingContext.getAncestorNodeCount(), UIXRenderingContext.getAncestorNode(int)

pushChild

public void pushChild(UINode child,
                      java.lang.String childName,
                      int childIndex)

Deprecated.

Adds the UINode about to be rendered to the rendering stack. Clients should never call this method. They should instead subclass BaseRenderer, which calls this method when needed.

Specified by:

pushChild in interface UIXRenderingContext

See Also:

UIXRenderingContext.popChild(), UIXRenderingContext.getAncestorNode(int), UIXRenderingContext.getAncestorNodeCount(), UIXRenderingContext.getPath()

popChild

public void popChild()

Deprecated.

Removes a UINode from the stack. Clients should never call this method; they should instead subclass BaseRenderer, which calls this method when needed.

Specified by:

popChild in interface UIXRenderingContext

See Also:

UIXRenderingContext.pushChild(org.apache.myfaces.trinidadinternal.ui.UINode, java.lang.String, int), UIXRenderingContext.getAncestorNode(int), UIXRenderingContext.getAncestorNodeCount(), UIXRenderingContext.getPath()

pushRenderedChild

public void pushRenderedChild(UIXRenderingContext currentContext,
                              UINode child)

Deprecated.

Description copied from interface: UIXRenderingContext

Adds the UINode to actually use to render to the rendered UINode stack.

Clients shuld never need to call this method as calls to this method are typically made on their behalf by the composite UINode framework.

Specified by:

pushRenderedChild in interface UIXRenderingContext

Parameters:

currentContext - The RenderingContext that is used when rendering the specified child node.

child - The UINode that is being rendered.

See Also:

UIXRenderingContext.popRenderedChild(org.apache.myfaces.trinidadinternal.ui.UIXRenderingContext), UIXRenderingContext.getRenderedAncestorNode(int), UIXRenderingContext.getRenderedAncestorNodeCount()

popRenderedChild

public void popRenderedChild(UIXRenderingContext currentContext)

Deprecated.

Description copied from interface: UIXRenderingContext

Removes the UINode to actually use to render from the rendered UINode stack.

Clients shuld never need to call this method as calls to this method are typically made on their behalf by the composite UINode framework.

Specified by:

popRenderedChild in interface UIXRenderingContext

Parameters:

currentContext - The current RenderingContext. That is, the context that was used to render the UINode that is being popped from the rendered child stack.

See Also:

UIXRenderingContext.pushRenderedChild(org.apache.myfaces.trinidadinternal.ui.UIXRenderingContext, org.apache.myfaces.trinidadinternal.ui.UINode), UIXRenderingContext.getRenderedAncestorNode(int), UIXRenderingContext.getRenderedAncestorNodeCount()

getDataObject

public DataObject getDataObject(UIXRenderingContext context,
                                java.lang.String namespaceURI,
                                java.lang.String name)

Deprecated.

Internal version of getDataObject(). Do not call this function unless you are yourself a RenderingContext.

Specified by:

getDataObject in interface UIXRenderingContext

getDataObject

public DataObject getDataObject(java.lang.String namespaceURI,
                                java.lang.String name)

Deprecated.

Returns the DataObject for the given namespace and name pair. It will call each data provider added with addDataProvider, starting with the most recently added, until one returns non-null. Then, it will look for DataObjects added with setDataObject().

Specified by:

getDataObject in interface UIXRenderingContext

See Also:

#addDataProvider

getDefaultNodeStackSize

protected int getDefaultNodeStackSize()

Deprecated.

Returns the default initial number of nodes in the stack of nodes. Subclassers implementing RenderingContexts that may support deep node depths, should override this method to return a larger number.

getSkinResourceMappedKey

protected java.lang.String getSkinResourceMappedKey(java.lang.String key)

Deprecated.

Given a key, look in the skin resource key map for the mapped value. If there isn't a value or the map is null, return the key itself.

Parameters:

key -

Returns:

String key, if in skin resource key map, then the mapped key.

reset

protected void reset()

Deprecated.

Reset the state of the RenderingContext for reuse, even in case where RenderingContext did not complete cleanly. =-= bts Most of this cleanup only really needs to be done if we don't handle catching exceptions and popping the stack correctly when rendering

clone

public java.lang.Object clone()

Deprecated.

Description copied from interface: UIXRenderingContext

Returns a clone of the RenderingContext.

Specified by:

clone in interface UIXRenderingContext

Overrides:

clone in class java.lang.Object