Module jakarta.faces

Package com.sun.faces.facelets.compiler

Class UIText

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

com.sun.faces.facelets.compiler.UILeaf

com.sun.faces.facelets.compiler.UIText

All Implemented Interfaces:

PartialStateHolder, UntargetableComponent, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener

public final class UIText
extends UILeaf

Version:

$Id$

Field Summary

Fields inherited from class jakarta.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor	Description
UIText(String alias, ELText txt)

Method Summary

Modifier and Type	Method	Description
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.
String	getFamily()	Return the identifier of the component family to which this component belongs.
String	getRendererType()	Return the Renderer type for this UIComponent (if any).
boolean	getRendersChildren()	Return a flag indicating whether this component is responsible for rendering its child components.
String	toString()

Methods inherited from class com.sun.faces.facelets.compiler.UILeaf

addFacesListener, broadcast, decode, encodeAll, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getParent, getRenderer, getValueExpression, isTransient, processDecodes, processUpdates, processValidators, queueEvent, removeFacesListener, setParent, setRendererType, setTransient, setValueExpression

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, clearInitialState, getAttributes, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getId, getListenersForEventClass, getPassThroughAttributes, invokeOnComponent, isRendered, markInitialState, processRestoreState, processSaveState, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setRendered, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class jakarta.faces.component.UIComponent

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

Methods inherited from class java.lang.Object

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

Constructor Details

UIText

public UIText(String alias,
 ELText txt)

Method Details

getFamily

public 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. Note this method should NOT return null

Overrides:

getFamily in class UILeaf

Returns:

the component family (not null).

encodeBegin

public void encodeBegin(FacesContext context)
                 throws 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(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent). Call Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, 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(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent) and return immediately.

Overrides:

encodeBegin in class UILeaf

Parameters:

context - FacesContext for the response we are creating

Throws:

IOException - if an input/output error occurs while rendering

getRendererType

public String getRendererType()

Description copied from class: UIComponent

Return the Renderer type for this UIComponent (if any).

Overrides:

getRendererType in class UILeaf

Returns:

the renderer type.

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 Jakarta Faces Specification, component authors are encouraged to return true from this method and rely on UIComponentBase.encodeChildren(jakarta.faces.context.FacesContext).

Overrides:

getRendersChildren in class UILeaf

Returns:

true if the component renders its children, false otherwise.

toString

public String toString()

Overrides:

toString in class Object