org.milyn.tinak
Class UATag

java.lang.Object
  org.milyn.tinak.UATag

All Implemented Interfaces:

javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.Tag

public class UATag

extends java.lang.Object

implements javax.servlet.jsp.tagext.BodyTag

The ua tag is a means of selecting or deselecting content based on the accessing useragents common name or membership of a profile.

Author:

Tom Fennelly

Field Summary

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

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

UATag()

Method Summary

int	doAfterBody() Process the doAfterBody event.
int	doEndTag() Process the doEnd event.
void	doInitBody() Process the doInitBody event.
int	doStartTag() Process the doStart event.
javax.servlet.jsp.tagext.Tag	getParent() Get the tag parent tag.
void	release() Process the release event.
void	setBodyContent(javax.servlet.jsp.tagext.BodyContent bodyContent) Set the body content
void	setDir(java.lang.String directive) Bean method for setting the directive attribute ("dir") value from the page.
void	setMatch(java.lang.String match) Bean method for setting the match attribute ("match") value from the page.
void	setPageContext(javax.servlet.jsp.PageContext context) Set the page context.
void	setParent(javax.servlet.jsp.tagext.Tag tag) Set the tag parent tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

UATag

public UATag()

Method Detail

setPageContext

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

Set the page context.

Called by the container.

Specified by:

setPageContext in interface javax.servlet.jsp.tagext.Tag

Parameters:

context - The page context.

setParent

public void setParent(javax.servlet.jsp.tagext.Tag tag)

Set the tag parent tag.

Called by the container.

Specified by:

setParent in interface javax.servlet.jsp.tagext.Tag

Parameters:

tag - The tag parent tag.

getParent

public javax.servlet.jsp.tagext.Tag getParent()

Get the tag parent tag.

Specified by:

getParent in interface javax.servlet.jsp.tagext.Tag

Returns:

The tag parent tag.

doStartTag

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

Process the doStart event.

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Returns:

One of Tag.SKIP_BODY, Tag.EVAL_BODY_INCLUDE or BodyTag.EVAL_BODY_BUFFERED

Throws:

javax.servlet.jsp.JspException

setBodyContent

public void setBodyContent(javax.servlet.jsp.tagext.BodyContent bodyContent)

Set the body content

Specified by:

setBodyContent in interface javax.servlet.jsp.tagext.BodyTag

Parameters:

bodyContent - The tag body content.

doInitBody

public void doInitBody()
                throws javax.servlet.jsp.JspException

Process the doInitBody event.

Specified by:

doInitBody in interface javax.servlet.jsp.tagext.BodyTag

Throws:

javax.servlet.jsp.JspException

doAfterBody

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

Process the doAfterBody event.

Specified by:

doAfterBody in interface javax.servlet.jsp.tagext.IterationTag

Returns:

Tag.SKIP_BODY

Throws:

javax.servlet.jsp.JspException

doEndTag

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

Process the doEnd event.

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Returns:

One of Tag.SKIP_BODY, Tag.EVAL_BODY_INCLUDE, Tag.SKIP_PAGE, Tag.EVAL_PAGE

Throws:

javax.servlet.jsp.JspException

setMatch

public void setMatch(java.lang.String match)

Bean method for setting the match attribute ("match") value from the page.

A match value of 'first' is used to select the first nested ua tag which evaluates a match positively.

Parameters:

match - The match value.

setDir

public void setDir(java.lang.String directive)

Bean method for setting the directive attribute ("dir") value from the page.

Parameters:

directive - The "dir" attribute value.

release

public void release()

Process the release event.

Specified by:

release in interface javax.servlet.jsp.tagext.Tag