hirondelle.fish.help
Class ShowHelpTag

Object
  SimpleTagSupport
      TagHelper
          hirondelle.fish.help.ShowHelpTag

All Implemented Interfaces:

JspTag, SimpleTag

public final class ShowHelpTag
extends TagHelper

Conditionally display help text in a page.

Example use case :

 <w:help>
  Report on wildebeest population density.
  Sorted by country, shows only data from 1952-1995.
 </w:help>
 

This tag searches session scope for an object identified by a certain KEY. If that object is present, and corresponds to Boolean.TRUE, then the body of this text will be emitted. Otherwise, the body of this tag will not be emitted.

The toggling of this value is performed by ShowHelpAction.

Field Summary

static String

KEY Key which identifies a Boolean attribute placed in session scope.

Constructor Summary

ShowHelpTag()

Method Summary

protected String

getEmittedText(String aOriginalBody) See class comment.

Methods inherited from class TagHelper

checkForContent, crossCheckAttributes, doTag, getPageContext, getPageName, getRequest, getResponse

Methods inherited from class SimpleTagSupport

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

Methods inherited from class Object

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

Field Detail

KEY

public static final String KEY

Key which identifies a Boolean attribute placed in session scope. The value of this attribute toggles the display of help text on and off.

See Also:

Constant Field Values

Constructor Detail

ShowHelpTag

public ShowHelpTag()

Method Detail

getEmittedText

protected String getEmittedText(String aOriginalBody)
                         throws JspException

See class comment.

Specified by:

getEmittedText in class TagHelper

Throws:

JspException