net.sf.basedb.clients.web.extensions.tabcontrol
Interface TabAction

All Superinterfaces:

Action

All Known Implementing Classes:

FixedTabFactory, IncludeContentTabFactory.Tab, Tab, TabBean

public interface TabAction
extends Action

Action that inserts a new tab in a tabcontrol.

Since:

2.17

Author:

Nicklas

Last modified

$Date: 2010-11-10 12:16:51 +0100 (Wed, 10 Nov 2010) $

Method Summary

String	getClazz() Class attribute of the main tab tag.
String	getContent() Get the (HTML) contents of the tab.
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	getId() ID attribute of the main tab tag.
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.

Method Detail

getId

String getId()

ID attribute of the main tab tag. You need to set this value to reference the tab in a javascript.

Returns:

The ID, or null

getClazz

String getClazz()

Class attribute of the main tab tag.

Returns:

Class attribute, or null to not add any class attribute

getStyle

String getStyle()

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

Returns:

Style attributes, or null

getTitle

String getTitle()

Get the title of the tab.

getTooltip

String getTooltip()

A tooltip that is shown as a yellow popup when the user points the mouse at the tab.

Returns:

The tooltip or null to not display any tooltip

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

Returns:

The help id or null to not display any help

isVisible

boolean isVisible()

If the tab should be visible or not.

getOnValidate

String getOnValidate()

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.

Returns:

The javascript action or null if no validation is needed

getOnActivate

String getOnActivate()

A javascript action that is executed when activating the tab.

Returns:

The javascript action or null if no validation is needed

getContent

String getContent()

Get the (HTML) contents of the tab.