oracle.cabo.ui
Class UINodeProxy

java.lang.Object
  |
  +--oracle.cabo.ui.DeprecatedUINode
        |
        +--oracle.cabo.ui.UINodeProxy

All Implemented Interfaces:

UINode

Direct Known Subclasses:

MutableUINodeAdapter

public abstract class UINodeProxy

extends DeprecatedUINode

implements UINode

Constructor Summary

UINodeProxy()

Method Summary

java.util.Enumeration	getAttributeNames(RenderingContext context) Returns an Enumeration of the names that attribute values have been added under.
java.lang.Object	getAttributeValue(RenderingContext context, AttributeKey attrKey) Returns the value of the attribute with the specified name in the RenderingContext.
java.util.Enumeration	getChildNames(RenderingContext context) Returns an Enumeration of the names that named children have been added under.
UINode	getIndexedChild(RenderingContext context, int childIndex) Returns the indexed child at the specified index.
int	getIndexedChildCount(RenderingContext context) Returns the number of indexed children in this UINode.
java.lang.String	getLocalName() Name used to distinguish the name of a UINode within a namespace.
UINode	getNamedChild(RenderingContext context, java.lang.String childName) Returns the child identified by childName.
java.lang.String	getNamespaceURI() The name space URI that segregates the local name of this UINode so that nodes with the same local name will not clash.
java.lang.String	getNodeID() Returns an ID indentifying this UINode instance.
NodeRole	getNodeRole(RenderingContext context) Returns the role that this node occupies.
java.lang.Object	getRawAttributeValue(RenderingContext context, AttributeKey attrKey) Returns the value of the attribute with a specified name, without attempting to further resolve that value - as if , for instance, it might be a BoundValue.
RenderingContext	getRenderingContext(RenderingContext context)
protected abstract UINode	getUINode()
void	render(RenderingContext context) Renders this UINode.
void	render(RenderingContext context, UINode node)
java.lang.String	toString()

Methods inherited from class oracle.cabo.ui.DeprecatedUINode

getAttributeValue, getChildNames, getID, getIndexedChild, getIndexedChildCount, getNamedChild

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.cabo.ui.UINode

getAttributeValue, getChildNames, getID, getIndexedChild, getIndexedChildCount, getNamedChild

Constructor Detail

UINodeProxy

public UINodeProxy()

Method Detail

getUINode

protected abstract UINode getUINode()

getNodeID

public java.lang.String getNodeID()

Returns an ID indentifying this UINode instance. This ID is never output to the user agent.

This ID should not be confused with the ID_ATTR attribute, which is output to the client and is typically used in conjunction with client-side scripting technologies, such as JavaScript.

Specified by:

getNodeID in interface UINode

getNamespaceURI

public java.lang.String getNamespaceURI()

The name space URI that segregates the local name of this UINode so that nodes with the same local name will not clash. Together, the namespace URI and the local identify the kind of UINode that this is.

Any namespace String returned by this method should be interned for maximum performance. This allows namespace comparisons to be performed using object identity, versus the slower object equality. If the String returned is a String constant, the Java VM will have done this for you automatically.

As with all namespace URI's, this name is only used as an identifier. No other sematics are implied.

The RendererManager allows RendererFactorys to be registered by namespace.

TO DO: put in link to XML namespaces

Specified by:

getNamespaceURI in interface UINode

See Also:

getLocalName(), RendererManager, RendererFactory

getLocalName

public java.lang.String getLocalName()

Name used to distinguish the name of a UINode within a namespace.

Together with the UINode's namespace URI, the local name is typically used to determine which Renderer to use to render the UINode.

Specified by:

getLocalName in interface UINode

getIndexedChildCount

public int getIndexedChildCount(RenderingContext context)

Returns the number of indexed children in this UINode.

If the UINode is mutable and may be modified and read in different threads, it is the programmer's responsibility to ensure proper synchronization.

Specified by:

