Class Help

All Implemented Interfaces:
Serializable, DynamicAttributes, IterationTag, JspTag, Tag, DynamicActionAttributes

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=...
  >
  
Tag attributes
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.
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 Details

    • 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.
    • visible

      private boolean visible
      If the help icon should be visible or not.
    • tabIndex

      private int tabIndex
  • Constructor Details

    • Help

      public Help()
  • Method Details

    • 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