org.opencms.jsp.util

类 CmsJspLinkMacroResolver

java.lang.Object

org.opencms.jsp.util.CmsJspLinkMacroResolver

所有已实现的接口:

I_CmsMacroResolver

public class CmsJspLinkMacroResolver
extends java.lang.Object
implements I_CmsMacroResolver

Resolves link macros for jsp pages.

The only supported macro is the 'link' macro.

从以下版本开始:

6.5.4

字段概要

字段

限定符和类型	字段和说明
static char	KEY_SEPARATOR Identifier for the link macro separator.
static java.lang.String	MACRO_LINK Identifier for the link macro name.
static java.lang.String	MACRO_LINK_STRONG Identifier for the link macro name.
static java.lang.String	MACRO_LINK_WEAK Identifier for the link macro name.
static java.lang.String[]	VALUE_NAME_ARRAY Identifier for link commands.
static java.util.List<java.lang.String>	VALUE_NAMES The link commands wrapped in a List.

从接口继承的字段 org.opencms.util.I_CmsMacroResolver

MACRO_DELIMITER, MACRO_DELIMITER_OLD, MACRO_END, MACRO_END_OLD, MACRO_START, MACRO_START_OLD

构造器概要

构造器

构造器和说明
CmsJspLinkMacroResolver(CmsObject cms, java.lang.String jspRootPath, boolean forRfs) Default constructor.

方法概要

方法

限定符和类型	方法和说明
java.util.List<CmsLink>	getLinks() Returns the links.
java.lang.String	getMacroValue(java.lang.String macro) Resolves a single macro to the macro value, returns null if the macro could not be resolved.
boolean	isKeepEmptyMacros() Returns true if macros that could not be resolved are kept "as is" in the input String, false if they are replaced by an empty String.
java.lang.String	resolveMacros(java.lang.String input) Resolves the JSP link management macros in the given input.

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

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

字段详细资料

KEY_SEPARATOR

public static final char KEY_SEPARATOR

Identifier for the link macro separator.

另请参阅:

常量字段值

MACRO_LINK

public static final java.lang.String MACRO_LINK

Identifier for the link macro name.

另请参阅:

常量字段值

MACRO_LINK_STRONG

public static final java.lang.String MACRO_LINK_STRONG

Identifier for the link macro name.

另请参阅:

常量字段值

MACRO_LINK_WEAK

public static final java.lang.String MACRO_LINK_WEAK

Identifier for the link macro name.

另请参阅:

常量字段值

VALUE_NAME_ARRAY

public static final java.lang.String[] VALUE_NAME_ARRAY

Identifier for link commands.

VALUE_NAMES

public static final java.util.List<java.lang.String> VALUE_NAMES

The link commands wrapped in a List.

构造器详细资料

CmsJspLinkMacroResolver

public CmsJspLinkMacroResolver(CmsObject cms,
                       java.lang.String jspRootPath,
                       boolean forRfs)

Default constructor.

参数:

cms - the cms context

jspRootPath - the (optional) jsp root path, needed for saving from the editor to resolve relative links

forRfs - Only if true the macros get really resolved to valid vfs paths

方法详细资料

getLinks

public java.util.List<CmsLink> getLinks()

Returns the links.

返回:

the links

getMacroValue

public java.lang.String getMacroValue(java.lang.String macro)

从接口复制的说明: I_CmsMacroResolver

Resolves a single macro to the macro value, returns null if the macro could not be resolved.

指定者:

getMacroValue 在接口中 I_CmsMacroResolver

参数:

macro - the macro to resolve

返回:

the resolved macro or null if the macro could not be resolved

另请参阅:

I_CmsMacroResolver.getMacroValue(java.lang.String)

isKeepEmptyMacros

public boolean isKeepEmptyMacros()

从接口复制的说明: I_CmsMacroResolver

Returns true if macros that could not be resolved are kept "as is" in the input String, false if they are replaced by an empty String.

指定者:

isKeepEmptyMacros 在接口中 I_CmsMacroResolver

返回:

true if macros that could not be resolved are kept "as is" in the input String, false if they are replaced by an empty String

另请参阅:

I_CmsMacroResolver.isKeepEmptyMacros()

resolveMacros

public java.lang.String resolveMacros(java.lang.String input)

Resolves the JSP link management macros in the given input.

Calls resolveMacros(String) once for each macro in the input. This means "nested" macros are not supported in this implementation, which is fine since it can't happen in JSP link management anyway.

指定者:

resolveMacros 在接口中 I_CmsMacroResolver

参数:

input - the input to resolve the macros in

返回:

the input with all macros resolved

另请参阅:

I_CmsMacroResolver.resolveMacros(java.lang.String)