Package org.javlo.module.core

Class AbstractModuleContext

java.lang.Object

org.javlo.module.core.AbstractModuleContext

Direct Known Subclasses:

CommunicationModuleContext, ContentModuleContext, FileModuleContext, MacroModuleContext, MailingModuleContext

public abstract class AbstractModuleContext
extends Object

represent the context of a module, for create a context extends this class and for instanciate you class use getInstance with you class for implementationClass param.

Author:

Patrick Vandermaesen

Field Summary

Fields

Modifier and Type	Field	Description
protected GlobalContext	globalContext
protected I18nAccess	i18nAccess
protected Module	module

Constructor Summary

Constructors

Constructor	Description
AbstractModuleContext()

Method Summary

Modifier and Type	Method	Description
static AbstractModuleContext	getCurrentInstance(javax.servlet.http.HttpSession session)
String	getCurrentLink()
List<LinkToRenderer>	getFlatNavigation()
abstract LinkToRenderer	getHomeLink()
static AbstractModuleContext	getInstance(javax.servlet.http.HttpSession session, GlobalContext globalContext, Module module, Class<? extends AbstractModuleContext> implementationClass)
abstract List<LinkToRenderer>	getNavigation()	get the navigation of the module
String	getRenderer()
int	getWizardStep(String boxName)
abstract void	init()
void	setCurrentLink(String currentLink)
void	setRenderer(String renderer)
void	setRendererFromNavigation(String renderer)	when user click on a generic navigation, navigation engine call this method for change the renderer, by default module.setRenderer is called but it can be the renderer of a box.
void	setWizardStep(String boxName, Integer wizardStep)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

i18nAccess

protected I18nAccess i18nAccess

module

protected Module module

globalContext

protected GlobalContext globalContext

Constructor Detail

AbstractModuleContext

public AbstractModuleContext()

Method Detail

getInstance

public static final AbstractModuleContext getInstance(javax.servlet.http.HttpSession session,
                                                      GlobalContext globalContext,
                                                      Module module,
                                                      Class<? extends AbstractModuleContext> implementationClass)
                                               throws FileNotFoundException,
                                                      IOException,
                                                      InstantiationException,
                                                      IllegalAccessException

Throws:

FileNotFoundException

IOException

InstantiationException

IllegalAccessException

getCurrentInstance

public static final AbstractModuleContext getCurrentInstance(javax.servlet.http.HttpSession session)

getNavigation

public abstract List<LinkToRenderer> getNavigation()

get the navigation of the module

Returns:

getFlatNavigation

public List<LinkToRenderer> getFlatNavigation()

getHomeLink

public abstract LinkToRenderer getHomeLink()

init

public abstract void init()

getCurrentLink

public String getCurrentLink()

setCurrentLink

public void setCurrentLink(String currentLink)

setRendererFromNavigation

public void setRendererFromNavigation(String renderer)

when user click on a generic navigation, navigation engine call this method for change the renderer, by default module.setRenderer is called but it can be the renderer of a box.

Parameters:

renderer - link to a jsp file.

getRenderer

public String getRenderer()

setRenderer

public void setRenderer(String renderer)

getWizardStep

public int getWizardStep(String boxName)

setWizardStep

public void setWizardStep(String boxName,
                          Integer wizardStep)