public class Help extends StylableTag
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. |
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
helpid
The keyword of the helptopic
|
private java.lang.String |
image
The path to the help icon
|
private Page |
page
The parent <base:page> tag.
|
private static long |
serialVersionUID |
private java.lang.String |
tabcontrol
The tabcontrol ID to get the help id from.
|
private int |
tabIndex |
private java.lang.String |
tooltip
Optional tooltip.
|
private boolean |
visible
If the help icon should be visible or not.
|
id, pageContext
EVAL_BODY_AGAIN
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
Constructor and Description |
---|
Help() |
Modifier and Type | Method and Description |
---|---|
int |
doStartTag() |
java.lang.String |
getHelpid() |
java.lang.String |
getImage() |
java.lang.String |
getTabcontrol() |
int |
getTabindex() |
java.lang.String |
getTooltip() |
boolean |
isVisible() |
void |
setHelpid(java.lang.String helpid) |
void |
setImage(java.lang.String image) |
void |
setTabcontrol(java.lang.String tabcontrol) |
void |
setTabindex(int tabIndex) |
void |
setTooltip(java.lang.String tooltip) |
void |
setVisible(boolean visible) |
addDynamicAttributes, addIdAndStyles, getClazz, getDynamicActionAttributes, getDynamicAttribute, getFullClass, getIdPrefix, getStyle, getSubclass, initDefaultAttributes, setClazz, setDynamicAttribute, setMoreDynamicAttributes, setPageContext, setStyle, setSubclass
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setParent, setValue
private static final long serialVersionUID
private Page page
private java.lang.String helpid
private java.lang.String tabcontrol
private java.lang.String image
private java.lang.String tooltip
private boolean visible
private int tabIndex
public void setHelpid(java.lang.String helpid)
public java.lang.String getHelpid()
public void setTabcontrol(java.lang.String tabcontrol)
public java.lang.String getTabcontrol()
public void setImage(java.lang.String image)
public java.lang.String getImage()
public void setTooltip(java.lang.String tooltip)
public java.lang.String getTooltip()
public void setVisible(boolean visible)
public boolean isVisible()
public void setTabindex(int tabIndex)
public int getTabindex()
public int doStartTag() throws JspException
doStartTag
in interface Tag
doStartTag
in class TagSupport
JspException