Package com.sun.faces.taglib.html_basic

Class CommandLinkTag

java.lang.Object
jakarta.faces.webapp.UIComponentTagBase
jakarta.faces.webapp.UIComponentClassicTagBase
jakarta.faces.webapp.UIComponentELTag
com.sun.faces.taglib.html_basic.CommandLinkTag
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 CommandLinkTag
extends UIComponentELTag

  • Constructor Details

  • Method Details

    • setAction

      public void setAction​(jakarta.el.MethodExpression action)

    • setActionListener

      public void setActionListener​(jakarta.el.MethodExpression actionListener)

    • setImmediate

      public void setImmediate​(jakarta.el.ValueExpression immediate)

    • 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

      public String getRendererType()
      Description copied from class: UIComponentTagBase

      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.

      Specified by:
      getRendererType in class UIComponentTagBase
      Returns:
      the renderer type

    • getComponentType

      public String 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 the UIComponent instance for this tag. Subclasses must override this method to return the appropriate value.

      Specified by:
      getComponentType in class UIComponentTagBase
      Returns:
      the component type

    • setProperties

      protected void setProperties​(UIComponent component)
      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 the UIComponent 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 properties foo and bar 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 the rendered property is specified for this tag handler instance.
      • rendererType - Set if the getRendererType() method returns a non-null value.
      Overrides:
      setProperties in class UIComponentELTag
      Parameters:
      component - UIComponent whose properties are to be overridden

    • doStartTag

      public int doStartTag() throws jakarta.servlet.jsp.JspException
      Description 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 transient UIOutput component to be created and placed in the tree before the UIComponent instance for this tag. The value of this UIOutput component must include anything covered by CASE 1 or CASE 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 calling UIComponentClassicTagBase.createVerbatimComponentFromBodyContent() on the result. It then adds the returned component to the tree before the actual component for this tag instance instance by calling UIComponentClassicTagBase.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 interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doStartTag in class UIComponentClassicTagBase
      Throws:
      jakarta.servlet.jsp.JspException - if an error occurs

    • doEndTag

      public int doEndTag() throws jakarta.servlet.jsp.JspException
      Description 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 by UIComponentTag 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 by UIComponentTag 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 interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doEndTag in class UIComponentClassicTagBase
      Throws:
      jakarta.servlet.jsp.JspException - if an error occurs

    • release

      public void release()
      Description copied from class: UIComponentELTag

      Release any resources allocated during the execution of this tag handler.

      Specified by:
      release in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      release in class UIComponentELTag

    • getDebugString

      public String getDebugString()