com.sun.rave.web.ui.component
Interface TemplateComponent

All Superinterfaces:

ChildManager, javax.faces.component.NamingContainer

All Known Implementing Classes:

TemplateComponentBase

public interface TemplateComponent

extends ChildManager, javax.faces.component.NamingContainer

This interface defines additional methods in addition to those defined by UIComponent that are needed to work with a TemplateRenderer.

JSF did not define an interface for UIComponent, so I cannot extend an interface here. This means that casting is needed to use UIComponent features from a TemplateComponent.

Author:

Ken Paulsen (ken.paulsen@sun.com)

Field Summary

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Method Summary

javax.faces.component.UIComponent	getChild(javax.faces.context.FacesContext context, java.lang.String id) This method will find the request child UIComponent by id.
com.sun.rave.web.ui.component.util.descriptors.LayoutDefinition	getLayoutDefinition(javax.faces.context.FacesContext context) This method returns the LayoutDefinition associated with this component.
java.lang.String	getLayoutDefinitionKey() This method returns the LayoutDefinitionKey for this component.
void	setLayoutDefinitionKey(java.lang.String key) This method sets the LayoutDefinition key for this component.

Methods inherited from interface com.sun.rave.web.ui.component.ChildManager

getChild

Method Detail

getChild

public javax.faces.component.UIComponent getChild(javax.faces.context.FacesContext context,
                                                  java.lang.String id)

This method will find the request child UIComponent by id. If it is not found, it will attempt to create it if it can find a LayoutElement describing it.

Parameters:

context - The FacesContext

id - The UIComponent id to search for

Returns:

The requested UIComponent

getLayoutDefinition

public com.sun.rave.web.ui.component.util.descriptors.LayoutDefinition getLayoutDefinition(javax.faces.context.FacesContext context)

This method returns the LayoutDefinition associated with this component.

Parameters:

context - The FacesContext

Returns:

LayoutDefinition associated with this component.

getLayoutDefinitionKey

public java.lang.String getLayoutDefinitionKey()

This method returns the LayoutDefinitionKey for this component.

Returns:

key The key to use in the LayoutDefinitionManager

setLayoutDefinitionKey

public void setLayoutDefinitionKey(java.lang.String key)

This method sets the LayoutDefinition key for this component.

Parameters:

key - The key to use in the LayoutDefinitionManager