Class Tab
- java.lang.Object
-
- javax.servlet.jsp.tagext.TagSupport
-
- javax.servlet.jsp.tagext.BodyTagSupport
-
- net.sf.basedb.clients.web.taglib.tab.Tab
-
- All Implemented Interfaces:
Serializable
,BodyTag
,DynamicAttributes
,IterationTag
,JspTag
,Tag
,DynamicActionAttributes
,TabAction
,Action
public class Tab extends BodyTagSupport implements TabAction, DynamicAttributes, DynamicActionAttributes
This tag defines the title and contents of a single tab inside a tab control.Syntax:
<t:tab id=... clazz=... style=... title=... tooltip=... visible=true|false helpid=... tabindex=... >
Tag attributes Attribute Default value Required Description id tabcontrol1 yes The ID of the tab. The value of this attribute goes directly into the standard HTML id
attribute. This means that if you need a reference to the tab object in your own JavaScript code, you may for example use the following code:tab = document.getElementById('<id>');
clazz button no The value if this attribute goes directly into the standard HTML class
attribute. This allows you to apply different styles to different tables.style - no The value if this attribute goes directly into the standard HTML style
attribute. This allows you to apply different styles to different notes.title - yes The title of the tab. tooltip - no An optional tooltip that is shown as a popup text while the user is pointing the mouse over the tab's title. Not supported by all browsers. visible true no If this tab should be visible or not. helpid no Optional ID for the help text associated with this tab. See the Help
taglib for more information.tabindex 0 no Tab index value to control the focus order. Use -1 to disable tabbing. - Version:
- 2.0
- Author:
- Nicklas
- See Also:
TabControl
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private String
clazz
Optionalclass
attribute.private Map<String,DynamicActionAttribute>
dynamicAttributes
private String
helpid
The help ID for this tab.private static long
serialVersionUID
private String
style
Optionalstyle
attributeprivate int
tabIndex
private TabControl
tc
The parent TabControl object.private String
title
The title of the tab.private String
tooltip
A popup tooltip text.private boolean
visible
If the tab should be visible or not.-
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
-
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
-
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
-
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 Tab()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
doEndTag()
int
doStartTag()
String
getClazz()
Class attribute of the main tab tag.String
getContent()
Get the (HTML) contents of the tab.Iterator<DynamicActionAttribute>
getDynamicActionAttributes()
Get an iterator that return all dynamic attributes.String
getHelpid()
String
getHelpId()
The external id of a help text that the user can display to get more information about how to use the information in this tab.String
getStyle()
Extra CSS style attributes that will be added to thestyle
attribute of the main tab tag.int
getTabindex()
int
getTabIndex()
Get the tab index used to control focus order when tabbing.String
getTitle()
Get the title of the tab.String
getTooltip()
A tooltip that is shown as a yellow popup when the user points the mouse at the tab.boolean
isVisible()
If the tab should be visible or not.void
setClazz(String clazz)
void
setDynamicAttribute(String uri, String name, Object value)
void
setHelpid(String helpid)
void
setPageContext(PageContext pageContext)
Reset the dynamic attributes to make sure old ones are not included in case the tag object is reused.void
setStyle(String style)
void
setTabindex(int tabIndex)
void
setTitle(String title)
void
setTooltip(String tooltip)
void
setVisible(boolean visible)
-
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent
-
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setParent, setValue
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
tc
private TabControl tc
The parent TabControl object.
-
dynamicAttributes
private Map<String,DynamicActionAttribute> dynamicAttributes
-
clazz
private String clazz
Optionalclass
attribute.- Since:
- 2.17
-
style
private String style
Optionalstyle
attribute
-
title
private String title
The title of the tab.
-
tooltip
private String tooltip
A popup tooltip text.
-
visible
private boolean visible
If the tab should be visible or not.
-
helpid
private String helpid
The help ID for this tab.
-
tabIndex
private int tabIndex
-
-
Method Detail
-
setClazz
public void setClazz(String clazz)
- Since:
- 2.17
-
getClazz
public String getClazz()
Description copied from interface:TabAction
Class attribute of the main tab tag.
-
setStyle
public void setStyle(String style)
-
getStyle
public String getStyle()
Description copied from interface:TabAction
Extra CSS style attributes that will be added to thestyle
attribute of the main tab tag.
-
setTitle
public void setTitle(String title)
-
getTitle
public String getTitle()
Description copied from interface:TabAction
Get the title of the tab.
-
setTooltip
public void setTooltip(String tooltip)
-
getTooltip
public String getTooltip()
Description copied from interface:TabAction
A tooltip that is shown as a yellow popup when the user points the mouse at the tab.- Specified by:
getTooltip
in interfaceTabAction
- Returns:
- The tooltip or null to not display any tooltip
-
setVisible
public void setVisible(boolean visible)
-
isVisible
public boolean isVisible()
Description copied from interface:TabAction
If the tab should be visible or not.
-
setHelpid
public void setHelpid(String helpid)
-
getHelpid
public String getHelpid()
-
setTabindex
public void setTabindex(int tabIndex)
-
getTabindex
public int getTabindex()
-
setDynamicAttribute
public void setDynamicAttribute(String uri, String name, Object value) throws JspException
- Specified by:
setDynamicAttribute
in interfaceDynamicAttributes
- Throws:
JspException
-
getDynamicActionAttributes
public Iterator<DynamicActionAttribute> getDynamicActionAttributes()
Description copied from interface:DynamicActionAttributes
Get an iterator that return all dynamic attributes. If no dynamic attributes have been defined, the method may return null or an iterator that doesn't return any elements.- Specified by:
getDynamicActionAttributes
in interfaceDynamicActionAttributes
- Returns:
- An iterator or null
-
setPageContext
public void setPageContext(PageContext pageContext)
Reset the dynamic attributes to make sure old ones are not included in case the tag object is reused.- Specified by:
setPageContext
in interfaceTag
- Overrides:
setPageContext
in classTagSupport
- Since:
- 3.10
-
doStartTag
public int doStartTag() throws JspException
- Specified by:
doStartTag
in interfaceTag
- Overrides:
doStartTag
in classBodyTagSupport
- Throws:
JspException
-
doEndTag
public int doEndTag() throws JspException
- Specified by:
doEndTag
in interfaceTag
- Overrides:
doEndTag
in classBodyTagSupport
- Throws:
JspException
-
getHelpId
public String getHelpId()
Description copied from interface:TabAction
The external id of a help text that the user can display to get more information about how to use the information in this tab. SeeHelp.getExternalId()
.
-
getTabIndex
public int getTabIndex()
Description copied from interface:TabAction
Get the tab index used to control focus order when tabbing. Use -1 to disable.- Specified by:
getTabIndex
in interfaceTabAction
-
getContent
public String getContent()
Description copied from interface:TabAction
Get the (HTML) contents of the tab.- Specified by:
getContent
in interfaceTabAction
-
-