org.broadleafcommerce.openadmin.client

Class AbstractModule

java.lang.Object

org.broadleafcommerce.openadmin.client.AbstractModule

All Implemented Interfaces:

com.google.gwt.core.client.EntryPoint, Module

Direct Known Subclasses:

AbstractHtmlEditingModule, CustomerCareModule, MerchandisingModule, SandBoxModule, UserManagementModule

public abstract class AbstractModule
extends Object
implements com.google.gwt.core.client.EntryPoint, Module

Author:

jfischer

Field Summary

Fields

Modifier and Type	Field and Description
protected String	moduleKey
protected String	moduleTitle
protected Integer	order
protected LinkedHashMap<String,String[]>	pages
protected List<Section>	sections

Constructor Summary

Constructors

Constructor and Description
AbstractModule()

Method Summary

Methods

Modifier and Type	Method and Description
void	addConstants(i18nConstants constants)
void	addStandardSection(String modulePrefix, String basePackageName) Calls setSection using module standards for the arguments.
String	getModuleKey()
String	getModuleTitle()
Integer	getOrder()
LinkedHashMap<String,String[]>	getPages()
protected List<Section>	getSections()
void	onModuleLoad()
void	postDraw()
void	preDraw()
void	registerModule()
void	removeSection(String sectionTitle)
void	setModuleKey(String moduleKey) If 2 modules have the same key, the sections in that module are merged together.
void	setModuleTitle(String moduleTitle)
void	setOrder(Integer order)
void	setSection(String sectionTitle, String sectionViewKey, String sectionViewClass, String sectionPresenterKey, String sectionPresenterClass, List<String> sectionPermissions)
protected void	setSections(List<Section> sections)
void	setSecurity(String sectionViewKey, List<String> sectionPermissions)

Methods inherited from class java.lang.Object

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

Field Detail

pages

protected LinkedHashMap<String,String[]> pages

moduleTitle

protected String moduleTitle

moduleKey

protected String moduleKey

order

protected Integer order

sections

protected List<Section> sections

Constructor Detail

AbstractModule

public AbstractModule()

Method Detail

registerModule

public void registerModule()

getModuleTitle

public String getModuleTitle()

Specified by:

getModuleTitle in interface Module

setModuleTitle

public void setModuleTitle(String moduleTitle)

getModuleKey

public String getModuleKey()

Specified by:

getModuleKey in interface Module

setModuleKey

public void setModuleKey(String moduleKey)

If 2 modules have the same key, the sections in that module are merged together. For instance, if you wanted to add a new section to the merchandising module, you would create a new AbstractModule subclass and call this method with the same key as the Merchandising module

Parameters:

moduleKey -

addConstants

public void addConstants(i18nConstants constants)

addStandardSection

public void addStandardSection(String modulePrefix,
                      String basePackageName)

Calls setSection using module standards for the arguments. Prefix: title cased name of the module (e.g. moduleName) Base package: root package of the module admin classes (e.g. com.broadleafcommerce.modulename.admin) For example, for the prefix "SampleModule" and base package would call as follows: setSection(BLCMain.getMessageManager().getString("sampleModuleMainTitle"), "sampleModuleView", "com.broadleafcommerce.samplemodule.admin.SampleModuleView", "sampleModulePresenter", "com.broadleafcommerce.samplemodule.admin.SampleModulePresenter", sampleModulePermissions); The permissions in the above method call will be created as follows: List sampleModulePermissions = new ArrayList(); sampleModulePermissions.add("PERMISSION_CREATE_SAMPLEMODULE"); sampleModulePermissions.add("PERMISSION_UPDATE_SAMPLEMODULE"); sampleModulePermissions.add("PERMISSION_DELETE_SAMPLEMODULE"); sampleModulePermissions.add("PERMISSION_READ_SAMPLEMODULE");

Parameters:

modulePrefix -

setSection

public void setSection(String sectionTitle,
              String sectionViewKey,
              String sectionViewClass,
              String sectionPresenterKey,
              String sectionPresenterClass,
              List<String> sectionPermissions)

setSecurity

public void setSecurity(String sectionViewKey,
               List<String> sectionPermissions)

removeSection

public void removeSection(String sectionTitle)

getPages

public LinkedHashMap<String,String[]> getPages()

Specified by:

getPages in interface Module

postDraw

public void postDraw()

Specified by:

postDraw in interface Module

preDraw

public void preDraw()

Specified by:

preDraw in interface Module

getOrder

public Integer getOrder()

Specified by:

getOrder in interface Module

setOrder

public void setOrder(Integer order)

Specified by:

setOrder in interface Module

getSections

protected List<Section> getSections()

setSections

protected void setSections(List<Section> sections)

onModuleLoad

public void onModuleLoad()

Specified by:

onModuleLoad in interface com.google.gwt.core.client.EntryPoint