com.cc.framework.taglib.base
Class AjaxTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      com.cc.framework.taglib.base.AjaxTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class AjaxTag

extends javax.servlet.jsp.tagext.TagSupport

AJAX Tag

Author:

Harald Schulz

See Also:

Serialized Form

Field Summary

private java.lang.String	onajaxerror Error JavaScript handler
private java.lang.String	onajaxsuccess Success JavaScript handler
private java.lang.String	onajaxtimeout Timeout JavaScript handler
private static long	serialVersionUID Serial Version UID
private int	timeout The AJAX timeout in milliseconds

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

AjaxTag()

Method Summary

protected AjaxSettings	createSettings()
int	doAfterBody()
int	doEndTag()
int	doStartTag()
void	release()
protected void	reset()
void	setOnajaxerror(java.lang.String handler) A function reference assigned will be called after onComplete, if the statusCode !
void	setOnajaxsuccess(java.lang.String handler) A function reference assigned will be called after onComplete, if the statusCode=200
void	setOnajaxtimeout(java.lang.String handler) If a timeout period is set, and it is reached before a response is received, a function reference assigned to onTimeout will be called
void	setPageContext(javax.servlet.jsp.PageContext pc)
void	setTimeout(java.lang.String millis) Sets the AJAX timeout in milliseconds

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setParent, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial Version UID

See Also:

Constant Field Values

timeout

private int timeout

The AJAX timeout in milliseconds

onajaxtimeout

private java.lang.String onajaxtimeout

Timeout JavaScript handler

onajaxsuccess

private java.lang.String onajaxsuccess

Success JavaScript handler

onajaxerror

private java.lang.String onajaxerror

Error JavaScript handler

Constructor Detail

AjaxTag

public AjaxTag()

Method Detail

release

public void release()

See Also:

Tag.release()

setPageContext

public void setPageContext(javax.servlet.jsp.PageContext pc)

See Also:

Tag.setPageContext(PageContext pc)

reset

protected void reset()

createSettings

protected AjaxSettings createSettings()

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Throws:

javax.servlet.jsp.JspException

See Also:

TagSupport.doStartTag()

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspException

Throws:

javax.servlet.jsp.JspException

See Also:

TagSupport.doAfterBody()

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Throws:

javax.servlet.jsp.JspException

See Also:

TagSupport.doEndTag()

setTimeout

public void setTimeout(java.lang.String millis)
                throws javax.servlet.jsp.JspException

Sets the AJAX timeout in milliseconds

Parameters:

millis - time in milliseconds

Throws:

javax.servlet.jsp.JspException

setOnajaxtimeout

public void setOnajaxtimeout(java.lang.String handler)

If a timeout period is set, and it is reached before a response is received, a function reference assigned to onTimeout will be called

Parameters:

handler - The JavaScript event handler

setOnajaxsuccess

public void setOnajaxsuccess(java.lang.String handler)

A function reference assigned will be called after onComplete, if the statusCode=200

Parameters:

handler - The JavaScript event handler

setOnajaxerror

public void setOnajaxerror(java.lang.String handler)

A function reference assigned will be called after onComplete, if the statusCode != 200

Parameters:

handler - The JavaScript event handler