Package org.opencms.widgets

Class CmsGroupWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.CmsGroupWidget

All Implemented Interfaces:

I_CmsADEWidget, I_CmsWidget

public class CmsGroupWidget
extends A_CmsWidget
implements I_CmsADEWidget

Provides a OpenCms Group selection widget, for use on a widget dialog.

Since:

6.0.0

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.widgets.A_CmsWidget

A_CmsWidget.CmsDummyWidgetDialog

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONFIGURATION_FLAGS	Configuration parameter to set the flags of the groups to display, optional.
static java.lang.String	CONFIGURATION_OUFQN	Configuration parameter to set the organizational unit of the groups to display, optional.
static java.lang.String	CONFIGURATION_USER	Configuration parameter to set the user of the groups to display, optional.

Fields inherited from class org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

Constructor Summary

Constructors

Constructor	Description
CmsGroupWidget()	Creates a new group selection widget.
CmsGroupWidget(java.lang.Integer flags, java.lang.String userName)	Creates a new group selection widget with the parameters to configure the popup window behaviour.
CmsGroupWidget(java.lang.Integer flags, java.lang.String userName, java.lang.String ouFqn)	Creates a new group selection widget with the parameters to configure the popup window behaviour.
CmsGroupWidget(java.lang.String configuration)	Creates a new group selection widget with the given configuration.

Method Summary

Modifier and Type	Method	Description
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.
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.Integer	getFlags()	Returns the flags, or null if all.
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.
java.lang.String	getOufqn()	Returns the organizational unit fqn, or null if all.
java.lang.String	getUserName()	Returns the user name, or null if all.
java.lang.String	getWidgetName()	Returns the class name of the widget.
boolean	isInternal()	Returns if this is an internal widget.
I_CmsWidget	newInstance()	Creates a duplicate of this widget instance.
void	setConfiguration(java.lang.String configuration)	Sets the configuration of this widget.

Methods inherited from class org.opencms.widgets.A_CmsWidget

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.widgets.I_CmsWidget

getDialogHtmlEnd, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpText, getWidgetStringValue, isCompactViewEnabled, setEditorValue

Field Detail

CONFIGURATION_FLAGS

public static final java.lang.String CONFIGURATION_FLAGS

Configuration parameter to set the flags of the groups to display, optional.

See Also:

Constant Field Values

CONFIGURATION_OUFQN

public static final java.lang.String CONFIGURATION_OUFQN

Configuration parameter to set the organizational unit of the groups to display, optional.

See Also:

Constant Field Values

CONFIGURATION_USER

public static final java.lang.String CONFIGURATION_USER

Configuration parameter to set the user of the groups to display, optional.

See Also:

Constant Field Values

Constructor Detail

CmsGroupWidget

public CmsGroupWidget()

Creates a new group selection widget.

CmsGroupWidget

public CmsGroupWidget(java.lang.Integer flags,
                      java.lang.String userName)

Creates a new group selection widget with the parameters to configure the popup window behaviour.

Parameters:

flags - the group flags to restrict the group selection, can be null

userName - the user to restrict the group selection, can be null

CmsGroupWidget

public CmsGroupWidget(java.lang.Integer flags,
                      java.lang.String userName,
                      java.lang.String ouFqn)

Creates a new group selection widget with the parameters to configure the popup window behaviour.

Parameters:

flags - the group flags to restrict the group selection, can be null

userName - the user to restrict the group selection, can be null

ouFqn - the organizational unit to restrict the group selection, can be null

CmsGroupWidget

public CmsGroupWidget(java.lang.String configuration)

Creates a new group selection widget with the given configuration.

Parameters:

configuration - the configuration to use

Method Detail

getConfiguration

public java.lang.String getConfiguration()

Description copied from class: A_CmsWidget

Returns the configuration string.

Specified by:

getConfiguration in interface I_CmsWidget

Overrides:

getConfiguration in class A_CmsWidget

Returns:

the configuration string

See Also:

A_CmsWidget.getConfiguration()

getConfiguration

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

Description copied from interface: I_CmsADEWidget

Returns the configuration string for the ADE content editor widget.

Specified by:

getConfiguration in interface I_CmsADEWidget

Parameters:

cms - the OpenCms context

schemaType - the schema type

messages - the messages

resource - the edited resource

contentLocale - the content locale

Returns:

the configuration string

See Also:

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)

Description copied from interface: I_CmsADEWidget

Returns a list of CSS resources required by the widget.

Specified by:

getCssResourceLinks in interface I_CmsADEWidget

Parameters:

cms - the current OpenCms context

Returns:

the required CSS resource links

See Also:

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

getDefaultDisplayType

public I_CmsXmlContentHandler.DisplayType getDefaultDisplayType()

Description copied from interface: I_CmsADEWidget

Returns the default display type of this widget.

Specified by:

getDefaultDisplayType in interface I_CmsADEWidget

Returns:

the default display type

See Also:

I_CmsADEWidget.getDefaultDisplayType()

getDialogIncludes

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

Description copied from interface: I_CmsWidget

Generates the necessary JavaScript inclusion code for this widget.

Specified by:

getDialogIncludes in interface I_CmsWidget

Overrides:

getDialogIncludes in class A_CmsWidget

Parameters:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

Returns:

the JavaScript inclusion code

See Also:

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)

Description copied from interface: I_CmsWidget

Generates the widget HTML for the provided widget parameter.

Specified by:

getDialogWidget in interface I_CmsWidget

Parameters:

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

Returns:

the widget HTML for the provided widget parameter

See Also:

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

getFlags

public java.lang.Integer getFlags()

Returns the flags, or null if all.

Returns:

the flags, or null if all

getInitCall

public java.lang.String getInitCall()

Description copied from interface: I_CmsADEWidget

Returns the java script initialization call.

Specified by:

getInitCall in interface I_CmsADEWidget

Returns:

the java script initialization call

See Also:

I_CmsADEWidget.getInitCall()

getJavaScriptResourceLinks

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

Description copied from interface: I_CmsADEWidget

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

Specified by:

getJavaScriptResourceLinks in interface I_CmsADEWidget

Parameters:

cms - the current OpenCms context

Returns:

the required java script resource links

See Also:

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

getOufqn

public java.lang.String getOufqn()

Returns the organizational unit fqn, or null if all.

Returns:

the organizational unit fqn

getUserName

public java.lang.String getUserName()

Returns the user name, or null if all.

Returns:

the user name

getWidgetName

public java.lang.String getWidgetName()

Description copied from interface: I_CmsADEWidget

Returns the class name of the widget.

Specified by:

getWidgetName in interface I_CmsADEWidget

Returns:

the class name

See Also:

I_CmsADEWidget.getWidgetName()

isInternal

public boolean isInternal()

Description copied from interface: I_CmsADEWidget

Returns if this is an internal widget.

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

Specified by:

isInternal in interface I_CmsADEWidget

Returns:

true if this is an internal widget

See Also:

I_CmsADEWidget.isInternal()

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

Returns:

a duplicate of this widget instance

See Also:

I_CmsWidget.newInstance()

setConfiguration

public void setConfiguration(java.lang.String configuration)

Description copied from interface: 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.

Specified by:

setConfiguration in interface I_CmsWidget

Overrides:

setConfiguration in class A_CmsWidget

Parameters:

configuration - the configuration to set

See Also:

A_CmsWidget.setConfiguration(java.lang.String)