javax.faces.webapp
Class TestComponent

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.webapp.TestComponent

All Implemented Interfaces:

java.util.EventListener, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class TestComponent
extends UIComponentBase

Field Summary

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

TestComponent()

TestComponent(java.lang.String id)

Method Summary

void	encodeBegin(FacesContext context) If our rendered property is true, render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext.
void	encodeChildren(FacesContext context) If our rendered property is true, render the child UIComponents of this UIComponent.
void	encodeEnd(FacesContext context) If our rendered property is true, render the ending of the current state of this UIComponent.
java.lang.String	getFamily() Return the identifier of the component family to which this component belongs.
java.lang.String	getLabel()
boolean	getRendersChildren() Return a flag indicating whether this component is responsible for rendering its child components.
void	setLabel(java.lang.String label)
void	setRendersChildren(boolean rendersChildren)

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Constructor Detail

TestComponent

public TestComponent()

TestComponent

public TestComponent(java.lang.String id)

Method Detail

getFamily

public java.lang.String getFamily()

Description copied from class: UIComponent

Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance.

Specified by:

getFamily in class UIComponent

getLabel

public java.lang.String getLabel()

setLabel

public void setLabel(java.lang.String label)

getRendersChildren

public boolean getRendersChildren()

Description copied from class: UIComponent

Return a flag indicating whether this component is responsible for rendering its child components. The default implementation in UIComponentBase.getRendersChildren() tries to find the renderer for this component. If it does, it calls Renderer.getRendersChildren() and returns the result. If it doesn't, it returns false. As of version 1.2 of the JavaServer Faces Specification, component authors are encouraged to return true from this method and rely on UIComponentBase.encodeChildren(javax.faces.context.FacesContext).

Overrides:

getRendersChildren in class UIComponentBase

setRendersChildren

public void setRendersChildren(boolean rendersChildren)

encodeBegin

public void encodeBegin(FacesContext context)
                 throws java.io.IOException

Description copied from class: UIComponent

If our rendered property is true, render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. Call UIComponent.pushComponentToEL(javax.faces.context.FacesContext,javax.faces.component.UIComponent). Call Application.publishEvent(javax.faces.context.FacesContext, java.lang.Class, java.lang.Object), passing PreRenderComponentEvent.class as the first argument and the component instance to be rendered as the second argument.

If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer.encodeBegin(FacesContext, UIComponent).

If our rendered property is false, call UIComponent.pushComponentToEL(javax.faces.context.FacesContext,javax.faces.component.UIComponent) and return immediately.

Overrides:

encodeBegin in class UIComponentBase

Parameters:

context - FacesContext for the response we are creating

Throws:

java.io.IOException - if an input/output error occurs while rendering

encodeChildren

public void encodeChildren(FacesContext context)
                    throws java.io.IOException

Description copied from class: UIComponent

If our rendered property is true, render the child UIComponents of this UIComponent. This method will only be called if the rendersChildren property is true.

If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer.encodeChildren(FacesContext, UIComponent). If no Renderer is associated with this UIComponent, iterate over each of the children of this component and call UIComponent.encodeAll(javax.faces.context.FacesContext).

Overrides:

encodeChildren in class UIComponentBase

Parameters:

context - FacesContext for the response we are creating

Throws:

java.io.IOException - if an input/output error occurs while rendering

encodeEnd

public void encodeEnd(FacesContext context)
               throws java.io.IOException

Description copied from class: UIComponent

If our rendered property is true, render the ending of the current state of this UIComponent.

If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer.encodeEnd(FacesContext, UIComponent).

Call UIComponent.popComponentFromEL(javax.faces.context.FacesContext). before returning regardless of the value of the rendered property.

Overrides:

encodeEnd in class UIComponentBase

Parameters:

context - FacesContext for the response we are creating

Throws:

java.io.IOException - if an input/output error occurs while rendering