org.opencms.widgets

类 CmsMultiSelectGroupWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.A_CmsSelectWidget

org.opencms.widgets.CmsSelectWidget

org.opencms.widgets.CmsSelectGroupWidget

org.opencms.widgets.CmsMultiSelectGroupWidget

所有已实现的接口:

I_CmsADEWidget, I_CmsWidget

public class CmsMultiSelectGroupWidget
extends CmsSelectGroupWidget

Provides a widget for group selection multi select boxes.

This widget is configurable with the following options:

• groupfilter: regular expression to filter available groups
• groups: comma separated list of group names to show in the select box. Note: if this configuration option if used, groupfilter and includesubous are not considered anymore.
• includesubous: boolean flag to indicate if sub OUs should be scanned for groups to select
• oufqn: the fully qualified name of the OU to read the groups from

To map the selected group to a permission to set, use the following mapping configuration:

<mapping element="..." mapto="permission:GROUP:+r+v|GROUP.ALL_OTHERS:|GROUP.Projectmanagers:+r+v+w+c" />

This means that the +r+v permission is written for the principal GROUP on the resource. Additionally two permissions are written as default: for ALL_OTHERS, no allowed permission is set, for Projectmanagers, "+r+v+w+c" is set.

从以下版本开始:

8.0.2

版本:

$Revision: 1.1 $

作者:

Mario Jaeger

嵌套类概要

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

A_CmsWidget.CmsDummyWidgetDialog

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	CONFIGURATION_DEFAULT_ALL Configuration parameter name to use all available groups as default.

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

CONFIGURATION_GROUPFILTER, CONFIGURATION_GROUPS, CONFIGURATION_INCLUDESUBOUS, CONFIGURATION_OUFQN

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

CONFIGURATION_HEIGHT

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

HELP_POSTFIX, LABEL_PREFIX

构造器概要

构造器

构造器和说明
CmsMultiSelectGroupWidget() Creates a new group select widget.
CmsMultiSelectGroupWidget(java.lang.String configuration) Creates a group select widget with the specified select options.
CmsMultiSelectGroupWidget(java.lang.String configuration, boolean asCheckboxes) Creates a select widget with the select options specified in the given configuration List.

方法概要

方法

限定符和类型	方法和说明
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.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	getWidgetName() Returns the class name of the widget.
I_CmsWidget	newInstance() Creates a duplicate of this widget instance.
protected java.util.List<CmsSelectWidgetOption>	parseSelectOptions(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param) Returns the list of configured select options, parsing the configuration String if required.
protected java.util.List<CmsSelectWidgetOption>	parseSelectOptions(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Returns the list of configured select options, parsing the configuration String if required.
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.CmsSelectGroupWidget

getCssResourceLinks, getInitCall, getJavaScriptResourceLinks, isInternal

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

getWidgetStringValue

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

addSelectOption, getConfiguration, getDefaultDisplayType, getHeight, getResourcePath, getSelectedValue, getSelectedValues, getSelectOptions, setSelectOptions

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

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

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

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

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

getDialogHtmlEnd, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpText, isCompactViewEnabled

字段详细资料

CONFIGURATION_DEFAULT_ALL

public static final java.lang.String CONFIGURATION_DEFAULT_ALL

Configuration parameter name to use all available groups as default.

另请参阅:

常量字段值

构造器详细资料

CmsMultiSelectGroupWidget

public CmsMultiSelectGroupWidget()

Creates a new group select widget.

CmsMultiSelectGroupWidget

public CmsMultiSelectGroupWidget(java.lang.String configuration)

Creates a group select widget with the specified select options.

参数:

configuration - the configuration (possible options) for the group select box

CmsMultiSelectGroupWidget

public CmsMultiSelectGroupWidget(java.lang.String configuration,
                         boolean asCheckboxes)

Creates a select widget with the select options specified in the given configuration List.

The list elements must be of type CmsSelectWidgetOption.

参数:

configuration - the configuration (possible options) for the select widget

asCheckboxes - indicates if used html code is a multi selection list or a list of checkboxes

另请参阅:

CmsSelectWidgetOption

方法详细资料

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

覆盖:

getConfiguration 在类中 CmsSelectGroupWidget

参数:

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)

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

覆盖:

getDialogWidget 在类中 CmsSelectWidget

参数:

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)

getWidgetName

public java.lang.String getWidgetName()

从接口复制的说明: I_CmsADEWidget

Returns the class name of the widget.

指定者:

getWidgetName 在接口中 I_CmsADEWidget

覆盖:

getWidgetName 在类中 CmsSelectWidget

返回:

the class name

另请参阅:

I_CmsADEWidget.getWidgetName()

newInstance

public I_CmsWidget newInstance()

从接口复制的说明: I_CmsWidget

Creates a duplicate of this widget instance.

指定者:

newInstance 在接口中 I_CmsWidget

覆盖:

newInstance 在类中 CmsSelectGroupWidget

返回:

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_CmsSelectWidget

参数:

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)

parseSelectOptions

protected java.util.List<CmsSelectWidgetOption> parseSelectOptions(CmsObject cms,
                                                       CmsMessages messages,
                                                       I_CmsWidgetParameter param)

从类复制的说明: CmsSelectGroupWidget

Returns the list of configured select options, parsing the configuration String if required.

The list elements are of type CmsSelectWidgetOption. The configuration String is parsed only once and then stored internally.

覆盖:

parseSelectOptions 在类中 CmsSelectGroupWidget

参数:

cms - the current users OpenCms context

messages - the messages of this dialog

param - the widget parameter of this dialog

返回:

the list of select options

另请参阅:

CmsSelectGroupWidget.parseSelectOptions(org.opencms.file.CmsObject, org.opencms.i18n.CmsMessages, org.opencms.widgets.I_CmsWidgetParameter)

parseSelectOptions

protected java.util.List<CmsSelectWidgetOption> parseSelectOptions(CmsObject cms,
                                                       I_CmsWidgetDialog widgetDialog,
                                                       I_CmsWidgetParameter param)

从类复制的说明: A_CmsSelectWidget

Returns the list of configured select options, parsing the configuration String if required.

The list elements are of type CmsSelectWidgetOption. The configuration String is parsed only once and then stored internally.

覆盖:

parseSelectOptions 在类中 CmsSelectGroupWidget

参数:

cms - the current users OpenCms context

widgetDialog - the dialog of this widget

param - the widget parameter of this dialog

返回:

the list of select options

另请参阅:

A_CmsSelectWidget.parseSelectOptions(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)