public abstract class UIXComponentELTag
extends javax.faces.webapp.UIComponentELTag
Modifier and Type | Class and Description |
---|---|
protected static class |
UIXComponentELTag.CheckExecutionResult |
Modifier and Type | Field and Description |
---|---|
static String |
DOCUMENT_CREATED_KEY
Deprecated.
Not used any more in the session state manager
|
bodyContent, pageContext, UNIQUE_ID_PREFIX
Constructor and Description |
---|
UIXComponentELTag() |
Modifier and Type | Method and Description |
---|---|
UIXComponentELTag.CheckExecutionResult |
checkChildTagExecution(javax.faces.component.UIComponent childComponent)
Allows a child tag to check if its children should be executed based on the grand-parent.
|
protected UIXComponentELTag.CheckExecutionResult |
checkChildTagExecution(javax.faces.webapp.UIComponentELTag childTag,
String facetName)
Check if a child component tag should execute or not.
|
protected javax.faces.component.UIComponent |
createComponent(javax.faces.context.FacesContext context,
String newId)
When within a component binding context, the component bindings (stored in backing bean)
will be cleared so a new component instance can be created.
|
int |
doEndTag() |
int |
doStartTag() |
protected boolean |
isProcessingStampingComponentTag()
Check if a tag that creates components that stamp their children (tag that creates a component
that stamps out its contents, potentially rendering the children multiple times)
is currently executing (between doStartTag and doEndTag).
|
protected boolean |
isStampingTag()
Check if this tag is a stamping tag (tag that creates a component that stamps out its
contents, potentially rendering the children multiple times).
|
void |
release() |
void |
setAttributeChangeListener(javax.el.MethodExpression attributeChangeListener) |
void |
setBinding(javax.el.ValueExpression valueExpression) |
protected void |
setDateProperty(FacesBean bean,
PropertyKey key,
javax.el.ValueExpression expression)
Set a property of type java.util.Date.
|
protected void |
setIntArrayProperty(FacesBean bean,
PropertyKey key,
javax.el.ValueExpression expression)
Set a property of type int[].
|
protected void |
setMaxDateProperty(FacesBean bean,
PropertyKey key,
javax.el.ValueExpression expression)
Set a property of type java.util.Date.
|
protected void |
setNumberProperty(FacesBean bean,
PropertyKey key,
javax.el.ValueExpression expression)
Set a property of type java.lang.Number.
|
protected void |
setProperties(FacesBean bean) |
protected void |
setProperties(javax.faces.component.UIComponent component) |
protected void |
setProperty(FacesBean bean,
PropertyKey key,
javax.el.ValueExpression expression) |
protected void |
setStringArrayProperty(FacesBean bean,
PropertyKey key,
javax.el.ValueExpression expression)
Set a property of type java.lang.String[].
|
protected void |
setStringListProperty(FacesBean bean,
PropertyKey key,
javax.el.ValueExpression expression)
Set a property of type java.util.List<java.lang.String>.
|
protected void |
setStringSetProperty(FacesBean bean,
PropertyKey key,
javax.el.ValueExpression expression)
Set a property of type java.util.Set<java.lang.String>.
|
protected void |
setValidationError(String validationError)
Sets any fatal validation error that could have happened during property
setting.
|
getELContext, hasBinding, setRendered
addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doInitBody, encodeBegin, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getDoStartValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, setupResponseWriter
getComponentType, getRendererType
@Deprecated public static final String DOCUMENT_CREATED_KEY
public void setAttributeChangeListener(javax.el.MethodExpression attributeChangeListener)
public int doStartTag() throws javax.servlet.jsp.JspException
doStartTag
in interface javax.servlet.jsp.tagext.Tag
doStartTag
in class javax.faces.webapp.UIComponentClassicTagBase
javax.servlet.jsp.JspException
public int doEndTag() throws javax.servlet.jsp.JspException
doEndTag
in interface javax.servlet.jsp.tagext.Tag
doEndTag
in class javax.faces.webapp.UIComponentClassicTagBase
javax.servlet.jsp.JspException
protected boolean isProcessingStampingComponentTag()
protected boolean isStampingTag()
protected UIXComponentELTag.CheckExecutionResult checkChildTagExecution(javax.faces.webapp.UIComponentELTag childTag, String facetName)
Called from the doStartTag of the child tag to see if the parent tag wishes to prevent the execution of the child tag. This is called before the child tag creates its component.
This may be overridden by a tag to check if a child tag's body should be executed. The framework will call this method when the child tag is executing.
If inside of a stamping container this code is not executed as component state may change per stamp and therefore the tag will not have access to that state since the component does not stamp during tag execution. Therefore, it is best to avoid trying to defer child execution when component state is not known.
This method is called by the framework where the checkChildTagExecution(UIComponent)
function is called by sub-classes of UIXComponentELTag
.
childTag
- The child tagfacetName
- The facet, if any, for the child tagprotected javax.faces.component.UIComponent createComponent(javax.faces.context.FacesContext context, String newId) throws javax.servlet.jsp.JspException
createComponent
in class javax.faces.webapp.UIComponentELTag
context
- FacesContext instancenewId
- id for the componentjavax.servlet.jsp.JspException
public void release()
release
in interface javax.servlet.jsp.tagext.Tag
release
in class javax.faces.webapp.UIComponentELTag
public UIXComponentELTag.CheckExecutionResult checkChildTagExecution(javax.faces.component.UIComponent childComponent)
This method is not called by the framework, but may be called by a child tag on the parent tag. The parent tag should override this method to determine if a child tag should execute its children tags. In the above example, the show detail item tag should call this method on the panelTabbed tag to see if the show detail item's children tags should be executed.
This method is called by sub-classes and is not called by the framework at any time.
The framework will invoke the checkChildTagExecution(UIComponentELTag, String)
method during the execution of the start tag.
childComponent
- The child componentprotected final void setProperties(javax.faces.component.UIComponent component)
setProperties
in class javax.faces.webapp.UIComponentELTag
protected void setProperty(FacesBean bean, PropertyKey key, javax.el.ValueExpression expression)
protected void setStringArrayProperty(FacesBean bean, PropertyKey key, javax.el.ValueExpression expression)
protected void setStringListProperty(FacesBean bean, PropertyKey key, javax.el.ValueExpression expression)
protected void setStringSetProperty(FacesBean bean, PropertyKey key, javax.el.ValueExpression expression)
protected void setNumberProperty(FacesBean bean, PropertyKey key, javax.el.ValueExpression expression)
protected void setIntArrayProperty(FacesBean bean, PropertyKey key, javax.el.ValueExpression expression)
public void setBinding(javax.el.ValueExpression valueExpression) throws javax.servlet.jsp.JspException
setBinding
in class javax.faces.webapp.UIComponentELTag
javax.servlet.jsp.JspException
protected void setDateProperty(FacesBean bean, PropertyKey key, javax.el.ValueExpression expression)
protected void setMaxDateProperty(FacesBean bean, PropertyKey key, javax.el.ValueExpression expression)
protected void setProperties(FacesBean bean)
protected void setValidationError(String validationError)
validationError
- Copyright © 2001-2017 The Apache Software Foundation. All Rights Reserved.