com.sabratec.j2ee.framework.web.tags

Class GXAbstractTag

java.lang.Object

BodyTagSupport

com.sabratec.j2ee.framework.web.tags.GXAbstractTag

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GXAbstractBodyTag, GXAbstractGenericTag, GXAnchorTag, GXCheckBoxTag, GXContextInitiatorTag, GXContextReleaseTag, GXFeatureDetectTag, GXFormTag, GXHtmlTag, GXInputTag, GXJspIncludeTag, GXRadioButtonListTag, GXRadioButtonTag, GXSelectTag, GXTableTag

public abstract class GXAbstractTag
extends BodyTagSupport
implements Serializable

This class is the abstract class for all the gx tags. It provides common functionallity for all the inheriting classes such as:

• getId()
• getAttribute(String)
• getAttributes()

Each class that inherits from this class should implement two methods:
getTagName() - to specify the tag name
buildHtmlTag(StringBuffer) - for building the HTML string of the specific tag

All the inheriting classes are initialized automatically by the JSP page, according to a specified tag in the JSP page.
For example: <gx:TAG-NAME ...attributes...>...<gx:/TAG-NAME> and should not be initialized by the user.
The attributes are translated into set method in this class or the relevant inherited class.

A Set method is specified per each tag attribute and for common HTML attributes: setCssClass , setStyle, etc.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GXAbstractTag()

Method Summary

Modifier and Type	Method and Description
int	doAfterBody() Method is invoked after every body evaluation to control whether the body will be reevaluated or not.
int	doEndTag() Triggers the tag build process.
int	doStartTag() Overrides the tag library class BodyTagSupport and performs validation and further initialization.
String	getId() Retrieves the ID of the current tag
String	getInnerHTML() Used for retrieving the Inner HTML tag.
GXIWebPageContext	getMainContext() Used for getting the main context class for the current tag.
String	getName()
void	setAlign(String value) Called by the JSP page for setting the align attribute to the tag output html.
void	setAttributes(String value) Used for writing free text of attributes.
void	setBgcolor(String value)
void	setCssClass(String cssClass) Called by the JSP page for setting the css class of the gx tag.
void	setHeight(String value) Called by the JSP page for setting the height attribute to the tag output html.
void	setId(String id) Sets an ID identifier to the current tag.
void	setOnclick(String value) Called by the JSP page for setting the onclick attribute to the tag output html.
void	setPageContext(PageContext pageContext) Overrides the BodyTagSupport class, and is used for initializing the current tag.
void	setStyle(String value) Called by the JSP page for setting the style attribute to the tag output html.
void	setTitle(String value) Called by the JSP page for setting the title attribute to the tag output html.
void	setVisible(String value) Uses for show/hide the tag.
void	setWidth(String value) Called by the JSP page for setting the width attribute to the tag output html.

Methods inherited from class java.lang.Object

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

Constructor Detail

GXAbstractTag

public GXAbstractTag()

Method Detail

getInnerHTML

public String getInnerHTML()

Used for retrieving the Inner HTML tag.
For example: <gx:span>some text</gx:span>

Returns:

The tag inner HTML

setId

public void setId(String id)

Sets an ID identifier to the current tag.
The set method is called automatically by the JSP page when setting the ID attribute to a gx tag.
The ID can be used to update content for the tag using GXITagsAccesor.setTagContent(String, String).

getId

public String getId()

Retrieves the ID of the current tag

getName

public String getName()

setCssClass

public void setCssClass(String cssClass)

Called by the JSP page for setting the css class of the gx tag.
Translated into the HTML "class" attribute.

Parameters:

cssClass - The css class name

setPageContext

public void setPageContext(PageContext pageContext)

Overrides the BodyTagSupport class, and is used for initializing the current tag.

Parameters:

pageContext - The JSP page context

doStartTag

public int doStartTag()
               throws JspException

Overrides the tag library class BodyTagSupport and performs validation and further initialization.

Throws:

JspException

See Also:

BodyTagSupport#doStartTag()

getMainContext

public GXIWebPageContext getMainContext()

Used for getting the main context class for the current tag.

Returns:

The main context class for the current tag.

doEndTag

public int doEndTag()
             throws JspTagException

Triggers the tag build process. If the tag was set to not visible GXITagsAccesor.setTagVisible(String, boolean), the tag will not be rendered.
This method calls the abstract method buildHtmlTag(StringBuffer) in order for each inheriting class to build its HTML content.

Throws:

JspTagException

doAfterBody

public int doAfterBody()
                throws JspTagException

Method is invoked after every body evaluation to control whether the body will be reevaluated or not.

Returns:

SKIP_BODY

Throws:

JspTagException

setAttributes

public void setAttributes(String value)

Used for writing free text of attributes.
Syntax:
<gx:tag attributes="onmouseover='showImage();' onmouseout='hideImage();' " ...>

Parameters:

value - The free text that specifies the attributes

setVisible

public void setVisible(String value)

Uses for show/hide the tag. This method is called automatically by the JSP page, when placing a visible attribute to a tag.
Typical Usage: <gx:tag visible="false">...
false vaue is causing the tag not to be rendered

Parameters:

value - true/false if the tag should be visible.

See Also:

GXITagsAccesor.setTagVisible(String, boolean)

setStyle

public void setStyle(String value)

Called by the JSP page for setting the style attribute to the tag output html.

Parameters:

value - The style attributes value

setTitle

public void setTitle(String value)

Called by the JSP page for setting the title attribute to the tag output html.

Parameters:

value - The title attribute value

setOnclick

public void setOnclick(String value)

Called by the JSP page for setting the onclick attribute to the tag output html.

Parameters:

value - The onclick attribute value

setAlign

public void setAlign(String value)

Called by the JSP page for setting the align attribute to the tag output html.

Parameters:

value - The align attribute value

setWidth

public void setWidth(String value)

Called by the JSP page for setting the width attribute to the tag output html.

Parameters:

value - The width attribute value

setHeight

public void setHeight(String value)

Called by the JSP page for setting the height attribute to the tag output html.

Parameters:

value - The height attribute value

setBgcolor

public void setBgcolor(String value)