javawebparts.ajaxparts.taglib
Class AjaxEventTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--javawebparts.ajaxparts.taglib.AjaxEventTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class AjaxEventTag
extends javax.servlet.jsp.tagext.TagSupport

This class is a custom tag (AjaxEventTag) that emits the small script element following an element to be Ajax-enabled. This script it emits will create a tag that will be something of an "anchor" that will later be used to attach AJAX code to the target element.

Author:
Frank W. Zammetti
See Also:
Serialized Form

Field Summary
private  java.lang.String ajaxRef
          The Ajax reference ID.
private  java.lang.String attachTo
          The DOM ID of the element to attach the event to.
private static org.apache.commons.logging.Log log
          Log instance.
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
AjaxEventTag()
          Constructor.
 
Method Summary
 int doStartTag()
          Render the results of the tag.
 java.lang.String getAjaxRef()
          Returns the Ajax reference ID.
 java.lang.String getAttachTo()
          Returns the DOM ID to attach to.
 void setAjaxRef(java.lang.String inAjaxRef)
          Sets the Ajax reference ID.
 void setAttachTo(java.lang.String inAttachTo)
          Sets the DOM ID to attach to.
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

private static org.apache.commons.logging.Log log
Log instance.


ajaxRef

private java.lang.String ajaxRef
The Ajax reference ID.


attachTo

private java.lang.String attachTo
The DOM ID of the element to attach the event to.

Constructor Detail

AjaxEventTag

public AjaxEventTag()
Constructor.

Method Detail

setAjaxRef

public void setAjaxRef(java.lang.String inAjaxRef)
Sets the Ajax reference ID.

Parameters:
inAjaxRef - ajaxRef.

getAjaxRef

public java.lang.String getAjaxRef()
Returns the Ajax reference ID.

Returns:
ajaxRef.

setAttachTo

public void setAttachTo(java.lang.String inAttachTo)
Sets the DOM ID to attach to.

Parameters:
inAttachTo - attachTo.

getAttachTo

public java.lang.String getAttachTo()
Returns the DOM ID to attach to.

Returns:
attachTo.

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
Render the results of the tag.

Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class javax.servlet.jsp.tagext.TagSupport
Returns:
Return code.
Throws:
javax.servlet.jsp.JspException - If anything goes wrong


Copyright 2005 Frank W. Zammetti