JavaEE Web API 8.0.1 · javax.faces.webapp.UIComponentTagBase

Modifier and Type	Field and Description
protected static final Logger	log

Access	Constructor and Description
public	UIComponentTagBase()

Method Summary

Modifier and Type	Method and Description
protected abstract void	addChild(UIComponent New child whose identifier should be added child) Add the component identifier of the specified `UIComponent` to the list of component identifiers created or located by nested `UIComponentTag`s processing this request.
protected abstract void	addFacet(String Facet name to be added name) Add the facet name of the specified facet to the list of facet names created or located by nested `UIComponentTag`s processing this request.
public abstract UIComponent	Returns: the component getComponentInstance() Return the `UIComponent` instance that is associated with this tag instance.
public abstract String	Returns: the component type getComponentType() Return the component type for the component that is or will be bound to this tag.
public abstract boolean	Returns: the result as specified above getCreated() Return `true` if we dynamically created a new component instance during execution of this tag.
protected ELContext	Returns: the {code ELContext} for this `FacesContext` getELContext() Return the `ELContext` for the `FacesContext` for this request.
protected abstract FacesContext	Returns: the `FacesContext` for the current request. getFacesContext() Return the `FacesContext` instance for the current request.
protected abstract int	Returns: the index getIndexOfNextChildTag() Return the index of the next child to be added as a child of this tag.
public abstract String	Returns: the renderer type getRendererType() Return the `rendererType` property that selects the `Renderer` to be used for encoding this component, or `null` to ask the component to render itself directly.
public abstract void	setId(String The new component identifier. This may not start with `javax.faces.component.UIViewRoot#UNIQUE_ID_PREFIX`. id) Set the component identifier for the component corresponding to this tag instance.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

log	back to summary
protected static final Logger log

UIComponentTagBase	back to summary
public UIComponentTagBase()

Method Detail

addChild back to summary

addChild	back to summary
protected abstract void addChild(UIComponent child) Add the component identifier of the specified `UIComponent` to the list of component identifiers created or located by nested `UIComponentTag`s processing this request. Parameters child:UIComponent New child whose identifier should be added

protected abstract void addChild(UIComponent child)

Add the component identifier of the specified UIComponent to the list of component identifiers created or located by nested UIComponentTags processing this request.

Parameters

child:UIComponent: New child whose identifier should be added

addFacet back to summary

addFacet	back to summary
protected abstract void addFacet(String name) Add the facet name of the specified facet to the list of facet names created or located by nested `UIComponentTag`s processing this request. Parameters name:String Facet name to be added

protected abstract void addFacet(String name)

Add the facet name of the specified facet to the list of facet names created or located by nested UIComponentTags processing this request.

Parameters

name:String: Facet name to be added

getComponentInstance back to summary

getComponentInstance	back to summary
public abstract UIComponent getComponentInstance() Return the `UIComponent` instance that is associated with this tag instance. This method is designed to be used by tags nested within this tag, and only returns useful results between the execution of `doStartTag()` and `doEndTag()` on this tag instance. Returns:UIComponent the component

public abstract UIComponent getComponentInstance()

Return the UIComponent instance that is associated with this tag instance. This method is designed to be used by tags nested within this tag, and only returns useful results between the execution of doStartTag() and doEndTag() on this tag instance.

Returns:UIComponent: the component

getComponentType back to summary

getComponentType	back to summary
public abstract String getComponentType() Return the component type for the component that is or will be bound to this tag. This value can be passed to `javax.faces.application.Application#createComponent` to create the `UIComponent` instance for this tag. Subclasses must override this method to return the appropriate value. Returns:String the component type

public abstract String getComponentType()

Return the component type for the component that is or will be bound to this tag. This value can be passed to javax.faces.application.Application#createComponent to create the UIComponent instance for this tag. Subclasses must override this method to return the appropriate value.

Returns:String: the component type

getCreated back to summary

getCreated	back to summary
public abstract boolean getCreated() Return `true` if we dynamically created a new component instance during execution of this tag. This method is designed to be used by tags nested within this tag, and only returns useful results between the execution of `doStartTag()` and `doEndTag()` on this tag instance. Returns:boolean the result as specified above

public abstract boolean getCreated()

Return true if we dynamically created a new component instance during execution of this tag. This method is designed to be used by tags nested within this tag, and only returns useful results between the execution of doStartTag() and doEndTag() on this tag instance.

Returns:boolean: the result as specified above

getELContext back to summary

getELContext	back to summary
protected ELContext getELContext() Return the `ELContext` for the `FacesContext` for this request. This is a convenience for `getFacesContext().getELContext()`. Returns:ELContext the {code ELContext} for this `FacesContext`

protected ELContext getELContext()

Return the ELContext for the FacesContext for this request.

This is a convenience for getFacesContext().getELContext().

Returns:ELContext: the {code ELContext} for this FacesContext

getFacesContext back to summary

getFacesContext	back to summary
protected abstract FacesContext getFacesContext() Return the `FacesContext` instance for the current request. This value will be non-`null` only from the beginning of `doStartTag()` through the end of `doEndTag()` for each tag instance. Returns:FacesContext the `FacesContext` for the current request.

protected abstract FacesContext getFacesContext()

Return the FacesContext instance for the current request. This value will be non-null only from the beginning of doStartTag() through the end of doEndTag() for each tag instance.

Returns:FacesContext: the FacesContext for the current request.

getIndexOfNextChildTag	back to summary
protected abstract int getIndexOfNextChildTag() Return the index of the next child to be added as a child of this tag. The default implementation maintains a list of created components and returns the size of the list. Returns:int the index

getIndexOfNextChildTag

back to summary

protected abstract int getIndexOfNextChildTag()

Return the index of the next child to be added as a child of this tag. The default implementation maintains a list of created components and returns the size of the list.

Returns:int: the index

getRendererType back to summary

getRendererType	back to summary
public abstract String getRendererType() Return the `rendererType` property that selects the `Renderer` to be used for encoding this component, or `null` to ask the component to render itself directly. Subclasses must override this method to return the appropriate value. Returns:String the renderer type

public abstract String getRendererType()

Return the rendererType property that selects the Renderer to be used for encoding this component, or null to ask the component to render itself directly. Subclasses must override this method to return the appropriate value.

Returns:String: the renderer type

setId back to summary

setId	back to summary
public abstract void setId(String id) Set the component identifier for the component corresponding to this tag instance. If the argument begins with `javax.faces.component.UIViewRoot#UNIQUE_ID_PREFIX` throw an `IllegalArgumentException` Parameters id:String The new component identifier. This may not start with `javax.faces.component.UIViewRoot#UNIQUE_ID_PREFIX`. Exceptions IllegalArgumentException: if the argument is non-`null` and starts with `javax.faces.component.UIViewRoot#UNIQUE_ID_PREFIX`.

public abstract void setId(String id)

Set the component identifier for the component corresponding to this tag instance. If the argument begins with javax.faces.component.UIViewRoot#UNIQUE_ID_PREFIX throw an IllegalArgumentException

Parameters

id:String: The new component identifier. This may not start with javax.faces.component.UIViewRoot#UNIQUE_ID_PREFIX.

Exceptions

IllegalArgumentException:: if the argument is non-null and starts with javax.faces.component.UIViewRoot#UNIQUE_ID_PREFIX.

public abstract Class UIComponentTagBase

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail