javawebparts.ajaxparts.taglib
Class AjaxTimerTag

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

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

This class is a custom tag (AjaxTimerTag) that emits the script necessary to set up a timed 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 frequency
          This stores the frequency in milliseconds that the AJAX event should fire.
private static org.apache.commons.logging.Log log
          Log instance.
private  java.lang.String startOnLoad
          Should the timer be started immediately upon page load, or will the developer take responsibility for kicking off a timer?
 
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
AjaxTimerTag()
          Constructor.
 
Method Summary
 int doStartTag()
          Render the results of the tag.
 java.lang.String getAjaxRef()
          Returns the Ajax reference ID.
 java.lang.String getFrequency()
          Accessor for frequency field.
 java.lang.String getStartOnLoad()
          Returns the startOnLoad field value.
 void setAjaxRef(java.lang.String inAjaxRef)
          Sets the Ajax reference ID.
 void setFrequency(java.lang.String inFrequency)
          Mutator for frequency field.
 void setStartOnLoad(java.lang.String inStartOnLoad)
          Sets the startOnLoad 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.


startOnLoad

private java.lang.String startOnLoad
Should the timer be started immediately upon page load, or will the developer take responsibility for kicking off a timer?


frequency

private java.lang.String frequency
This stores the frequency in milliseconds that the AJAX event should fire.

Constructor Detail

AjaxTimerTag

public AjaxTimerTag()
Constructor.

Method Detail

getFrequency

public java.lang.String getFrequency()
Accessor for frequency field.

Returns:
String Current value of frequency Field.

setFrequency

public void setFrequency(java.lang.String inFrequency)
Mutator for frequency field.

Parameters:
inFrequency - New value of frequency field.

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.

setStartOnLoad

public void setStartOnLoad(java.lang.String inStartOnLoad)
Sets the startOnLoad field.

Parameters:
inStartOnLoad - startOnLoad.

getStartOnLoad

public java.lang.String getStartOnLoad()
Returns the startOnLoad field value.

Returns:
startOnLoad.

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