com.esri.gpt.framework.jsf
Class PageContextTag

java.lang.Object
  javax.servlet.jsp.tagext.SimpleTagSupport
      com.esri.gpt.framework.jsf.PageContextTag

All Implemented Interfaces:

JspTag, SimpleTag

public class PageContextTag
extends SimpleTagSupport

Provides <gpt:page/> context tag functionality.

Tag <gpt:page/> accepts the followingattributes:

• id [required] - key of the page,
• captionkey - resource id of the page caption,
• caption - page caption (overrides caption sets by caption key),
• help - page id for help sub-system.

This tag has to be element of each page. To use it, insert the following two lines into the .jsp page definition:

<%@taglib uri="http://www.esri.com/gpt" prefix="gpt" %>
<gpt:page key="catalog.identity.login" caption="Login" help="login-help.html"/>

Constructor Summary

PageContextTag()

Method Summary

void	doTag() Called by the container to invoke this tag.
String	getPrepareView() Gets expression used to prepare view.
void	setCaption(String caption) Sets 'caption' attribute.
void	setCaptionkey(String captionkey) Sets 'captionkey' attribute.
void	setId(String key) Sets 'key' attribute.
void	setPrepareView(String prepareView) Sets expression used to prepare view.
void	setTabId(String tabId) Sets tab id.

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

findAncestorWithClass, getJspBody, getJspContext, getParent, setJspBody, setJspContext, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

PageContextTag

public PageContextTag()

Method Detail

doTag

public void doTag()
           throws JspException

Called by the container to invoke this tag. The implementation of this method is provided by the tag library developer, and handles all tag processing, body iteration, etc.

Specified by:

doTag in interface SimpleTag

Overrides:

doTag in class SimpleTagSupport

Throws:

JspException

setId

public void setId(String key)

Sets 'key' attribute.

Parameters:

key - key attribute value.

setCaptionkey

public void setCaptionkey(String captionkey)

Sets 'captionkey' attribute.

Parameters:

captionkey - captionkey attribute value.

setCaption

public void setCaption(String caption)

Sets 'caption' attribute.

Parameters:

caption - caption attribute value.

setTabId

public void setTabId(String tabId)

Sets tab id.

Parameters:

tabId - tab id

getPrepareView

public String getPrepareView()

Gets expression used to prepare view.

Returns:

expression used to prepare view

setPrepareView

public void setPrepareView(String prepareView)

Sets expression used to prepare view.

Parameters:

prepareView - expression used to prepare view