|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.webapp.TestComponent
public class TestComponent
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 UIComponent s 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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TestComponent()
public TestComponent(java.lang.String id)
Method Detail |
---|
public java.lang.String getFamily()
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.
getFamily
in class UIComponent
public java.lang.String getLabel()
public void setLabel(java.lang.String label)
public boolean getRendersChildren()
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)
.
getRendersChildren
in class UIComponentBase
public void setRendersChildren(boolean rendersChildren)
public void encodeBegin(FacesContext context) throws java.io.IOException
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 extends javax.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(javax.faces.context.FacesContext,javax.faces.component.UIComponent)
and return immediately.
encodeBegin
in class UIComponentBase
context
- FacesContext
for the response we are creating
java.io.IOException
- if an input/output error occurs while renderingpublic void encodeChildren(FacesContext context) throws java.io.IOException
UIComponent
If our rendered
property is true
,
render the child UIComponent
s 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)
.
encodeChildren
in class UIComponentBase
context
- FacesContext
for the response we are creating
java.io.IOException
- if an input/output error occurs while renderingpublic void encodeEnd(FacesContext context) throws java.io.IOException
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.
encodeEnd
in class UIComponentBase
context
- FacesContext
for the response we are creating
java.io.IOException
- if an input/output error occurs while rendering
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |