org.opencms.widgets

类 CmsCategoryWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.CmsCategoryWidget

所有已实现的接口:

I_CmsADEWidget, I_CmsWidget

public class CmsCategoryWidget
extends A_CmsWidget
implements I_CmsADEWidget

Provides a widget for a category based dependent select boxes.

从以下版本开始:

7.0.3

嵌套类概要

从类继承的嵌套类/接口 org.opencms.widgets.A_CmsWidget

A_CmsWidget.CmsDummyWidgetDialog

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	CONFIGURATION_CATEGORY Configuration parameter to set the category to display.
static java.lang.String	CONFIGURATION_ONLYLEAFS Configuration parameter to set the 'only leaf' flag parameter.
static java.lang.String	CONFIGURATION_PROPERTY Configuration parameter to set the 'property' parameter.

从类继承的字段 org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

构造器概要

构造器

构造器和说明
CmsCategoryWidget() Creates a new category widget.
CmsCategoryWidget(java.lang.String configuration) Creates a category widget with the specified options.

方法概要

方法

限定符和类型	方法和说明
protected java.lang.String	buildSelectBox(java.lang.String baseId, int level, java.util.List<CmsSelectWidgetOption> options, java.lang.String selected, boolean hasError, boolean last) Generates html code for the category selection.
java.lang.String	getConfiguration() Returns the configuration string.
java.lang.String	getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale) Returns the configuration string for the ADE content editor widget.
java.util.List<java.lang.String>	getCssResourceLinks(CmsObject cms) Returns a list of CSS resources required by the widget.
I_CmsXmlContentHandler.DisplayType	getDefaultDisplayType() Returns the default display type of this widget.
protected java.util.Locale	getDefaultLocale(CmsObject cms, java.lang.String resource) Returns the default locale in the content of the given resource.
java.lang.String	getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the necessary JavaScript inclusion code for this widget.
java.lang.String	getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Generates the widget HTML for the provided widget parameter.
java.lang.String	getInitCall() Returns the java script initialization call.
java.util.List<java.lang.String>	getJavaScriptResourceLinks(CmsObject cms) Returns a list of java script resources required by the widget.
protected CmsResource	getResource(CmsObject cms, I_CmsWidgetParameter param) Returns the right resource, depending on the locale.
protected java.lang.String	getStartingCategory(CmsObject cms, java.lang.String referencePath) Returns the starting category depending on the configuration options.
java.lang.String	getWidgetName() Returns the class name of the widget.
boolean	isCompactViewEnabled() Returns if the widget is compact view enabled.
boolean	isInternal() Returns if this is an internal widget.
boolean	isOnlyLeafs() Check if only leaf selection is allowed.
I_CmsWidget	newInstance() Creates a duplicate of this widget instance.
void	setConfiguration(java.lang.String configuration) Sets the configuration of this widget.
void	setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Sets the value of in the given widget parameter by reading the "right" value from the offered map of parameters.

从类继承的方法 org.opencms.widgets.A_CmsWidget

equals, getDialogHtmlEnd, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, getWidgetStringValue, hashCode

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

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

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

getDialogHtmlEnd, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpText, getWidgetStringValue

字段详细资料

CONFIGURATION_CATEGORY

public static final java.lang.String CONFIGURATION_CATEGORY

Configuration parameter to set the category to display.

另请参阅:

常量字段值

CONFIGURATION_ONLYLEAFS

public static final java.lang.String CONFIGURATION_ONLYLEAFS

Configuration parameter to set the 'only leaf' flag parameter.

另请参阅:

常量字段值

CONFIGURATION_PROPERTY

public static final java.lang.String CONFIGURATION_PROPERTY

Configuration parameter to set the 'property' parameter.

另请参阅:

常量字段值

构造器详细资料

CmsCategoryWidget

public CmsCategoryWidget()

Creates a new category widget.

CmsCategoryWidget

public CmsCategoryWidget(java.lang.String configuration)

Creates a category widget with the specified options.

参数:

configuration - the configuration for the widget

方法详细资料

getConfiguration

public java.lang.String getConfiguration()

从类复制的说明: A_CmsWidget

Returns the configuration string.

指定者:

getConfiguration 在接口中 I_CmsWidget

覆盖:

getConfiguration 在类中 A_CmsWidget

返回:

the configuration string

另请参阅:

A_CmsWidget.getConfiguration()

getConfiguration

public java.lang.String getConfiguration(CmsObject cms,
                                A_CmsXmlContentValue schemaType,
                                CmsMessages messages,
                                CmsResource resource,
                                java.util.Locale contentLocale)

从接口复制的说明: I_CmsADEWidget

Returns the configuration string for the ADE content editor widget.

指定者:

getConfiguration 在接口中 I_CmsADEWidget

参数:

cms - the OpenCms context

schemaType - the schema type

messages - the messages

resource - the edited resource

contentLocale - the content locale

返回:

the configuration string

另请参阅:

I_CmsADEWidget.getConfiguration(org.opencms.file.CmsObject, org.opencms.xml.types.A_CmsXmlContentValue, org.opencms.i18n.CmsMessages, org.opencms.file.CmsResource, java.util.Locale)

getCssResourceLinks

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

从接口复制的说明: I_CmsADEWidget

Returns a list of CSS resources required by the widget.

指定者:

getCssResourceLinks 在接口中 I_CmsADEWidget

参数:

cms - the current OpenCms context

返回:

the required CSS resource links

另请参阅:

I_CmsADEWidget.getCssResourceLinks(org.opencms.file.CmsObject)

getDefaultDisplayType

public I_CmsXmlContentHandler.DisplayType getDefaultDisplayType()

从接口复制的说明: I_CmsADEWidget

Returns the default display type of this widget.

指定者:

