javawebparts.ajaxparts.taglib
Class AjaxManualTag

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

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

This class is a custom tag (AjaxManualTag) that emits the script necessary to set up a manual AJAX event.

Author:
Frank W. Zammetti
See Also:
Serialized Form

Field Summary
private  java.lang.String ajaxRef
          The Ajax reference ID.
private  java.lang.String function
          This is the name of the Javascript function that will be rendered that the developer manually calls to fire the AJAX event.
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
AjaxManualTag()
          Constructor.
 
Method Summary
 int doStartTag()
          Render the results of the tag.
 java.lang.String getAjaxRef()
          Returns the Ajax reference ID.
 java.lang.String getFunction()
          Returns the function field value.
 void setAjaxRef(java.lang.String inAjaxRef)
          Sets the Ajax reference ID.
 void setFunction(java.lang.String inFunction)
          Sets the function field.
 
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.


function

private java.lang.String function
This is the name of the Javascript function that will be rendered that the developer manually calls to fire the AJAX event.

Constructor Detail

AjaxManualTag

public AjaxManualTag()
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.

setFunction

public void setFunction(java.lang.String inFunction)
Sets the function field.

Parameters:
inFunction - functino.

getFunction

public java.lang.String getFunction()
Returns the function field value.

Returns:
function.

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