Class IncludeContentSectionFactory
- java.lang.Object
-
- net.sf.basedb.clients.web.extensions.AbstractJspFactory
-
- net.sf.basedb.clients.web.extensions.AbstractJspActionFactory<SectionAction>
-
- net.sf.basedb.clients.web.extensions.section.IncludeContentSectionFactory
-
- All Implemented Interfaces:
DynamicActionAttributes
,ActionFactory<SectionAction>
public class IncludeContentSectionFactory extends AbstractJspActionFactory<SectionAction>
A section action factory implementation that includes another resource as the content of a section. The other resource can be a JSP script, servlet, a static file, or anything else that makes sense.The current
JspContext
is stored as aServletRequest
attribute with keyJspContext.ATTRIBUTE_KEY
. If the included page is a JSP page it can get the JspContext by callingrequest.getAttribute(JspContext.ATTRIBUTE_KEY)
.Use the
AbstractJspFactory.setScript(String)
andAbstractJspFactory.setStylesheet(String)
methods. Each call to these methods will add the argument to a set. Use theAbstractJspFactory.getScripts()
andAbstractJspFactory.getStylesheets()
methods to gain access to the sets, for example, to remove added items.Note that this factory will accept and generate content for all nodes (including folder nodes). If only some nodes should be used, the factory should be subclassed and override the
AbstractJspActionFactory.prepareContext(InvokationContext)
method.- Since:
- 3.2
- Author:
- nicklas
- Last modified
- $Date$
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) class
IncludeContentSectionFactory.Section
-
Constructor Summary
Constructors Constructor Description IncludeContentSectionFactory()
Create a new factory instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SectionAction[]
getActions(InvokationContext<? super SectionAction> context)
This method may be called one or several times for each request.void
setContentStyle(String contentStyle)
void
setHideClazz(String hideClazz)
void
setId(String id)
void
setInclude(String include)
void
setShowClazz(String showClazz)
void
setStyle(String style)
void
setTitle(String title)
-
Methods inherited from class net.sf.basedb.clients.web.extensions.AbstractJspActionFactory
prepareContext
-
Methods inherited from class net.sf.basedb.clients.web.extensions.AbstractJspFactory
getDynamicActionAttributes, getParameter, getScripts, getStylesheets, prepareContext, setParameter, setScript, setStylesheet
-
-
-
-
Method Detail
-
getActions
public SectionAction[] getActions(InvokationContext<? super SectionAction> 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)
-
setShowClazz
public void setShowClazz(String showClazz)
-
setHideClazz
public void setHideClazz(String hideClazz)
-
setStyle
public void setStyle(String style)
-
setContentStyle
public void setContentStyle(String contentStyle)
-
setTitle
public void setTitle(String title)
-
setInclude
@PathSetter(pathType=CONTEXT_RELATIVE) public void setInclude(String include)
-
-