org.apache.pluto.tags
Class DefineObjectsTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.apache.pluto.tags.DefineObjectsTag

All Implemented Interfaces:

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

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

A tag handler for the defineObjects tag. Creates the following variables to be used in the JSP:

• RenderRequest renderRequest, when included from within the render method, null otherwise
• ResourceRequest resourceRequest, when included from within the serveResource method, null otherwise
• ActionRequest actionRequest, when included from within the processAction method, null otherwise
• EventRequest eventRequest, when included from within the processEvent method, null otherwise
• RenderResponse renderResponse, when included from within the render method, null otherwise
• ResourceResponse resourceResponse, when included from within the serveResource method, null otherwise
• ActionResponse actionResponse, when included from within the processAction method, null otherwise
• EventResponse eventResponse, when included from within the processEvent method, null otherwise
• PortletConfig portletConfig
• PortletSession portletSession, providing access to the portletSession, does not create a new session, only returns an existing session
• Map portletSessionScope, providing access to the portletSession attributes as a Map.
• PortletPreferences portletPreferences, providing access to the portlet preferences
• Map portletPreferencesValues, providing access to the portlet preferences as a Map

Version:

2.0

See Also:

Serialized Form

Nested Class Summary

static class

DefineObjectsTag.TEI

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

DefineObjectsTag()

Method Summary

int	doStartTag() Processes the defineObjects tag.

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

doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, 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

DefineObjectsTag

public DefineObjectsTag()

Method Detail

doStartTag

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

Processes the defineObjects tag.

Specified by:

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

Overrides:

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

Returns:

SKIP_BODY

Throws:

javax.servlet.jsp.JspException