Package com.aoindustries.taglib

Class ATag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

com.aoindustries.taglib.AutoEncodingBufferedBodyTag

com.aoindustries.taglib.ElementBufferedBodyTag

com.aoindustries.taglib.ATag

All Implemented Interfaces:

ClassAttribute, DataAttribute, DirAttribute, GlobalAttributes, GlobalBufferedAttributes, HrefAttribute, HreflangAttribute, IdAttribute, OnclickAttribute, OnmouseoutAttribute, OnmouseoverAttribute, ParamsAttribute, RelAttribute, StyleAttribute, TargetAttribute, TitleAttribute, TypeAttribute, Serializable, BodyTag, DynamicAttributes, IterationTag, JspTag, Tag, TryCatchFinally

public class ATag
extends ElementBufferedBodyTag
implements HrefAttribute, ParamsAttribute, HreflangAttribute, RelAttribute, TargetAttribute, TitleAttribute, TypeAttribute, OnclickAttribute, OnmouseoutAttribute, OnmouseoverAttribute

Author:

AO Industries, Inc.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.aoindustries.taglib.ElementBufferedBodyTag

global

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

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

id, pageContext

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

Constructors

Constructor	Description
ATag()

Method Summary

Modifier and Type	Method	Description
protected boolean	addDynamicAttribute(String uri, String localName, Object value, List<String> expectedPatterns)	Adds a dynamic attribute.
void	addParam(String name, String value)
protected int	doAfterBody(BufferResult capturedBody, Writer out)	While the out JspWriter is still replaced to output the proper content type, this version of AutoEncodingBufferedBodyTag.doAfterBody() is called.
protected int	doEndTag(Writer out)	While the out JspWriter is still replaced to output the proper content type, this version of AutoEncodingBufferedBodyTag.doEndTag() is called.
void	doFinally()
MediaType	getContentType()	Gets the type of data that is contained by this tag.
MediaType	getOutputType()	Gets the output type of this tag.
void	setAbsolute(boolean absolute)
void	setAddLastModified(String addLastModified)
void	setCanonical(boolean canonical)
void	setHref(String href)
void	setHreflang(Object hreflang)
void	setOnclick(Object onclick)
void	setOnmouseout(Object onmouseout)
void	setOnmouseover(Object onmouseover)
void	setRel(String rel)
void	setTarget(String target)
void	setTitle(Object title)
void	setType(String type)

Methods inherited from class com.aoindustries.taglib.ElementBufferedBodyTag

addData, getClazz, getData, getDir, getStyle, setClazz, setData, setDir, setDynamicAttribute, setId, setStyle

Methods inherited from class com.aoindustries.taglib.AutoEncodingBufferedBodyTag

doAfterBody, doCatch, doEndTag, doInitBody, doStartTag, doStartTag, getTempFileThreshold, setMediaEncoderOptions, writeEncoderPrefix, writeEncoderSuffix

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

getBodyContent, getPreviousOut, release, setBodyContent

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aoindustries.taglib.GlobalAttributes

getId

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Constructor Detail

ATag

public ATag()

Method Detail

getContentType

public MediaType getContentType()

Description copied from class: AutoEncodingBufferedBodyTag

Gets the type of data that is contained by this tag.

Specified by:

getContentType in class AutoEncodingBufferedBodyTag

getOutputType

public MediaType getOutputType()

Description copied from class: AutoEncodingBufferedBodyTag

Gets the output type of this tag. This is used to determine the correct encoder. If the tag never has any output this should return null. When null is returned, any output will result in an error.

Specified by:

getOutputType in class AutoEncodingBufferedBodyTag

setHref

public void setHref(String href)
             throws JspTagException

Specified by:

setHref in interface HrefAttribute

Throws:

JspTagException

addParam

public void addParam(String name,
                     String value)

Specified by:

addParam in interface ParamsAttribute

setAbsolute

public void setAbsolute(boolean absolute)

setCanonical

public void setCanonical(boolean canonical)

setAddLastModified

public void setAddLastModified(String addLastModified)

setHreflang

public void setHreflang(Object hreflang)
                 throws JspTagException

Specified by:

setHreflang in interface HreflangAttribute

Throws:

JspTagException

setRel

public void setRel(String rel)
            throws JspTagException

Specified by:

setRel in interface RelAttribute

Throws:

JspTagException

setTarget

public void setTarget(String target)
               throws JspTagException

Specified by:

setTarget in interface TargetAttribute

Throws:

JspTagException

setTitle

public void setTitle(Object title)
              throws JspTagException

Specified by:

setTitle in interface TitleAttribute

Throws:

JspTagException

setType

public void setType(String type)
             throws JspTagException

Specified by:

setType in interface TypeAttribute

Throws:

JspTagException

setOnclick

public void setOnclick(Object onclick)
                throws JspTagException

Specified by:

setOnclick in interface OnclickAttribute

Throws:

JspTagException

setOnmouseout

public void setOnmouseout(Object onmouseout)
                   throws JspTagException

Specified by:

setOnmouseout in interface OnmouseoutAttribute

Throws:

JspTagException

setOnmouseover

public void setOnmouseover(Object onmouseover)
                    throws JspTagException

Specified by:

setOnmouseover in interface OnmouseoverAttribute

Throws:

JspTagException

addDynamicAttribute

protected boolean addDynamicAttribute(String uri,
                                      String localName,
                                      Object value,
                                      List<String> expectedPatterns)
                               throws JspTagException

Adds a dynamic attribute.

Overrides:

addDynamicAttribute in class ElementBufferedBodyTag

Returns:

true when added, or false when attribute not expected and has not been added.

Throws:

JspTagException

See Also:

ParamUtils.addDynamicAttribute(java.lang.String, java.lang.String, java.lang.Object, java.util.List, com.aoindustries.taglib.ParamsAttribute)

doAfterBody

protected int doAfterBody(BufferResult capturedBody,
                          Writer out)

Description copied from class: AutoEncodingBufferedBodyTag

While the out JspWriter is still replaced to output the proper content type, this version of AutoEncodingBufferedBodyTag.doAfterBody() is called.

Overrides:

doAfterBody in class AutoEncodingBufferedBodyTag

out - the output. If passed-through, this will be a JspWriter

Returns:

Must return either Tag.SKIP_BODY (the default) or IterationTag.EVAL_BODY_AGAIN

doEndTag

protected int doEndTag(Writer out)
                throws JspTagException,
                       IOException

Description copied from class: AutoEncodingBufferedBodyTag

While the out JspWriter is still replaced to output the proper content type, this version of AutoEncodingBufferedBodyTag.doEndTag() is called.

Overrides:

doEndTag in class AutoEncodingBufferedBodyTag

Parameters:

out - the output. If passed-through, this will be a JspWriter

Returns:

Must return either Tag.EVAL_PAGE (the default) or Tag.SKIP_PAGE

Throws:

JspTagException

IOException

doFinally

public void doFinally()

Specified by:

doFinally in interface TryCatchFinally

Overrides:

doFinally in class ElementBufferedBodyTag