Class EventHandler

java.lang.Object
javax.faces.view.facelets.TagHandler
javax.faces.view.facelets.MetaTagHandler
javax.faces.view.facelets.DelegatingMetaTagHandler
javax.faces.view.facelets.ComponentHandler
org.apache.myfaces.tobago.facelets.TobagoComponentHandler
org.apache.myfaces.tobago.facelets.EventHandler
All Implemented Interfaces:
javax.faces.view.AttachedObjectHandler, javax.faces.view.BehaviorHolderAttachedObjectHandler, javax.faces.view.facelets.FaceletHandler

public class EventHandler extends TobagoComponentHandler implements javax.faces.view.BehaviorHolderAttachedObjectHandler
This tag creates an instance of AjaxBehavior, and associates it with the nearest parent UIComponent that implements ClientBehaviorHolder interface. This tag can be used on single or composite components.

Unless otherwise specified, all attributes accept static values or EL expressions.

According to the documentation, the tag handler implementing this tag should meet the following conditions:

  • Since this tag attach objects to UIComponent instances, and those instances implements Behavior interface, this component should implement BehaviorHolderAttachedObjectHandler interface.
  • f:ajax does not support binding property. In theory we should do something similar to f:convertDateTime tag does: extends from ConverterHandler and override setAttributes method, but in this case BehaviorTagHandlerDelegate has binding property defined, so if we extend from BehaviorHandler we add binding support to f:ajax.
  • This tag works as a attached object handler, but note on the api there is no component to define a target for a behavior. See comment inside apply() method.
Since:
3.0.0
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Wraps a method expression in a AjaxBehaviorListener
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Class<?>[]
     

    Fields inherited from class javax.faces.view.facelets.DelegatingMetaTagHandler

    delegateFactory

    Fields inherited from class javax.faces.view.facelets.TagHandler

    nextHandler, tag, tagId
  • Constructor Summary

    Constructors
    Constructor
    Description
    EventHandler(javax.faces.view.facelets.ComponentConfig config)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    apply(javax.faces.view.facelets.FaceletContext ctx, javax.faces.component.UIComponent parent)
     
    void
    applyAttachedObject(javax.faces.context.FacesContext context, javax.faces.component.UIComponent parent)
    This method should create an AjaxBehavior object and attach it to the parent component.
    protected EventBehavior
    createBehavior(javax.faces.context.FacesContext context)
     
    ViewDeclarationLanguage.retargetAttachedObjects uses it to check if the the target to be processed is applicable for this handler
    The documentation says this attribute should not be used since it is not taken into account.
    void
    onComponentCreated(javax.faces.view.facelets.FaceletContext faceletContext, javax.faces.component.UIComponent component, javax.faces.component.UIComponent parent)
     

    Methods inherited from class org.apache.myfaces.tobago.facelets.TobagoComponentHandler

    createMetaRuleset, onComponentPopulated

    Methods inherited from class javax.faces.view.facelets.ComponentHandler

    createComponent, getComponentConfig, getTagHandlerDelegate, isNew

    Methods inherited from class javax.faces.view.facelets.DelegatingMetaTagHandler

    applyNextHandler, getBinding, getTag, getTagAttribute, getTagId, isDisabled, setAttributes

    Methods inherited from class javax.faces.view.facelets.TagHandler

    getAttribute, getRequiredAttribute, toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

    • AJAX_BEHAVIOR_LISTENER_SIG

      public static final Class<?>[] AJAX_BEHAVIOR_LISTENER_SIG
  • Constructor Details

    • EventHandler

      public EventHandler(javax.faces.view.facelets.ComponentConfig config)
  • Method Details

    • apply

      public void apply(javax.faces.view.facelets.FaceletContext ctx, javax.faces.component.UIComponent parent) throws IOException
      Specified by:
      apply in interface javax.faces.view.facelets.FaceletHandler
      Overrides:
      apply in class javax.faces.view.facelets.DelegatingMetaTagHandler
      Throws:
      IOException
    • getEventName

      public String getEventName()
      ViewDeclarationLanguage.retargetAttachedObjects uses it to check if the the target to be processed is applicable for this handler
      Specified by:
      getEventName in interface javax.faces.view.BehaviorHolderAttachedObjectHandler
    • applyAttachedObject

      public void applyAttachedObject(javax.faces.context.FacesContext context, javax.faces.component.UIComponent parent)
      This method should create an AjaxBehavior object and attach it to the parent component.

      Also, it should check if the parent can apply the selected AjaxBehavior to the selected component through ClientBehaviorHolder.getEventNames() or ClientBehaviorHolder.getDefaultEventName()

      Specified by:
      applyAttachedObject in interface javax.faces.view.AttachedObjectHandler
    • createBehavior

      protected EventBehavior createBehavior(javax.faces.context.FacesContext context)
    • onComponentCreated

      public void onComponentCreated(javax.faces.view.facelets.FaceletContext faceletContext, javax.faces.component.UIComponent component, javax.faces.component.UIComponent parent)
      Overrides:
      onComponentCreated in class javax.faces.view.facelets.ComponentHandler
    • getFor

      public String getFor()
      The documentation says this attribute should not be used since it is not taken into account. Instead, getEventName is used on ViewDeclarationLanguage.retargetAttachedObjects.
      Specified by:
      getFor in interface javax.faces.view.AttachedObjectHandler