org.olat.lms.framework.common.contexthelp

类 ContextHelpModule

java.lang.Object

org.olat.system.commons.configuration.AbstractOLATModule

org.olat.lms.framework.common.contexthelp.ContextHelpModule

所有已实现的接口:

Destroyable, Initializable, GenericEventListener

public class ContextHelpModule
extends AbstractOLATModule
implements Destroyable

Description:

The context help module offers configuration methods for the context help system

Initial Date: 31.10.2008

作者:

Florian Gnaegi, frentix GmbH, http://www.frentix.com

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	CHELP_DIR
static java.lang.String	CHELP_STATIC_DIR

方法概要

方法

限定符和类型	方法和说明
void	destroy() shutdown, when overriding this method do not forget to call super.destory() as well...
static java.util.Set<java.lang.String>	getAllContextHelpPages()
static java.util.Map<java.lang.String,java.lang.String>	getContextHelpPagesLegacyLookupIndex()
void	initialize() when using abstractOLATModule this method gets called by the framework on startup
static boolean	isContextHelpEnabled()
static boolean	isContextRatingEnabled()
static void	refreshContextHelpIndex()
void	setCHelpBlacklist(java.util.Set<java.lang.String> blackist) [used by spring]

从类继承的方法 org.olat.system.commons.configuration.AbstractOLATModule

event, init, isControllerAndNotDisposed, setDefaultProperties, setPersistedProperties

从类继承的方法 java.lang.Object

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

字段详细资料

CHELP_DIR

public static final java.lang.String CHELP_DIR

另请参阅:

常量字段值

CHELP_STATIC_DIR

public static final java.lang.String CHELP_STATIC_DIR

另请参阅:

常量字段值

方法详细资料

initialize

public void initialize()

从类复制的说明: AbstractOLATModule

when using abstractOLATModule this method gets called by the framework on startup

指定者:

initialize 在类中 AbstractOLATModule

setCHelpBlacklist

public void setCHelpBlacklist(java.util.Set<java.lang.String> blackist)

[used by spring]

参数:

blackist -

destroy

public void destroy()

从类复制的说明: AbstractOLATModule

shutdown, when overriding this method do not forget to call super.destory() as well...

指定者:

destroy 在接口中 Destroyable

覆盖:

destroy 在类中 AbstractOLATModule

refreshContextHelpIndex

public static void refreshContextHelpIndex()

isContextHelpEnabled

public static boolean isContextHelpEnabled()

返回:

true: use context help; false: don't show context help

isContextRatingEnabled

public static boolean isContextRatingEnabled()

返回:

true: allow users to rate help pages; false: don't allow users to rate help pages

getContextHelpPagesLegacyLookupIndex

public static java.util.Map<java.lang.String,java.lang.String> getContextHelpPagesLegacyLookupIndex()

返回:

lookup map that can be used to find the package of a page when only the page name is known (legacy mode)

getAllContextHelpPages

public static java.util.Set<java.lang.String> getAllContextHelpPages()

返回:

Set containing all help pages using the combined format: package.name:page_name.html