bradleyross.j2ee.tags

Class CenterTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

bradleyross.j2ee.tags.CenterTag

All Implemented Interfaces:

Serializable, IterationTag, JspTag, Tag

public class CenterTag
extends TagSupport

This custom tag can be used to center an object on the web page horizontally.

By using optional attributes, it can also position the element against the left or right border and can provide the material with a class that can be referenced by the CSS style sheet.

Author:

Bradley Ross

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	align Value of the attribute align for the custom tag.
protected String	className Value of the attribute className for the custom tag.
protected String	style Value of the attribute style for the custom tag.

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

Constructors

Constructor and Description
CenterTag()

Method Summary

Modifier and Type	Method and Description
int	doEndTag() Writes test for the JSP when the closing tag for the custom tag is encountered.
int	doStartTag() Writes text for the JSP (Java Server Page) when the opening tag of the custom tag is encountered.
String	getAlign() Returns the value of the attribute align for the custom tag.
String	getClassName() Returns the value of the attribute className for the custom tag.
protected String	getStyle() Returns the value of the attribute style for the custom tag.
void	setAlign(String value) Used by the servlet generated by the application server to set the value of the attribute align for the custom tag.
void	setClassName(String value) Used by the application server to set the value of the variable className when it is encountered as an attribute in the custom tags.
void	setPageContext(PageContext context)
protected void	setStyle(String value) Used by the application server to set the value of the variable style when it is encountered as an attribute in the custom tags.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

align

protected String align

Value of the attribute align for the custom tag.

className

protected String className

Value of the attribute className for the custom tag.

When the tag is translated into a scriptlet, this attribute becomes the value of the class attribute for a div element. However, class is a reserved word in Java, requiring the use of a different name for the attribute.

style

protected String style

Value of the attribute style for the custom tag.

Constructor Detail

CenterTag

public CenterTag()

Method Detail

setAlign

public void setAlign(String value)

Used by the servlet generated by the application server to set the value of the attribute align for the custom tag.

The name of the attribute is passed to the application server in the TLD file so that the application server can use the name of the attribute to write function calls with the correct class names.

Parameters:

value - Value to be used for attribute align

See Also:

align

getAlign

public String getAlign()

Returns the value of the attribute align for the custom tag.

Returns:

Value of attribute

See Also:

align

setClassName

public void setClassName(String value)

Used by the application server to set the value of the variable className when it is encountered as an attribute in the custom tags.

Parameters:

value - Value to be used for attribute className

See Also:

className

getClassName

public String getClassName()

Returns the value of the attribute className for the custom tag.

Returns:

Value of attribute

See Also:

className

setStyle

protected void setStyle(String value)

Used by the application server to set the value of the variable style when it is encountered as an attribute in the custom tags.

Parameters:

value - Value to be used for attribute style

See Also:

style

getStyle

protected String getStyle()

Returns the value of the attribute style for the custom tag.

Returns:

Value of attribute

See Also:

style

setPageContext

public void setPageContext(PageContext context)

Specified by:

setPageContext in interface Tag

Overrides:

setPageContext in class TagSupport

doStartTag

public int doStartTag()
               throws JspException

Writes text for the JSP (Java Server Page) when the opening tag of the custom tag is encountered.

The block of text is surrounded by a table since a table's width will automatically shrink if the sum of the column widths is less that the available width. Setting margin-left and margin-right to auto causes the table to be centered in this situation.

The method returns Tag.EVAL_BODY_INCLUDE to indicate that the material in the body of the tag will be processed by the JSP preprocessor.

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class TagSupport

Throws:

JspException

doEndTag

public int doEndTag()
             throws JspException

Writes test for the JSP when the closing tag for the custom tag is encountered.

The method returns Tag.EVAL_PAGE to indicate that processing of the Java Server Page should continue.

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class TagSupport

Throws:

JspException