org.opencms.widgets
Class CmsSelectGroupWidget

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

All Implemented Interfaces:

I_CmsWidget

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.

Since:

8.0.0

Field Summary

protected static String	CONFIGURATION_GROUPFILTER Configuration option key: group filter.
protected static String	CONFIGURATION_GROUPS Configuration option key: groups.
protected static String	CONFIGURATION_INCLUDESUBOUS Configuration option key: include sub OUs.
protected static String	CONFIGURATION_OUFQN Configuration option key: OU fully qualified name.

Fields inherited from class org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

Constructor Summary

CmsSelectGroupWidget()
Creates a new group select widget.

CmsSelectGroupWidget(String configuration)
Creates a group select widget with the specified select options.

Method Summary

I_CmsWidget	newInstance() Creates a duplicate of this widget instance.
protected List<CmsSelectWidgetOption>	parseSelectOptions(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Returns the select options for the widget, generated from the configured input fields of the XML content.

Methods inherited from class org.opencms.widgets.CmsSelectWidget

getDialogWidget, getWidgetStringValue

Methods inherited from class org.opencms.widgets.A_CmsSelectWidget

addSelectOption, getConfiguration, getSelectedValue, getSelectedValues, getSelectOptions, setSelectOptions

Methods inherited from class org.opencms.widgets.A_CmsWidget

equals, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, hashCode, setConfiguration, setEditorValue

Methods inherited from class java.lang.Object

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

Field Detail

CONFIGURATION_GROUPFILTER

protected static final String CONFIGURATION_GROUPFILTER

Configuration option key: group filter.

See Also:

Constant Field Values

CONFIGURATION_GROUPS

protected static final String CONFIGURATION_GROUPS

Configuration option key: groups.

See Also:

Constant Field Values

CONFIGURATION_INCLUDESUBOUS

protected static final String CONFIGURATION_INCLUDESUBOUS

Configuration option key: include sub OUs.

See Also:

Constant Field Values

CONFIGURATION_OUFQN

protected static final String CONFIGURATION_OUFQN

Configuration option key: OU fully qualified name.

See Also:

Constant Field Values

Constructor Detail

CmsSelectGroupWidget

public CmsSelectGroupWidget()

Creates a new group select widget.

CmsSelectGroupWidget

public CmsSelectGroupWidget(String configuration)

Creates a group select widget with the specified select options.

Parameters:

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

Method Detail

newInstance

public I_CmsWidget newInstance()

Description copied from interface: I_CmsWidget

Creates a duplicate of this widget instance.

Specified by:

newInstance in interface I_CmsWidget

Overrides:

newInstance in class CmsSelectWidget

Returns:

a duplicate of this widget instance

See Also:

I_CmsWidget.newInstance()

parseSelectOptions

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

Returns the select options for the widget, generated from the configured input fields of the XML content.

Overrides:

parseSelectOptions in class A_CmsSelectWidget

Parameters:

cms - the current users OpenCms context

widgetDialog - the dialog of this widget

param - the widget parameter of this dialog

Returns:

the list of select options

See Also:

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