Class OutputLinkTag
- All Implemented Interfaces:
jakarta.servlet.jsp.tagext.BodyTag
,jakarta.servlet.jsp.tagext.IterationTag
,jakarta.servlet.jsp.tagext.JspIdConsumer
,jakarta.servlet.jsp.tagext.JspTag
,jakarta.servlet.jsp.tagext.Tag
public class OutputLinkTag extends UIComponentELTag
-
Field Summary
Fields inherited from class jakarta.faces.webapp.UIComponentClassicTagBase
bodyContent, pageContext, UNIQUE_ID_PREFIX
-
Constructor Summary
Constructors Constructor Description OutputLinkTag()
-
Method Summary
Modifier and Type Method Description int
doEndTag()
Perform any processing necessary to handle the content implications of CASE 3 in the class description.int
doStartTag()
Perform any processing necessary to find (or create) theUIComponent
instance in the view corresponding to this tag instance in the page and, if and only if a component was created, insert it into the tree at the proper location as expected by the page author.String
getComponentType()
Return the component type for the component that is or will be bound to this tag.String
getDebugString()
String
getRendererType()
Return therendererType
property that selects theRenderer
to be used for encoding this component, ornull
to ask the component to render itself directly.void
release()
Release any resources allocated during the execution of this tag handler.void
setAccesskey(jakarta.el.ValueExpression accesskey)
void
setCharset(jakarta.el.ValueExpression charset)
void
setConverter(jakarta.el.ValueExpression converter)
void
setCoords(jakarta.el.ValueExpression coords)
void
setDir(jakarta.el.ValueExpression dir)
void
setDisabled(jakarta.el.ValueExpression disabled)
void
setHreflang(jakarta.el.ValueExpression hreflang)
void
setLang(jakarta.el.ValueExpression lang)
void
setOnblur(jakarta.el.ValueExpression onblur)
void
setOnclick(jakarta.el.ValueExpression onclick)
void
setOndblclick(jakarta.el.ValueExpression ondblclick)
void
setOnfocus(jakarta.el.ValueExpression onfocus)
void
setOnkeydown(jakarta.el.ValueExpression onkeydown)
void
setOnkeypress(jakarta.el.ValueExpression onkeypress)
void
setOnkeyup(jakarta.el.ValueExpression onkeyup)
void
setOnmousedown(jakarta.el.ValueExpression onmousedown)
void
setOnmousemove(jakarta.el.ValueExpression onmousemove)
void
setOnmouseout(jakarta.el.ValueExpression onmouseout)
void
setOnmouseover(jakarta.el.ValueExpression onmouseover)
void
setOnmouseup(jakarta.el.ValueExpression onmouseup)
protected void
setProperties(UIComponent component)
Override properties and attributes of the specified component, if the corresponding properties of this tag handler instance were explicitly set.void
setRel(jakarta.el.ValueExpression rel)
void
setRev(jakarta.el.ValueExpression rev)
void
setRole(jakarta.el.ValueExpression role)
void
setShape(jakarta.el.ValueExpression shape)
void
setStyle(jakarta.el.ValueExpression style)
void
setStyleClass(jakarta.el.ValueExpression styleClass)
void
setTabindex(jakarta.el.ValueExpression tabindex)
void
setTarget(jakarta.el.ValueExpression target)
void
setTitle(jakarta.el.ValueExpression title)
void
setType(jakarta.el.ValueExpression type)
void
setValue(jakarta.el.ValueExpression value)
Methods inherited from class jakarta.faces.webapp.UIComponentELTag
createComponent, getELContext, hasBinding, setBinding, setRendered
Methods inherited from class jakarta.faces.webapp.UIComponentClassicTagBase
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
-
Constructor Details
-
OutputLinkTag
public OutputLinkTag()
-
-
Method Details
-
setConverter
public void setConverter(jakarta.el.ValueExpression converter) -
setValue
public void setValue(jakarta.el.ValueExpression value) -
setAccesskey
public void setAccesskey(jakarta.el.ValueExpression accesskey) -
setCharset
public void setCharset(jakarta.el.ValueExpression charset) -
setCoords
public void setCoords(jakarta.el.ValueExpression coords) -
setDir
public void setDir(jakarta.el.ValueExpression dir) -
setDisabled
public void setDisabled(jakarta.el.ValueExpression disabled) -
setHreflang
public void setHreflang(jakarta.el.ValueExpression hreflang) -
setLang
public void setLang(jakarta.el.ValueExpression lang) -
setOnblur
public void setOnblur(jakarta.el.ValueExpression onblur) -
setOnclick
public void setOnclick(jakarta.el.ValueExpression onclick) -
setOndblclick
public void setOndblclick(jakarta.el.ValueExpression ondblclick) -
setOnfocus
public void setOnfocus(jakarta.el.ValueExpression onfocus) -
setOnkeydown
public void setOnkeydown(jakarta.el.ValueExpression onkeydown) -
setOnkeypress
public void setOnkeypress(jakarta.el.ValueExpression onkeypress) -
setOnkeyup
public void setOnkeyup(jakarta.el.ValueExpression onkeyup) -
setOnmousedown
public void setOnmousedown(jakarta.el.ValueExpression onmousedown) -
setOnmousemove
public void setOnmousemove(jakarta.el.ValueExpression onmousemove) -
setOnmouseout
public void setOnmouseout(jakarta.el.ValueExpression onmouseout) -
setOnmouseover
public void setOnmouseover(jakarta.el.ValueExpression onmouseover) -
setOnmouseup
public void setOnmouseup(jakarta.el.ValueExpression onmouseup) -
setRel
public void setRel(jakarta.el.ValueExpression rel) -
setRev
public void setRev(jakarta.el.ValueExpression rev) -
setRole
public void setRole(jakarta.el.ValueExpression role) -
setShape
public void setShape(jakarta.el.ValueExpression shape) -
setStyle
public void setStyle(jakarta.el.ValueExpression style) -
setStyleClass
public void setStyleClass(jakarta.el.ValueExpression styleClass) -
setTabindex
public void setTabindex(jakarta.el.ValueExpression tabindex) -
setTarget
public void setTarget(jakarta.el.ValueExpression target) -
setTitle
public void setTitle(jakarta.el.ValueExpression title) -
setType
public void setType(jakarta.el.ValueExpression type) -
getRendererType
Description copied from class:UIComponentTagBase
Return the
rendererType
property that selects theRenderer
to be used for encoding this component, ornull
to ask the component to render itself directly. Subclasses must override this method to return the appropriate value.- Specified by:
getRendererType
in classUIComponentTagBase
- Returns:
- the renderer type
-
getComponentType
Description copied from class:UIComponentTagBase
Return the component type for the component that is or will be bound to this tag. This value can be passed to
Application.createComponent(java.lang.String)
to create theUIComponent
instance for this tag. Subclasses must override this method to return the appropriate value.- Specified by:
getComponentType
in classUIComponentTagBase
- Returns:
- the component type
-
setProperties
Description copied from class:UIComponentELTag
Override properties and attributes of the specified component, if the corresponding properties of this tag handler instance were explicitly set. This method must be called ONLY if the specified
UIComponent
was in fact created during the execution of this tag handler instance, and this call will occur BEFORE theUIComponent
is added to the view.Tag subclasses that want to support additional set properties must ensure that the base class
setProperties()
method is still called. A typical implementation that supports extra propertiesfoo
andbar
would look something like this:protected void setProperties(UIComponent component) { super.setProperties(component); if (foo != null) { component.setAttribute("foo", foo); } if (bar != null) { component.setAttribute("bar", bar); } }
The default implementation overrides the following properties:
rendered
- Set if a value for therendered
property is specified for this tag handler instance.rendererType
- Set if thegetRendererType()
method returns a non-null value.
- Overrides:
setProperties
in classUIComponentELTag
- Parameters:
component
-UIComponent
whose properties are to be overridden
-
doStartTag
public int doStartTag() throws jakarta.servlet.jsp.JspExceptionDescription copied from class:UIComponentClassicTagBase
Perform any processing necessary to find (or create) the
UIComponent
instance in the view corresponding to this tag instance in the page and, if and only if a component was created, insert it into the tree at the proper location as expected by the page author. Secondarily, cause a transientUIOutput
component to be created and placed in the tree before theUIComponent
instance for this tag. The value of thisUIOutput
component must include anything covered byCASE 1
orCASE 2
in the class description.The default implementation, which is intended to be sufficient for most components, implements this secondary requirement by calling
UIComponentClassicTagBase.getParentUIComponentClassicTagBase(jakarta.servlet.jsp.PageContext)
, and callingUIComponentClassicTagBase.createVerbatimComponentFromBodyContent()
on the result. It then adds the returned component to the tree before the actual component for this tag instance instance by callingUIComponentClassicTagBase.addVerbatimBeforeComponent(jakarta.faces.webapp.UIComponentClassicTagBase, jakarta.faces.component.UIComponent, jakarta.faces.component.UIComponent)
.Before returning, the component is pushed onto the component stack for this response to enable the
UIComponentClassicTagBase.getParentUIComponentClassicTagBase(jakarta.servlet.jsp.PageContext)
method to work properly.The flag value to be returned is acquired by calling the
getDoStartValue()
method, which tag subclasses may override if they do not want the default value.- Specified by:
doStartTag
in interfacejakarta.servlet.jsp.tagext.Tag
- Overrides:
doStartTag
in classUIComponentClassicTagBase
- Throws:
jakarta.servlet.jsp.JspException
- if an error occurs
-
doEndTag
public int doEndTag() throws jakarta.servlet.jsp.JspExceptionDescription copied from class:UIComponentClassicTagBase
Perform any processing necessary to handle the content implications of CASE 3 in the class description.
The default implementation, which is intended to be sufficient for most components, calls
UIComponentClassicTagBase.createVerbatimComponentFromBodyContent()
on this instance and adds it as a child of the component for this tag's component at the end of the child list. In addition, the following housekeeping steps are taken.- Retrieve from the
UIComponent
the set of component ids of child components created byUIComponentTag
instances the last time this page was processed (if any). Compare it to the list of children created during this page processing pass, and remove all children present in the old list but not the new. Save the new list as a component attribute so that it gets saved as part of the component's state. - Retrieve from the
UIComponent
the set of facet names of facets created byUIComponentTag
instances the last time this page was processed (if any). Compare it to the list of facets created during this page processing pass, and remove all facets present in the old list but not the new. Save the new list as a component attribute so that it gets saved as part of the component's state. - Release all references to the component, and pop it from the component stack for this response, removing the stack if this was the outermost component.
The flag value to be returned is acquired by calling the
getDoEndValue()
method, which tag subclasses may override if they do not want the default value.- Specified by:
doEndTag
in interfacejakarta.servlet.jsp.tagext.Tag
- Overrides:
doEndTag
in classUIComponentClassicTagBase
- Throws:
jakarta.servlet.jsp.JspException
- if an error occurs
- Retrieve from the
-
release
public void release()Description copied from class:UIComponentELTag
Release any resources allocated during the execution of this tag handler.
- Specified by:
release
in interfacejakarta.servlet.jsp.tagext.Tag
- Overrides:
release
in classUIComponentELTag
-
getDebugString
-