org.opencms.ade.configuration.formatters

类 CmsFormatterBeanParser

java.lang.Object

org.opencms.ade.configuration.formatters.CmsFormatterBeanParser

public class CmsFormatterBeanParser
extends java.lang.Object

Parses formatter beans from formatter configuration XML contents.

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	CmsFormatterBeanParser.ParseException Exception for the errors in the configuration file not covered by other exception types.

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	N_AUTO_ENABLED Content value node name.
static java.lang.String	N_CHOICE_NEW_LINK Content value node name.
static java.lang.String	N_CONTAINER_TYPE Content value node name.
static java.lang.String	N_CSS_INLINE Content value node name.
static java.lang.String	N_CSS_LINK Content value node name.
static java.lang.String	N_DETAIL Content value node name.
static java.lang.String	N_HEAD_INCLUDE_CSS Content value node name.
static java.lang.String	N_HEAD_INCLUDE_JS Content value node name.
static java.lang.String	N_JAVASCRIPT_INLINE Content value node name.
static java.lang.String	N_JAVASCRIPT_LINK Content value node name.
static java.lang.String	N_JSP Content value node name.
static java.lang.String	N_MATCH Content value node name.
static java.lang.String	N_MAX_WIDTH Content value node name.
static java.lang.String	N_NICE_NAME Content value node name.
static java.lang.String	N_PREVIEW Content value node name.
static java.lang.String	N_RANK Content value node name.
static java.lang.String	N_SEARCH_CONTENT Content value node name.
static java.lang.String	N_SETTING Content value node name.
static java.lang.String	N_TYPE Content value node name.
static java.lang.String	N_TYPES Content value node name.
static java.lang.String	N_WIDTH Content value node name.

构造器概要

构造器

构造器和说明
CmsFormatterBeanParser(CmsObject cms) Creates a new parser instance.

方法概要

方法

限定符和类型	方法和说明
CmsFormatterBean	parse(CmsXmlContent content, java.lang.String location, java.lang.String id) Reads the formatter bean from the given XML content.
static java.lang.String	path(java.lang.String... components) Creates an xpath from the given components.

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

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

字段详细资料

N_AUTO_ENABLED

public static final java.lang.String N_AUTO_ENABLED

Content value node name.

另请参阅:

常量字段值

N_CHOICE_NEW_LINK

public static final java.lang.String N_CHOICE_NEW_LINK

Content value node name.

另请参阅:

常量字段值

N_CONTAINER_TYPE

public static final java.lang.String N_CONTAINER_TYPE

Content value node name.

另请参阅:

常量字段值

N_CSS_INLINE

public static final java.lang.String N_CSS_INLINE

Content value node name.

另请参阅:

常量字段值

N_CSS_LINK

public static final java.lang.String N_CSS_LINK

Content value node name.

另请参阅:

常量字段值

N_DETAIL

public static final java.lang.String N_DETAIL

Content value node name.

另请参阅:

常量字段值

N_HEAD_INCLUDE_CSS

public static final java.lang.String N_HEAD_INCLUDE_CSS

Content value node name.

另请参阅:

常量字段值

N_HEAD_INCLUDE_JS

public static final java.lang.String N_HEAD_INCLUDE_JS

Content value node name.

另请参阅:

常量字段值

N_JAVASCRIPT_INLINE

public static final java.lang.String N_JAVASCRIPT_INLINE

Content value node name.

另请参阅:

常量字段值

N_JAVASCRIPT_LINK

public static final java.lang.String N_JAVASCRIPT_LINK

Content value node name.

另请参阅:

常量字段值

N_JSP

public static final java.lang.String N_JSP

Content value node name.

另请参阅:

常量字段值

N_MATCH

public static final java.lang.String N_MATCH

Content value node name.

另请参阅:

常量字段值

N_MAX_WIDTH

public static final java.lang.String N_MAX_WIDTH

Content value node name.

另请参阅:

常量字段值

N_NICE_NAME

public static final java.lang.String N_NICE_NAME

Content value node name.

另请参阅:

常量字段值

N_PREVIEW

public static final java.lang.String N_PREVIEW

Content value node name.

另请参阅:

常量字段值

N_RANK

public static final java.lang.String N_RANK

Content value node name.

另请参阅:

常量字段值

N_SEARCH_CONTENT

public static final java.lang.String N_SEARCH_CONTENT

Content value node name.

另请参阅:

常量字段值

N_SETTING

public static final java.lang.String N_SETTING

Content value node name.

另请参阅:

常量字段值

N_TYPE

public static final java.lang.String N_TYPE

Content value node name.

另请参阅:

常量字段值

N_TYPES

public static final java.lang.String N_TYPES

Content value node name.

另请参阅:

常量字段值

N_WIDTH

public static final java.lang.String N_WIDTH

Content value node name.

另请参阅:

常量字段值

构造器详细资料

CmsFormatterBeanParser

public CmsFormatterBeanParser(CmsObject cms)

Creates a new parser instance.

A new parser instance should be created for every formatter configuration you want to parse.

参数:

cms - the CMS context to use for parsing

方法详细资料

path

public static java.lang.String path(java.lang.String... components)

Creates an xpath from the given components.

参数:

components - the xpath componentns

返回:

the composed xpath

parse

public CmsFormatterBean parse(CmsXmlContent content,
                     java.lang.String location,
                     java.lang.String id)
                       throws CmsException,
                              CmsFormatterBeanParser.ParseException

Reads the formatter bean from the given XML content.

参数:

content - the formatter configuration XML content

location - a string indicating the location of the configuration

id - the id to use as the formatter id

返回:

the parsed formatter bean

抛出:

CmsFormatterBeanParser.ParseException - if parsing goes wrong

CmsException - if something else goes wrong