net.sf.basedb.clients.web.taglib.tab
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, IterationTag, JspTag, Tag, TabAction, Action

public class Tab
extends BodyTagSupport
implements TabAction

This tag defines the title and contents of a single tab inside a tab control.

Syntax:

   <t:tab
      id=...
      clazz=...
      style=...
      title=...
      tooltip=...
      validate=...
      activate=...
      visible=true|false
      helpid=...
   >

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.
validate	-	no	An optional JavaScript expression that will be evaluated when the users tries to switch from this tab to another. If the expression returns FALSE the switch will not be made. You may, for example, use this attribute to validate input data in a form.
activate	-	no	An optional JavaScript expression that will be executed when the switches to this tab.
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.

Version:

2.0

Author:

Nicklas

See Also:

TabControl, Serialized Form

Field Summary

private String	activate A JavaScript method that is invoked when activating the tab.
private String	clazz Optional class attribute.
private String	helpid The help ID for this tab.
private static long	serialVersionUID
private String	style Optional style attribute
private TabControl	tc The parent TabControl object.
private String	title The title of the tab.
private String	tooltip A popup tooltip text.
private String	validate A JavaScript method that validates the tab content.
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

Tab()

Method Summary

int	doEndTag()
int	doStartTag()
String	getClazz() Class attribute of the main tab tag.
String	getContent() Get the (HTML) contents of the tab.
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	getOnActivate() A javascript action that is executed when activating the tab.
String	getOnValidate() A javascript action that is executed when validating form data on the tab.
String	getStyle() Extra CSS style attributes that will be added to the style attribute of the main tab tag.
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	setActivate(String activate)
void	setClazz(String clazz)
void	setHelpid(String helpid)
void	setStyle(String style)
void	setTitle(String title)
void	setTooltip(String tooltip)
void	setValidate(String validate)
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, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.basedb.clients.web.extensions.tabcontrol.TabAction

getId

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

tc

private TabControl tc

The parent TabControl object.

clazz

private String clazz

Optional class attribute.

Since:

2.17

style

private String style

Optional style attribute

title

private String title

The title of the tab.

tooltip

private String tooltip

A popup tooltip text.

validate

private String validate

A JavaScript method that validates the tab content.

activate

private String activate

A JavaScript method that is invoked when activating the tab.

visible

private boolean visible

If the tab should be visible or not.

helpid

private String helpid

The help ID for this tab.

Constructor Detail

Tab

public Tab()

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.

Specified by:

getClazz in interface TabAction

Returns:

Class attribute, or null to not add any class attribute

Since:

2.17

setStyle

public void setStyle(String style)

getStyle

public String getStyle()

Description copied from interface: TabAction

Extra CSS style attributes that will be added to the style attribute of the main tab tag.

Specified by:

getStyle in interface TabAction

Returns:

Style attributes, or null

setTitle

public void setTitle(String title)

getTitle

public String getTitle()

Description copied from interface: TabAction

Get the title of the tab.

Specified by:

getTitle in interface TabAction

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 interface TabAction

Returns:

The tooltip or null to not display any tooltip

setValidate

public void setValidate(String validate)

getOnValidate

public String getOnValidate()

Description copied from interface: TabAction

A javascript action that is executed when validating form data on the tab. This script is executed when the user is trying to save the form, or when navigating to another tab. The script should return TRUE to indicate successful validation, or display an error message and return FALSE otherwise.

Specified by:

getOnValidate in interface TabAction

Returns:

The javascript action or null if no validation is needed

setActivate

public void setActivate(String activate)

Since:

2.17

getOnActivate

public String getOnActivate()

Description copied from interface: TabAction

A javascript action that is executed when activating the tab.

Specified by:

getOnActivate in interface TabAction

Returns:

The javascript action or null if no validation is needed

Since:

2.17

setVisible

public void setVisible(boolean visible)

isVisible

public boolean isVisible()

Description copied from interface: TabAction

If the tab should be visible or not.

Specified by:

isVisible in interface TabAction

setHelpid

public void setHelpid(String helpid)

getHelpid

public String getHelpid()

doStartTag

public int doStartTag()
               throws JspException

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class BodyTagSupport

Throws:

JspException

doEndTag

public int doEndTag()
             throws JspException

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class BodyTagSupport

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. See Help.getExternalId().

Specified by:

getHelpId in interface TabAction

Returns:

The help id or null to not display any help

getContent

public String getContent()

Description copied from interface: TabAction

Get the (HTML) contents of the tab.

Specified by:

getContent in interface TabAction