getDefaultDisplayType 在接口中 I_CmsADEWidget

返回:

the default display type

另请参阅:

I_CmsADEWidget.getDefaultDisplayType()

getDialogIncludes

public java.lang.String getDialogIncludes(CmsObject cms,
                                 I_CmsWidgetDialog widgetDialog)

从接口复制的说明: I_CmsWidget

Generates the necessary JavaScript inclusion code for this widget.

指定者:

getDialogIncludes 在接口中 I_CmsWidget

覆盖:

getDialogIncludes 在类中 A_CmsWidget

参数:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

返回:

the JavaScript inclusion code

另请参阅:

I_CmsWidget.getDialogIncludes(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)

getDialogWidget

public java.lang.String getDialogWidget(CmsObject cms,
                               I_CmsWidgetDialog widgetDialog,
                               I_CmsWidgetParameter param)

从接口复制的说明: I_CmsWidget

Generates the widget HTML for the provided widget parameter.

指定者:

getDialogWidget 在接口中 I_CmsWidget

参数:

cms - an initialized instance of a CmsObject

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

返回:

the widget HTML for the provided widget parameter

另请参阅:

I_CmsWidget.getDialogWidget(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

getInitCall

public java.lang.String getInitCall()

从接口复制的说明: I_CmsADEWidget

Returns the java script initialization call.

指定者:

getInitCall 在接口中 I_CmsADEWidget

返回:

the java script initialization call

另请参阅:

I_CmsADEWidget.getInitCall()

getJavaScriptResourceLinks

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

从接口复制的说明: I_CmsADEWidget

Returns a list of java script resources required by the widget.

指定者:

getJavaScriptResourceLinks 在接口中 I_CmsADEWidget

参数:

cms - the current OpenCms context

返回:

the required java script resource links

另请参阅:

I_CmsADEWidget.getJavaScriptResourceLinks(org.opencms.file.CmsObject)

getWidgetName

public java.lang.String getWidgetName()

从接口复制的说明: I_CmsADEWidget

Returns the class name of the widget.

指定者:

getWidgetName 在接口中 I_CmsADEWidget

返回:

the class name

另请参阅:

I_CmsADEWidget.getWidgetName()

isCompactViewEnabled

public boolean isCompactViewEnabled()

从接口复制的说明: I_CmsWidget

Returns if the widget is compact view enabled.

指定者:

isCompactViewEnabled 在接口中 I_CmsWidget

覆盖:

isCompactViewEnabled 在类中 A_CmsWidget

返回:

true if the widget is compact view enabled

另请参阅:

A_CmsWidget.isCompactViewEnabled()

isInternal

public boolean isInternal()

从接口复制的说明: I_CmsADEWidget

Returns if this is an internal widget.

Only widgets belonging to the OpenCms core should be marked as internal.

指定者:

isInternal 在接口中 I_CmsADEWidget

返回:

true if this is an internal widget

另请参阅:

I_CmsADEWidget.isInternal()

isOnlyLeafs

public boolean isOnlyLeafs()

Check if only leaf selection is allowed.

返回:

true, if only leaf selection is allowed

newInstance

public I_CmsWidget newInstance()

从接口复制的说明: I_CmsWidget

Creates a duplicate of this widget instance.

指定者:

newInstance 在接口中 I_CmsWidget

返回:

a duplicate of this widget instance

另请参阅:

I_CmsWidget.newInstance()

setConfiguration

public void setConfiguration(java.lang.String configuration)

从接口复制的说明: I_CmsWidget

Sets the configuration of this widget.

This can be used to enable / disable certain widget features that should not always be available, or to pass specific initialization information to the widget. It depends on the widget implementation on how this information is used.

指定者:

setConfiguration 在接口中 I_CmsWidget

覆盖:

setConfiguration 在类中 A_CmsWidget

参数:

configuration - the configuration to set

另请参阅:

A_CmsWidget.setConfiguration(java.lang.String)

setEditorValue

public void setEditorValue(CmsObject cms,
                  java.util.Map<java.lang.String,java.lang.String[]> formParameters,
                  I_CmsWidgetDialog widgetDialog,
                  I_CmsWidgetParameter param)

从接口复制的说明: I_CmsWidget

Sets the value of in the given widget parameter by reading the "right" value from the offered map of parameters.

指定者:

setEditorValue 在接口中 I_CmsWidget

覆盖:

setEditorValue 在类中 A_CmsWidget

参数:

cms - the current users OpenCms context

formParameters - the map of parameters to get the value from

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

另请参阅:

A_CmsWidget.setEditorValue(org.opencms.file.CmsObject, java.util.Map, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

buildSelectBox

protected java.lang.String buildSelectBox(java.lang.String baseId,
                              int level,
                              java.util.List<CmsSelectWidgetOption> options,
                              java.lang.String selected,
                              boolean hasError,
                              boolean last)

Generates html code for the category selection.

参数:

baseId - the widget id

level - the category deep level

options - the list of CmsSelectWidgetOption objects

selected - the selected option

hasError - if to display error message

last - if it is the last level

返回:

html code

getDefaultLocale

protected java.util.Locale getDefaultLocale(CmsObject cms,
                                java.lang.String resource)

Returns the default locale in the content of the given resource.

参数:

cms - the cms context

resource - the resource path to get the default locale for

返回:

the default locale of the resource

getResource

protected CmsResource getResource(CmsObject cms,
                      I_CmsWidgetParameter param)

Returns the right resource, depending on the locale.

参数:

cms - the cms context

param - the widget parameter

返回:

the resource to get/set the categories for

getStartingCategory

protected java.lang.String getStartingCategory(CmsObject cms,
                                   java.lang.String referencePath)

Returns the starting category depending on the configuration options.

参数:

cms - the cms context

referencePath - the right resource path

返回:

the starting category