getIndexedChildCount in interface UINode

See Also:

getIndexedChild(oracle.cabo.ui.RenderingContext, int)

getIndexedChild

public UINode getIndexedChild(RenderingContext context,
                              int childIndex)

Returns the indexed child at the specified index. Indexed children are used to represent homogenously treated children of UINodes.

If the UINode is mutable and may be modified and read in different threads, it is the programmer's responsibility to ensure proper synchronization.

Specified by:

getIndexedChild in interface UINode

See Also:

getIndexedChildCount(oracle.cabo.ui.RenderingContext)

getNamedChild

public UINode getNamedChild(RenderingContext context,
                            java.lang.String childName)

Returns the child identified by childName. Named children are used to represent heterogenously treated children of UINodes.

Constants for named children used by UIX Components (Marlin)'s UINodes may be found in the UIConstants interface. The constants for the named children follow the pattern <xxx>_CHILD.

If the UINode is mutable and may be modified and read in different threads, it is the programmer's responsibility to ensure proper synchronization.

Specified by:

getNamedChild in interface UINode

See Also:

getChildNames(oracle.cabo.ui.RenderingContext), UIConstants

getChildNames

public java.util.Enumeration getChildNames(RenderingContext context)

Returns an Enumeration of the names that named children have been added under. The actual UINodes for these named children may be retrieved by passing the Strings returned by this Enumeration to getNamedChild.

If the UINode is mutable and may be modified and read in different threads, it is the programmer's responsibility to ensure proper synchronization.

Specified by:

getChildNames in interface UINode

See Also:

getNamedChild(oracle.cabo.ui.RenderingContext, java.lang.String)

getAttributeNames

public java.util.Enumeration getAttributeNames(RenderingContext context)

Returns an Enumeration of the names that attribute values have been added under. The actual values for these attributes may be retrieved by passing the Strings returned by this Enumeration to getAttributeValue.

If the UINode is mutable and may be modified and read in different threads, it is the programmer's responsibility to ensure proper synchronization.

Specified by:

getAttributeNames in interface UINode

See Also:

getAttributeValue(oracle.cabo.ui.RenderingContext, oracle.cabo.ui.AttributeKey)

getAttributeValue

public java.lang.Object getAttributeValue(RenderingContext context,
                                          AttributeKey attrKey)

Returns the value of the attribute with the specified name in the RenderingContext. If no attribute with the specified name exists in this UINode, or a checked Exception occurs in retrieving the value of the attribute, null will be returned.

Note that as with indexed children and named children, the presence of of an attribute is no guarantee that the Renderer used to render this UINode will actually use the attribute. The presence of attributes should only be considered as hints to the Renderer.

If the UINode is mutable and may be modified and read in different threads, it is the programmer's responsibility to ensure proper synchronization.

Specified by:

getAttributeValue in interface UINode

See Also:

getAttributeNames(oracle.cabo.ui.RenderingContext)

getRawAttributeValue

public java.lang.Object getRawAttributeValue(RenderingContext context,
                                             AttributeKey attrKey)

Description copied from interface: UINode

Returns the value of the attribute with a specified name, without attempting to further resolve that value - as if , for instance, it might be a BoundValue.

Specified by:

getRawAttributeValue in interface UINode

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

See Also:

BoundValue

getRenderingContext

public RenderingContext getRenderingContext(RenderingContext context)

getNodeRole

public NodeRole getNodeRole(RenderingContext context)

Returns the role that this node occupies.

Specified by:

getNodeRole in interface UINode

render

public final void render(RenderingContext context)
                  throws java.io.IOException

Renders this UINode. Clients can implements this method in any way desired. All UIX Components (Marlin)-based implementations will get a RendererManager from the RenderingContext, get a Renderer, and defer rendering to that Renderer.

Specified by:

render in interface UINode

render

public void render(RenderingContext context,
                   UINode node)
            throws java.io.IOException

Specified by:

render in interface UINode

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object