org.opencms.widgets

类 A_CmsNativeComplexWidget

java.lang.Object

org.opencms.widgets.A_CmsNativeComplexWidget

所有已实现的接口:

I_CmsComplexWidget

public abstract class A_CmsNativeComplexWidget
extends java.lang.Object
implements I_CmsComplexWidget

This is an abstract class which you can inherit from to relatively easily implement complex widgets for rendering nested contents in Javascript.

Subclasses of this class only need to implement the methods getScripts(), getStyleSheets(), getName(), and configure(). The name of the initialization function is generated by prepending the string "init_" to the widget name returned by getName().

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	INIT_FUNCTION_PREFIX The prefix which is prepended to the widget name to get the name of the initialization function.
protected java.lang.String	m_configuration The configuration string.
protected java.util.Map<java.lang.String,java.lang.String>	m_configurationMap The configuration map created from the configuration string.
protected JSONObject	m_jsonConfig The configuration map in JSON format.

构造器概要

构造器

构造器和说明
A_CmsNativeComplexWidget()

方法概要

方法

限定符和类型	方法和说明
abstract java.lang.String	getName() Gets the name of the complex widget.
abstract java.util.List<java.lang.String>	getScripts(CmsObject cms) Gets the list of URLs of scripts which the widget reuires.
abstract java.util.List<java.lang.String>	getStyleSheets(CmsObject cms) Gets the list of URLs of stylesheets which are required by the widget.
CmsComplexWidgetData	getWidgetData(CmsObject cms) Gets the data needed for the editor to render the complex widget.
void	initConfiguration(java.lang.String config) Initializes the configuration date from the given configuration string.

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

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

从接口继承的方法 org.opencms.widgets.I_CmsComplexWidget

configure

字段详细资料

INIT_FUNCTION_PREFIX

public static final java.lang.String INIT_FUNCTION_PREFIX

The prefix which is prepended to the widget name to get the name of the initialization function.

另请参阅:

常量字段值

m_configuration

protected java.lang.String m_configuration

The configuration string.

m_configurationMap

protected java.util.Map<java.lang.String,java.lang.String> m_configurationMap

The configuration map created from the configuration string.

m_jsonConfig

protected JSONObject m_jsonConfig

The configuration map in JSON format.

构造器详细资料

A_CmsNativeComplexWidget

public A_CmsNativeComplexWidget()

方法详细资料

getName

public abstract java.lang.String getName()

从接口复制的说明: I_CmsComplexWidget

Gets the name of the complex widget.

The string returned by this function should be a valid Javascript identifier.

指定者:

getName 在接口中 I_CmsComplexWidget

返回:

the name of the complex widget

另请参阅:

The result of this method will be used to determine the initialization function name for the widget by prepending the prefix "init_". For example, if "foo" is returned by this method, "init_foo" will be used as the initialization function name.

getScripts

public abstract java.util.List<java.lang.String> getScripts(CmsObject cms)

Gets the list of URLs of scripts which the widget reuires.

参数:

cms - the current CMS context

返回:

the list of URLs of scripts needed by the widget

getStyleSheets

public abstract java.util.List<java.lang.String> getStyleSheets(CmsObject cms)

Gets the list of URLs of stylesheets which are required by the widget.

参数:

cms - the current CMS context

返回:

the list of URLs of stylesheets needed by the widget

getWidgetData

public final CmsComplexWidgetData getWidgetData(CmsObject cms)

从接口复制的说明: I_CmsComplexWidget

Gets the data needed for the editor to render the complex widget.

指定者:

getWidgetData 在接口中 I_CmsComplexWidget

参数:

cms - The CMS object to use for VFS operations

返回:

the data for the complex widget

另请参阅:

I_CmsComplexWidget.getWidgetData(org.opencms.file.CmsObject)

initConfiguration

public final void initConfiguration(java.lang.String config)

Initializes the configuration date from the given configuration string.

This should be called by subclasses of this class.

参数:

config - the widget configuration string