类 org.opencms.module.CmsModule
的使用

使用CmsModule的程序包

程序包	说明
org.opencms.module	OpenCms modules provide a powerful, standardized way to extend the core OpenCms functionality.
org.opencms.setup	Used during the initial setup of the database by the OpenCms setup wizard.
org.opencms.workplace	The base classes for the OpenCms Workplace (standard dialog, tab dialog, report based dialog) and the Workplace configuration classes are located here.
org.opencms.workplace.tools.modules	This package contains the tool classes for the module management related administration views.

org.opencms.module中CmsModule的使用

返回CmsModule的org.opencms.module中的方法

限定符和类型	方法和说明
CmsModule	CmsModuleXmlHandler.getModule() Returns the generated module.
CmsModule	CmsModuleManager.getModule(java.lang.String name) Returns the module with the given module name, or null if no module with the given name is configured.
static CmsModule	CmsModuleImportExportHandler.readModuleFromImport(java.lang.String importResource) Reads a module object from an external file source.

返回变量类型为CmsModule的类型的org.opencms.module中的方法

限定符和类型	方法和说明
java.util.List<CmsModule>	CmsModuleManager.getAllInstalledModules() Returns a list of installed modules.
static java.util.Map<CmsModule,java.lang.String>	CmsModuleManager.getAllModulesFromPath(java.lang.String rfsAbsPath) Returns a map of modules found in the given RFS absolute path.

参数类型为CmsModule的org.opencms.module中的方法

限定符和类型	方法和说明
void	CmsModuleManager.addModule(CmsObject cms, CmsModule module) Adds a new module to the module manager.
java.util.List<CmsModuleDependency>	CmsModuleManager.checkDependencies(CmsModule module, int mode) Checks if a modules dependencies are fulfilled.
CmsModuleDependency	CmsModule.checkDependency(CmsModule module) Checks if this module depends on another given module, will return the dependency, or null if no dependency was found.
int	CmsModule.compareTo(CmsModule obj)
static org.dom4j.Element	CmsModuleXmlHandler.generateXml(CmsModule module) Generates a detached XML element for a module.
void	I_CmsModuleAction.initialize(CmsObject adminCms, CmsConfigurationManager configurationManager, CmsModule module) Will be called by the OpenCms system during server startup.
void	A_CmsModuleAction.initialize(CmsObject adminCms, CmsConfigurationManager configurationManager, CmsModule module)
boolean	CmsModule.isIdentical(CmsModule other) Checks if this module is identical with another module.
void	I_CmsModuleAction.moduleUninstall(CmsModule module) Will be called if a module is uninstalled from an OpenCms system.
void	A_CmsModuleAction.moduleUninstall(CmsModule module)
void	I_CmsModuleAction.moduleUpdate(CmsModule module) Will be called if the module this action instance belongs to is updated.
void	A_CmsModuleAction.moduleUpdate(CmsModule module)
void	I_CmsModuleAction.shutDown(CmsModule module) Will be called by the OpenCms system during server shutdown.
void	A_CmsModuleAction.shutDown(CmsModule module)
void	CmsModuleManager.updateModule(CmsObject cms, CmsModule module) Updates a already configured module with new values.

类型变量类型为CmsModule的org.opencms.module中的构造器参数

构造器和说明
CmsModuleManager(java.util.List<CmsModule> configuredModules) Basic constructor.

org.opencms.setup中CmsModule的使用

类型参数类型为CmsModule的org.opencms.setup中的字段

限定符和类型	字段和说明
protected java.util.Map<java.lang.String,CmsModule>	CmsSetupBean.m_availableModules A map with all available modules.

返回变量类型为CmsModule的类型的org.opencms.setup中的方法

限定符和类型	方法和说明
java.util.Map<java.lang.String,CmsModule>	CmsSetupBean.getAvailableModules() Returns a map with all available modules.

参数类型为CmsModule的org.opencms.setup中的方法

限定符和类型	方法和说明
java.lang.String	CmsSetupBean.getDisplayForModule(CmsModule module) Returns the display string for a given module.
protected java.lang.String	CmsSetupBean.htmlModule(CmsModule module, int pos) Returns html for the given module to fill the selection list.

类型变量类型为CmsModule的org.opencms.setup中的方法参数

限定符和类型	方法和说明
java.util.List<java.lang.String>	CmsSetupBean.sortModules(java.util.Collection<CmsModule> modules) Sorts the modules for display.

org.opencms.workplace中CmsModule的使用

参数类型为CmsModule的org.opencms.workplace中的方法

限定符和类型	方法和说明
void	CmsWorkplaceManager.addExplorerTypeSettings(CmsModule module) Adds the list of explorer type settings from the given module.
void	CmsWorkplaceAction.initialize(CmsObject adminCms, CmsConfigurationManager configurationManager, CmsModule module)
void	CmsWorkplaceManager.removeExplorerTypeSettings(CmsModule module) Removes the list of explorer type settings from the given module.

org.opencms.workplace.tools.modules中CmsModule的使用

声明为CmsModule的org.opencms.workplace.tools.modules中的字段

限定符和类型	字段和说明
protected CmsModule	CmsModulesEditBase.m_module The module object that is edited on this dialog.