mx.com.brained.taglib
Class GridFrameTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      mx.com.brained.taglib.GridFrameTag

All Implemented Interfaces:

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

public class GridFrameTag
extends javax.servlet.jsp.tagext.TagSupport

Title: AwTaglib

Description: This tag generates an IFrame HTML tag that will contain a jsp with an ActiveWidgets grid. It accepts four different parameters for the internal information to be rendered, that are as follows:

• forward - Use the value of this attribute as the name of a global ActionForward to be looked up, and use the module-relative or context-relative URI found there. If the forward is module-relative then it must point to an action and NOT to a page.
• action - Use the value of this attribute as the name of a Action to be looked up, and use the module-relative or context-relative URI found there.
• href - Use the value of this attribute unchanged.
• page - Use the value of this attribute as a module-relative URI, and generate a server-relative URI by including the context path and module prefix.

It works very similar to an html:link tag from the Struts framework

Copyright: Copyright (c) 2005

Company: Brain-ED

Version:

1.0

Author:

Isidoro Treviño, Eliseo Partida

See Also:

Serialized Form

Field Summary

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

GridFrameTag()

Method Summary

protected java.lang.String	calculateURL() Return the complete URL to which this hyperlink will direct the user.
int	doStartTag()
java.lang.String	getAction()
java.lang.String	getAnchor()
java.lang.String	getForward()
java.lang.String	getHref()
java.lang.String	getLinkName()
java.lang.String	getModule()
java.lang.String	getName()
java.lang.String	getPage()
java.lang.String	getParamId()
java.lang.String	getParamMap()
java.lang.String	getParamMapProperty()
java.lang.String	getParamName()
java.lang.String	getParamProperty()
java.lang.String	getStyleClass()
void	release() Reset the properties to be reused
void	setAction(java.lang.String action)
void	setAnchor(java.lang.String anchor) If using an anchor, set this
void	setForward(java.lang.String forward)
void	setHref(java.lang.String href)
void	setLinkName(java.lang.String linkName) The anchor name to be defined within this page, so that you can reference it with intra-page hyperlinks.
void	setModule(java.lang.String module) If inside a struts module, use this
void	setName(java.lang.String name) Set the name of the IFrame
void	setPage(java.lang.String page)
void	setParamId(java.lang.String paramId) The name of the request parameter that will be dynamically added to the generated hyperlink.
void	setParamMap(java.lang.String paramMap) The name of a JSP bean that contains a Map representing the query parameters (if property is not specified), or a JSP bean whose property getter is called to return a Map (if property is specified).
void	setParamMapProperty(java.lang.String paramMapProperty) The name of a property of the bean specified by the name attribute, whose return value must be a java.util.Map containing the query parameters to be added to the hyperlink.
void	setParamName(java.lang.String paramName) The name of a JSP bean that is a String containing the value for the request parameter named by paramId (if paramProperty is not specified), or a JSP bean whose property getter is called to return a String (if paramProperty is specified).
void	setParamProperty(java.lang.String paramProperty) The name of a property of the bean specified by the paramName attribute, whose return value must be a String containing the value of the request parameter (named by the paramId attribute) that will be dynamically added to this hyperlink.
void	setStyleClass(java.lang.String styleClass) Sets the CSS class to be used by the frame

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

doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

GridFrameTag

public GridFrameTag()

Method Detail

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the CSS class to be used by the frame

Parameters:

styleClass - String

setName

public void setName(java.lang.String name)

Set the name of the IFrame

Parameters:

name - String

setForward

public void setForward(java.lang.String forward)

Parameters:

forward - String

setAction

public void setAction(java.lang.String action)

Parameters:

action - String

setHref

public void setHref(java.lang.String href)

Parameters:

href - String

setPage

public void setPage(java.lang.String page)

Parameters:

page - String

setModule

public void setModule(java.lang.String module)

If inside a struts module, use this

Parameters:

module - String

setAnchor

public void setAnchor(java.lang.String anchor)

If using an anchor, set this

Parameters:

anchor - String

setParamId

public void setParamId(java.lang.String paramId)

The name of the request parameter that will be dynamically added to the generated hyperlink. The corresponding value is defined by the paramName and (optional) paramProperty attributes, optionally scoped by the paramScope attribute

Parameters:

paramId - String

setParamName

public void setParamName(java.lang.String paramName)

The name of a JSP bean that is a String containing the value for the request parameter named by paramId (if paramProperty is not specified), or a JSP bean whose property getter is called to return a String (if paramProperty is specified). The JSP bean is constrained to the bean scope specified by the paramScope property, if it is specified.

Parameters:

paramName - String

setParamProperty

public void setParamProperty(java.lang.String paramProperty)

The name of a property of the bean specified by the paramName attribute, whose return value must be a String containing the value of the request parameter (named by the paramId attribute) that will be dynamically added to this hyperlink.

Parameters:

paramProperty - String

setParamMap

public void setParamMap(java.lang.String paramMap)

The name of a JSP bean that contains a Map representing the query parameters (if property is not specified), or a JSP bean whose property getter is called to return a Map (if property is specified).

Parameters:

paramMap - String

setParamMapProperty

public void setParamMapProperty(java.lang.String paramMapProperty)

The name of a property of the bean specified by the name attribute, whose return value must be a java.util.Map containing the query parameters to be added to the hyperlink. You must specify the name attribute if you specify this attribute.

Parameters:

paramMapProperty - String

setLinkName

public void setLinkName(java.lang.String linkName)

The anchor name to be defined within this page, so that you can reference it with intra-page hyperlinks. In other words, the value specified here will render a "name" element in the generated anchor tag.

Parameters:

linkName - String

getStyleClass

public java.lang.String getStyleClass()

Returns:

Object

getName

public java.lang.String getName()

Returns:

Object

getForward

public java.lang.String getForward()

Returns:

Object

getAction

public java.lang.String getAction()

Returns:

Object

getHref

public java.lang.String getHref()

Returns:

Object

getPage

public java.lang.String getPage()

Returns:

Object

getModule

public java.lang.String getModule()

getAnchor

public java.lang.String getAnchor()

Returns:

Object

getParamId

public java.lang.String getParamId()

Returns:

Object

getParamName

public java.lang.String getParamName()

Returns:

Object

getParamProperty

public java.lang.String getParamProperty()

Returns:

Object

getParamMap

public java.lang.String getParamMap()

Returns:

Object

getParamMapProperty

public java.lang.String getParamMapProperty()

Returns:

Object

getLinkName

public java.lang.String getLinkName()

Returns:

Object

doStartTag

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

Specified by:

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

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException

calculateURL

protected java.lang.String calculateURL()
                                 throws javax.servlet.jsp.JspException

Return the complete URL to which this hyperlink will direct the user.

Throws:

javax.servlet.jsp.JspException - if an exception is thrown calculating the value

release

public void release()

Reset the properties to be reused

Specified by:

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

Overrides:

release in class javax.servlet.jsp.tagext.TagSupport