3.2.4: 2013-12-06

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

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by net.sf.basedb.clients.web.taglib.StylableTag
          extended by net.sf.basedb.clients.web.taglib.Help
All Implemented Interfaces:
Serializable, IterationTag, JspTag, Tag

public class Help
extends StylableTag

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=...
        subclass=...
        style=...
        image=...
        tooltip=...
        visible=...
        tabindex=...
  >
  

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 helpicon no The value if this attribute goes directly into the standard HTML class attribute. This allows you to apply different styles to different helps.
subclass - no Additional classes to put in the HTML class attribute. Doesn't replace the main class attribute.
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.
tabindex 0 no Tab index value to control the focus order. Use -1 to disable tabbing to the icon.

Version:
2.0
Author:
martin
See Also:
Serialized Form

Field Summary
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 tabcontrol
          The tabcontrol ID to get the help id from.
private  int tabIndex
           
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 getHelpid()
           
 String getImage()
           
 String getTabcontrol()
           
 int getTabindex()
           
 String getTooltip()
           
 boolean isVisible()
           
 void setHelpid(String helpid)
           
 void setImage(String image)
           
 void setTabcontrol(String tabcontrol)
           
 void setTabindex(int tabIndex)
           
 void setTooltip(String tooltip)
           
 void setVisible(boolean visible)
           
 
Methods inherited from class net.sf.basedb.clients.web.taglib.StylableTag
addIdAndStyles, getClazz, getFullClass, getStyle, getSubclass, setClazz, setStyle, setSubclass
 
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.


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.


tabIndex

private int tabIndex
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()

setImage

public void setImage(String image)

getImage

public String getImage()

setTooltip

public void setTooltip(String tooltip)

getTooltip

public String getTooltip()

setVisible

public void setVisible(boolean visible)

isVisible

public boolean isVisible()

setTabindex

public void setTabindex(int tabIndex)
Since:
3.2

getTabindex

public int getTabindex()
Since:
3.2

doStartTag

public int doStartTag()
               throws JspException
Specified by:
doStartTag in interface Tag
Overrides:
doStartTag in class TagSupport
Throws:
JspException

3.2.4: 2013-12-06