net.sf.basedb.clients.web.taglib
Class Help

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      net.sf.basedb.clients.web.taglib.Help

All Implemented Interfaces:

Serializable, IterationTag, JspTag, Tag

public class Help
extends TagSupport

This tag is used to make it easier to add help features on a BASE web page.

Example:

        <%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
        <base:help help_id="required_helpexternalID" />
  

Syntax:

  <base:help
        helpid=...
        tabcontrol=...
        clazz=...
        style=...
        image=...
        tooltip=...
        onclick=...
        visible=...
  >
  

Attribute	Default value	Required	Description
helpid		no	The keyword of the help topic to display. Each help topic has a one-word key to be identified with. If not specified then the tabcontrol attribute must be specified.
tabcontrol		no	The ID of the TabControl to get the help id from. Each Tab in a tabcontrol should specify it's own helpid attribute.
clazz	help	no	The value if this attribute goes directly into the standard HTML class attribute. This allows you to apply different styles to different helps.
style	-	no	The value if this attribute goes directly into the standard HTML style attribute. This allows you to apply different styles to different icons.
image	-	no	The name of the image to display. The image must be in the /images directory. Only include the filename, not the path. This taglib will find the correct path from the current jsp page.
tooltip	-	no	A short explanation that will show up as a tooltip.
onclick	-	no	An optional JavaScript statement that will exceute when the user clicks on the icon.
visible	true	no	If the help icon should be visible or not.

Version:

2.0

Author:

martin

See Also:

Serialized Form

Field Summary

private String	clazz Optional class attribute
private String	helpid The keyword of the helptopic
private String	image The path to the help icon
private String	onClick Optional JavaScript statement.
private Page	page The parent <base:page> tag.
private static long	serialVersionUID
private String	style Optional style attribute
private String	tabcontrol The tabcontrol ID to get the help id from.
private String	tooltip Optional tooltip.
private boolean	visible If the help icon should be visible or not.

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

Help()

Method Summary

int	doStartTag()
String	getClazz()
String	getHelpid()
String	getImage()
String	getOnClick()
String	getStyle()
String	getTabcontrol()
String	getTooltip()
boolean	isVisible()
void	setClazz(String clazz)
void	setHelpid(String helpid)
void	setImage(String image)
void	setOnClick(String onclick)
void	setStyle(String style)
void	setTabcontrol(String tabcontrol)
void	setTooltip(String tooltip)
void	setVisible(boolean visible)

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

page

private Page page

The parent <base:page> tag.

helpid

private String helpid

The keyword of the helptopic

tabcontrol

private String tabcontrol

The tabcontrol ID to get the help id from.

clazz

private String clazz

Optional class attribute

style

private String style

Optional style attribute

image

private String image

The path to the help icon

tooltip

private String tooltip

Optional tooltip.

onClick

private String onClick

Optional JavaScript statement.

visible

private boolean visible

If the help icon should be visible or not.

Constructor Detail

Help

public Help()

Method Detail

setHelpid

public void setHelpid(String helpid)

getHelpid

public String getHelpid()

setTabcontrol

public void setTabcontrol(String tabcontrol)

getTabcontrol

public String getTabcontrol()

setClazz

public void setClazz(String clazz)

getClazz

public String getClazz()

setStyle

public void setStyle(String style)

getStyle

public String getStyle()

setImage

public void setImage(String image)

getImage

public String getImage()

setTooltip

public void setTooltip(String tooltip)

getTooltip

public String getTooltip()

setOnClick

public void setOnClick(String onclick)

getOnClick

public String getOnClick()

setVisible

public void setVisible(boolean visible)

isVisible

public boolean isVisible()

doStartTag

public int doStartTag()
               throws JspException

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class TagSupport

Throws:

JspException