CmsSelectGroupWidget

java.lang.Object
- org.opencms.widgets.A_CmsWidget
- - org.opencms.widgets.A_CmsSelectWidget
  - - org.opencms.widgets.CmsSelectWidget
    - - org.opencms.widgets.CmsSelectGroupWidget

所有已实现的接口:

I_CmsADEWidget, I_CmsWidget

直接已知子类:

CmsMultiSelectGroupWidget
```
public class CmsSelectGroupWidget
extends CmsSelectWidget
```
Provides a widget for group selection 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.0

嵌套类概要
- 从类继承的嵌套类/接口 org.opencms.widgets.A_CmsWidget
  A_CmsWidget.CmsDummyWidgetDialog

字段概要

字段
限定符和类型	字段和说明
`protected static java.lang.String`	`CONFIGURATION_GROUPFILTER` Configuration option key: group filter.
`protected static java.lang.String`	`CONFIGURATION_GROUPS` Configuration option key: groups.
`protected static java.lang.String`	`CONFIGURATION_INCLUDESUBOUS` Configuration option key: include sub OUs.
`protected static java.lang.String`	`CONFIGURATION_OUFQN` Configuration option key: OU fully qualified name.

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

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

构造器概要

构造器
构造器和说明
`CmsSelectGroupWidget()` Creates a new group select widget.
`CmsSelectGroupWidget(java.lang.String configuration)` Creates a group select widget with the specified select options.

方法概要

方法
限定符和类型	方法和说明
`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.
`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.
`boolean`	`isInternal()` Returns if this is an internal 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.

从类继承的方法 org.opencms.widgets.CmsSelectWidget
getDialogWidget, getWidgetName, getWidgetStringValue

从类继承的方法 org.opencms.widgets.A_CmsSelectWidget
addSelectOption, getConfiguration, getDefaultDisplayType, getHeight, getResourcePath, getSelectedValue, getSelectedValues, getSelectOptions, setConfiguration, setSelectOptions

从类继承的方法 org.opencms.widgets.A_CmsWidget
equals, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, hashCode, isCompactViewEnabled, setEditorValue

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.opencms.widgets.I_CmsWidget
getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpText, isCompactViewEnabled, setEditorValue

- 字段详细资料
  - CONFIGURATION_GROUPFILTER
```
protected static final java.lang.String CONFIGURATION_GROUPFILTER
```
    Configuration option key: group filter.
    
    另请参阅:
    常量字段值
  - CONFIGURATION_GROUPS
```
protected static final java.lang.String CONFIGURATION_GROUPS
```
    Configuration option key: groups.
    
    另请参阅:
    常量字段值
  - CONFIGURATION_INCLUDESUBOUS
```
protected static final java.lang.String CONFIGURATION_INCLUDESUBOUS
```
    Configuration option key: include sub OUs.
    
    另请参阅:
    常量字段值
  - CONFIGURATION_OUFQN
```
protected static final java.lang.String CONFIGURATION_OUFQN
```
    Configuration option key: OU fully qualified name.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsSelectGroupWidget
```
public CmsSelectGroupWidget()
```
    Creates a new group select widget.
  - CmsSelectGroupWidget
```
public CmsSelectGroupWidget(java.lang.String configuration)
```
    Creates a group select widget with the specified select options.
    
    参数:
    configuration - the configuration (possible options) for the group select box
- 方法详细资料
  - 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 在类中 A_CmsSelectWidget
    
    参数:
    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)
```
    从类复制的说明: A_CmsSelectWidget
    
    Returns a list of CSS resources required by the widget.
    
    指定者:
    
    getCssResourceLinks 在接口中 I_CmsADEWidget
    
    覆盖:
    
    getCssResourceLinks 在类中 A_CmsSelectWidget
    
    参数:
    cms - the current OpenCms context
    
    返回:
    the required CSS resource links
    另请参阅:
    I_CmsADEWidget.getCssResourceLinks(org.opencms.file.CmsObject)
  - getInitCall
```
public java.lang.String getInitCall()
```
    从类复制的说明: A_CmsSelectWidget
    
    Returns the java script initialization call.
    
    指定者:
    
    getInitCall 在接口中 I_CmsADEWidget
    
    覆盖:
    
    getInitCall 在类中 A_CmsSelectWidget
    
    返回:
    the java script initialization call
    另请参阅:
    I_CmsADEWidget.getInitCall()
  - getJavaScriptResourceLinks
```
public java.util.List<java.lang.String> getJavaScriptResourceLinks(CmsObject cms)
```
    从类复制的说明: A_CmsSelectWidget
    
    Returns a list of java script resources required by the widget.
    
    指定者:
    
    getJavaScriptResourceLinks 在接口中 I_CmsADEWidget
    
    覆盖:
    
    getJavaScriptResourceLinks 在类中 A_CmsSelectWidget
    
    参数:
    cms - the current OpenCms context
    
    返回:
    the required java script resource links
    另请参阅:
    I_CmsADEWidget.getJavaScriptResourceLinks(org.opencms.file.CmsObject)
  - isInternal
```
public boolean isInternal()
```
    从类复制的说明: A_CmsSelectWidget
    
    Returns if this is an internal widget.
    Only widgets belonging to the OpenCms core should be marked as internal.
    
    指定者:
    
    isInternal 在接口中 I_CmsADEWidget
    
    覆盖:
    
    isInternal 在类中 A_CmsSelectWidget
    
    返回:
    true if this is an internal widget
    另请参阅:
    I_CmsADEWidget.isInternal()
  - newInstance
```
public I_CmsWidget newInstance()
```
    从接口复制的说明: I_CmsWidget
    
    Creates a duplicate of this widget instance.
    
    指定者:
    
    newInstance 在接口中 I_CmsWidget
    
    覆盖:
    
    newInstance 在类中 CmsSelectWidget
    
    返回:
    a duplicate of this widget instance
    另请参阅:
    I_CmsWidget.newInstance()
  - parseSelectOptions
```
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.
    The list elements are of type CmsSelectWidgetOption. The configuration String is parsed only once and then stored internally.
    
    参数:
    cms - the current users OpenCms context
    messages - the messages of this dialog
    param - the widget parameter of this dialog
    
    返回:
    the list of select options
    另请参阅:
    CmsSelectWidgetOption
  - 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 在类中 A_CmsSelectWidget
    
    参数:
    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)

类 CmsSelectGroupWidget

嵌套类概要

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

字段概要

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

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

构造器概要

方法概要

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

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

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

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

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

字段详细资料

CONFIGURATION_GROUPFILTER

CONFIGURATION_GROUPS

CONFIGURATION_INCLUDESUBOUS

CONFIGURATION_OUFQN

构造器详细资料

CmsSelectGroupWidget

CmsSelectGroupWidget

方法详细资料

getConfiguration

getCssResourceLinks

getInitCall

getJavaScriptResourceLinks

isInternal

newInstance

parseSelectOptions

parseSelectOptions