Class FixedStartPageFactory
java.lang.Object
net.sf.basedb.clients.web.extensions.AbstractJspFactory
net.sf.basedb.clients.web.extensions.AbstractJspActionFactory<StartPageAction>
net.sf.basedb.clients.web.extensions.startpage.FixedStartPageFactory
- All Implemented Interfaces:
DynamicActionAttributes
,StartPageAction
,Action
,ActionFactory<StartPageAction>
public class FixedStartPageFactory
extends AbstractJspActionFactory<StartPageAction>
implements StartPageAction
A simple start page action factory. Use the
parameters to set name, description and URL. The
ID is autoamtically set to the ID of the extension.
The
setUrl(String)
method supports path
variables. See PathConverter
.- Since:
- 3.8
- Author:
- nicklas
-
Field Summary
Modifier and TypeFieldDescriptionprivate StartPageAction[]
private String
private String
private String
private String
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetActions
(InvokationContext<? super StartPageAction> context) This method may be called one or several times for each request.Get an optional description of the start page.getId()
Get the ID of the the action.getName()
Get the name of the start page.getUrl()
Get the URL to the start page.void
setDescription
(String description) void
void
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
-
Field Details
-
actions
-
id
-
name
-
description
-
url
-
-
Constructor Details
-
FixedStartPageFactory
public FixedStartPageFactory()Create a new factory instance.
-
-
Method Details
-
getActions
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 interfaceActionFactory<StartPageAction>
- Parameters:
context
- The current invokation context- Returns:
- Always an array with a single element
-
getId
Description copied from interface:StartPageAction
Get the ID of the the action. This ID is stored as a user setting in BASE and is used to find the correct URL after logging in. It is recommended that an extension use the same ID as the extension itself have.- Specified by:
getId
in interfaceStartPageAction
-
getName
Description copied from interface:StartPageAction
Get the name of the start page.- Specified by:
getName
in interfaceStartPageAction
-
getDescription
Description copied from interface:StartPageAction
Get an optional description of the start page.- Specified by:
getDescription
in interfaceStartPageAction
-
getUrl
Description copied from interface:StartPageAction
Get the URL to the start page. The URL should be be an absolute URL. Use$SESSION-ID$
as a placeholder for the current session id. Eg.my_alternate_startpage.jsp?ID=$SESSION-ID$
- Specified by:
getUrl
in interfaceStartPageAction
- Returns:
- The URL to the page to load, or null to load the regular start page
-
setName
-
setDescription
-
setUrl
-