2.17.2: 2011-06-17

net.sf.basedb.clients.web.extensions.tabcontrol
Class FixedTabFactory

java.lang.Object
  extended by net.sf.basedb.clients.web.extensions.AbstractJspFactory
      extended by net.sf.basedb.clients.web.extensions.AbstractJspActionFactory<TabAction>
          extended by net.sf.basedb.clients.web.extensions.tabcontrol.FixedTabFactory
All Implemented Interfaces:
TabAction, Action, ActionFactory<TabAction>

public class FixedTabFactory
extends AbstractJspActionFactory<TabAction>
implements TabAction

A simple implementation of a tab action factory that creates the same fixed tab for all users not using any context information.

If the extension point supports scripts and stylesheets, use the AbstractJspFactory.setScript(String) and AbstractJspFactory.setStylesheet(String) methods. Each call to these methods will add the argument to a set. Use the AbstractJspFactory.getScripts() and AbstractJspFactory.getStylesheets() methods to gain access to the sets, for example, to remove added items.

Since:
2.17
Author:
nicklas
Last modified
$Date: 2010-11-10 12:16:51 +0100 (Wed, 10 Nov 2010) $

Field Summary
private  TabAction[] actions
           
private  String clazz
           
private  String content
           
private  String helpId
           
private  String id
           
private  String onActivate
           
private  String onValidate
           
private  String style
           
private  String title
           
private  String tooltip
           
private  boolean visible
           
 
Constructor Summary
FixedTabFactory()
          Create a new factory instance.
 
Method Summary
 TabAction[] getActions(InvokationContext context)
          This method may be called one or several times for each request.
 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.
 void setClazz(String clazz)
           
 void setContent(String content)
           
 void setHelpId(String helpId)
           
 void setId(String id)
           
 void setOnActivate(String onActivate)
           
 void setOnValidate(String onValidate)
           
 void setStyle(String style)
           
 void setTitle(String title)
           
 void setTooltip(String tooltip)
           
 void setVisible(boolean visible)
           
 void setVisible(String visible)
           
 
Methods inherited from class net.sf.basedb.clients.web.extensions.AbstractJspActionFactory
prepareContext
 
Methods inherited from class net.sf.basedb.clients.web.extensions.AbstractJspFactory
getScripts, getStylesheets, prepareContext, setScript, setStylesheet
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

actions

private TabAction[] actions

id

private String id

clazz

private String clazz

style

private String style

title

private String title

tooltip

private String tooltip

helpId

private String helpId

visible

private boolean visible

onValidate

private String onValidate

onActivate

private String onActivate

content

private String content
Constructor Detail

FixedTabFactory

public FixedTabFactory()
Create a new factory instance.

Method Detail

getActions

public TabAction[] getActions(InvokationContext context)
Description copied from interface: ActionFactory
This method may be called one or several times for each request. This is decided by the extension point. If, for example, the extension point is a pure single-item extension point then this method is probably only called once. If the extension point is a per-item extension point in a list context, then this method may be called once for every item in the list. The context parameter contains all information about the context of the extension point, including the current item, if any.

Specified by:
getActions in interface ActionFactory<TabAction>
Parameters:
context - The current invokation context
Returns:
An array of actions that should be added to the extension point. Returns null or an empty array if there are no actions in the current context.

getId

public String getId()
Description copied from interface: TabAction
ID attribute of the main tab tag. You need to set this value to reference the tab in a javascript.

Specified by:
getId in interface TabAction
Returns:
The ID, or null

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

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

getTitle

public String getTitle()
Description copied from interface: TabAction
Get the title of the tab.

Specified by:
getTitle in interface TabAction

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

isVisible

public boolean isVisible()
Description copied from interface: TabAction
If the tab should be visible or not.

Specified by:
isVisible in interface TabAction

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

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

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

getContent

public String getContent()
Description copied from interface: TabAction
Get the (HTML) contents of the tab.

Specified by:
getContent in interface TabAction

setId

public void setId(String id)

setClazz

public void setClazz(String clazz)

setStyle

public void setStyle(String style)

setTitle

public void setTitle(String title)

setTooltip

public void setTooltip(String tooltip)

setVisible

public void setVisible(boolean visible)

setVisible

public void setVisible(String visible)

setHelpId

public void setHelpId(String helpId)

setOnValidate

@VariableSetter
public void setOnValidate(String onValidate)

setOnActivate

@VariableSetter
public void setOnActivate(String onActivate)

setContent

public void setContent(String content)

2.17.2: 2011-06-17