Package net.sf.basedb.clients.web.taglib
Class Help
java.lang.Object
javax.servlet.jsp.tagext.TagSupport
net.sf.basedb.clients.web.taglib.StylableTag
net.sf.basedb.clients.web.taglib.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=... >
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 Summary
Fields Modifier and Type Field Description private String
helpid
The keyword of the helptopicprivate String
image
The path to the help iconprivate 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
Constructors Constructor Description Help()
-
Method Summary
Modifier and Type Method Description 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
addDynamicAttributes, addIdAndStyles, getClazz, getDynamicActionAttributes, getDynamicAttribute, getFullClass, getIdPrefix, getStyle, getSubclass, initDefaultAttributes, setClazz, setDynamicAttribute, setMoreDynamicAttributes, setPageContext, setStyle, setSubclass
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setParent, setValue
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
- Constant Field Values
-
page
The parent <base:page> tag. -
helpid
The keyword of the helptopic -
tabcontrol
The tabcontrol ID to get the help id from. -
image
The path to the help icon -
tooltip
Optional tooltip. -
visible
private boolean visibleIf the help icon should be visible or not. -
tabIndex
private int tabIndex
-
-
Constructor Details
-
Help
public Help()
-
-
Method Details
-
setHelpid
-
getHelpid
-
setTabcontrol
-
getTabcontrol
-
setImage
-
getImage
-
setTooltip
-
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
- Specified by:
doStartTag
in interfaceTag
- Overrides:
doStartTag
in classTagSupport
- Throws:
JspException
-