oracle.cabo.ui
Class RenderedNodeRenderingContext

java.lang.Object
  |
  +--oracle.cabo.ui.LogicalNodeRenderingContext
        |
        +--oracle.cabo.ui.RenderedNodeRenderingContext

All Implemented Interfaces:

java.lang.Cloneable, RenderingContext

Direct Known Subclasses:

RootRenderingContext

public abstract class RenderedNodeRenderingContext

extends LogicalNodeRenderingContext

Abstract base class adding the following support to LogicalNodeRenderingContext

• Current DataObject
• Rendered Nodes
• Node Properties
• Local Properties

This class is subclassed by RenderingContexts that don't delegate the storage of their rendering state to another RenderingContext.

Fields inherited from interface oracle.cabo.ui.RenderingContext

CONTEXT_PATH_PROPERTY, CONTEXT_URI_PROPERTY, SHARED_CONTEXT_PATH_PROPERTY, SHARED_CONTEXT_URI_PROPERTY

Constructor Summary

RenderedNodeRenderingContext()

Method Summary

java.lang.Object	clone() Returns a clone of the RenderingContext.
protected int	getDefaultNodeStackSize() Returns the default initial number of nodes in the stack of logical nodes.
protected int	getDefaultPropertyMapSize() Returns the default size of the PropertyMap used to store properties on the RenderingContext.
java.lang.Object	getLocalProperty(int ancestorIndex, java.lang.Object key, java.lang.Object defaultValue) Retrieves the specifed property from the stack frame of the currently rendering UINode.
java.lang.Object	getProperty(java.lang.String namespace, java.lang.Object key) Gets a property stored on the context.
UINode	getRenderedAncestorNode(int index) Returns an ancestor of the node currently being processed.
int	getRenderedAncestorNodeCount() Returns the number of rendered nodes in the path form the current node being rendered to the root of the tree of nodes being rendered.
void	popRenderedChild() Removes the UINode to actually use to render from the rendered UINode stack.
void	pushRenderedChild(UINode renderedChild) Adds the UINode to actually use to render to the rendered UINode stack.
protected void	reset() Reset the PortletContext after use so that it can be resued without pinning unnecessary objects into memory
protected void	resetProperties() Lame method needed to support resetProperties on RootRenderingContext
void	setLocalProperty(java.lang.Object key, java.lang.Object value) Sets a property on the stack frame of the currently rendering UINode.
void	setProperty(java.lang.String namespace, java.lang.Object key, java.lang.Object value) Stores a property on the context.

Methods inherited from class oracle.cabo.ui.LogicalNodeRenderingContext

addDataProvider, getAncestorNode, getAncestorNodeCount, getCurrentDataObject, getDataObject, getDataObject, getDefaultDataProviderSize, getPath, popChild, pushChild, setCurrentDataObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.cabo.ui.RenderingContext

getAgent, getConfiguration, getErrorLog, getImageContext, getLocaleContext, getLookAndFeel, getOutputMethod, getParentContext, getRendererManager, getStyleContext, getURLEncoder, transformName

Constructor Detail

RenderedNodeRenderingContext

public RenderedNodeRenderingContext()

Method Detail

getRenderedAncestorNodeCount

public int getRenderedAncestorNodeCount()

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

Following copied from interface: oracle.cabo.ui.RenderingContext

See Also:

RenderingContext.getAncestorNodeCount()

getRenderedAncestorNode

public UINode getRenderedAncestorNode(int index)

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

Following copied from interface: oracle.cabo.ui.RenderingContext

See Also:

RenderingContext.getAncestorNode(int)

pushRenderedChild

public void pushRenderedChild(UINode renderedChild)

Description copied from interface: RenderingContext

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.

Overrides:

pushRenderedChild in class LogicalNodeRenderingContext

Following copied from interface: oracle.cabo.ui.RenderingContext

See Also:

RenderingContext.popRenderedChild(), RenderingContext.getRenderedAncestorNode(int), RenderingContext.getRenderedAncestorNodeCount()

popRenderedChild

public void popRenderedChild()

Description copied from interface: RenderingContext

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.

Overrides:

popRenderedChild in class LogicalNodeRenderingContext

Following copied from interface: oracle.cabo.ui.RenderingContext

See Also:

RenderingContext.pushRenderedChild(oracle.cabo.ui.UINode), RenderingContext.getRenderedAncestorNode(int), RenderingContext.getRenderedAncestorNodeCount()

getProperty

public java.lang.Object getProperty(java.lang.String namespace,
                                    java.lang.Object key)

Gets a property stored on the context.

setProperty

public void setProperty(java.lang.String namespace,
                        java.lang.Object key,
                        java.lang.Object value)

Stores a property on the context. Since RendererContexts are not persistent, state stored on a RendererContext will not be present in subsequent rendering passes.

setLocalProperty

public void setLocalProperty(java.lang.Object key,
                             java.lang.Object value)

Sets a property on the stack frame of the currently rendering UINode.

This method is for use by rendering code that needs to save some state while it is rendering.

Parameters:

key - Key used to identify this property on the stack frame.

value - Value to store. null is an acceptable value.

See Also:

getLocalProperty(int, java.lang.Object, java.lang.Object)

getLocalProperty

public java.lang.Object getLocalProperty(int ancestorIndex,
                                         java.lang.Object key,
                                         java.lang.Object defaultValue)

Retrieves the specifed property from the stack frame of the currently rendering UINode. If the property is not present, defaultValue is returned.

This method is for use by rendering code that needs to save some state while it is rendering.

Parameters:

key - Key used to identify the property on the stack frame to retrieve.

defaultValue - Value to return if the property doesn't exist in the stack frame.

See Also:

setLocalProperty(java.lang.Object, java.lang.Object)

clone

public java.lang.Object clone()

Description copied from interface: RenderingContext

Returns a clone of the RenderingContext.

Overrides:

clone in class LogicalNodeRenderingContext

getDefaultNodeStackSize

protected int getDefaultNodeStackSize()

Returns the default initial number of nodes in the stack of logical nodes.

The default for this property is relatively small.

Overrides:

getDefaultNodeStackSize in class LogicalNodeRenderingContext

getDefaultPropertyMapSize

protected int getDefaultPropertyMapSize()

Returns the default size of the PropertyMap used to store properties on the RenderingContext.

The default for this property is relatively small.

reset

protected void reset()

Reset the PortletContext after use so that it can be resued without pinning unnecessary objects into memory

Overrides:

reset in class LogicalNodeRenderingContext

resetProperties

protected void resetProperties()

Lame method needed to support resetProperties on RootRenderingContext