org.apache.myfaces.trinidadinternal.ui.UINode Maven / Gradle / Ivy
Show all versions of trinidad-impl Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.myfaces.trinidadinternal.ui;
import java.io.IOException;
import java.util.Iterator;
import javax.faces.component.UIComponent;
/**
* Interface for storing a node of a UIX Components UI tree.
*
* Children of this UINode are stored in two separate fashions--by name or
* by index. How a child node is stored is dependent upon the contract
* between a UINode and its Renderer. For example, a Renderer that renders
* an arbitrary separator between each of its children may use a named
* child to indicate the UINode to use to render the separator, while the
* indexed children are used to indicate the children to render.
*
* Note that other UINodes referenced by a UINode should be stored as
* either named children or indexed children. They should not be stored
* as attributes or private state.
*
* UINodes do not store references to their parent UINodes. This allows
* the same instance of a UINode subtree to appear in multiple locations
* in the UINode tree.
*
* @version $Name: $ ($Revision: adfrt/faces/adf-faces-impl/src/main/java/oracle/adfinternal/view/faces/ui/UINode.java#0 $) $Date: 10-nov-2005.18:50:24 $
* @deprecated This class comes from the old Java 1.2 UIX codebase and should not be used anymore.
*/
@Deprecated
public interface UINode
{
/**
* Returns the UIComponent that this node represents, or null
* if it is not attached to a UIComponent.
*/
public UIComponent getUIComponent();
/**
* 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
* @see #getLocalName
* @see org.apache.myfaces.trinidadinternal.ui.RendererManager
* @see org.apache.myfaces.trinidadinternal.ui.RendererFactory
*/
public String getNamespaceURI();
/**
* 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.
*/
public String getLocalName();
/**
* 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.
*
*
* @see #getIndexedChild
*/
public int getIndexedChildCount(UIXRenderingContext context);
/**
* 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.
*
*
* @see #getIndexedChildCount
*/
public UINode getIndexedChild(UIXRenderingContext context, int childIndex);
/**
* 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 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.
*
*
* @see #getChildNames
* @see org.apache.myfaces.trinidadinternal.ui.UIConstants
*/
public UINode getNamedChild(UIXRenderingContext context, String childName);
/**
* Returns an Iterator 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 Iterator 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.
*
*
* @see #getNamedChild
*/
public Iterator getChildNames(UIXRenderingContext context);
/**
* Returns an Iterator of the names that attribute values have been
* added under. The actual values for these attributes may be retrieved
* by passing the AttributeKeys returned by this Iterator 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.
*
*
* @see #getAttributeValue
*/
public Iterator getAttributeNames(UIXRenderingContext context);
/**
* 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.
*
*
* @see #getAttributeNames
*/
public Object getAttributeValue(UIXRenderingContext 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.
*
* @see org.apache.myfaces.trinidadinternal.ui.data.BoundValue
*/
public Object getRawAttributeValue(UIXRenderingContext context, AttributeKey attrKey);
/**
* Returns the role that this node occupies.
*/
public NodeRole getNodeRole(UIXRenderingContext context);
/**
* Renders this UINode. Clients can implements this
* method in any way desired. All UIX Components-based implementations
* will get a RendererManager from the RenderingContext,
* get a Renderer, and defer rendering to that Renderer.
*/
public void render(UIXRenderingContext context)
throws IOException;
public void render(UIXRenderingContext context, UINode node)
throws IOException;
}