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

java.lang.Object
  net.sf.basedb.clients.web.extensions.AbstractJspFactory
      net.sf.basedb.clients.web.extensions.AbstractJspActionFactory<TabAction>
          net.sf.basedb.clients.web.extensions.tabcontrol.IncludeContentTabFactory

All Implemented Interfaces:

ActionFactory<TabAction>

public class IncludeContentTabFactory
extends AbstractJspActionFactory<TabAction>

A tab action factory implementation that includes another resource as the content of tab. The other resource can be a JSP script, servlet, a static file, or anything else that makes sense.

The current JspContext is stored as a ServletRequest attribute with key JspContext.ATTRIBUTE_KEY. If the included page is a JSP page it can get the JspContext by calling request.getAttribute(JspContext.ATTRIBUTE_KEY).

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-11 08:57:08 +0100 (Thu, 11 Nov 2010) $

Nested Class Summary

(package private) class

IncludeContentTabFactory.Tab

Field Summary

private String	clazz
private String	helpId
private String	id
private String	include
private String	onActivate
private String	onValidate
private String	style
private String	title
private String	tooltip
private boolean	visible

Constructor Summary

IncludeContentTabFactory()
Create a new factory instance.

Method Summary

TabAction[]	getActions(InvokationContext context) This method may be called one or several times for each request.
void	setClazz(String clazz)
void	setHelpId(String helpId)
void	setId(String id)
void	setInclude(String include)
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

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

include

private String include

Constructor Detail

IncludeContentTabFactory

public IncludeContentTabFactory()

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.

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.

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)

setInclude

@PathSetter(pathType=CONTEXT_RELATIVE)
public void setInclude(String include)