Package org.opencms.widgets
Class CmsUserWidget
- java.lang.Object
-
- org.opencms.widgets.A_CmsWidget
-
- org.opencms.widgets.A_CmsSelectWidget
-
- org.opencms.widgets.CmsSelectWidget
-
- org.opencms.widgets.CmsUserWidget
-
- All Implemented Interfaces:
I_CmsADEWidget
,I_CmsWidget
public class CmsUserWidget extends CmsSelectWidget
Provides a OpenCms User 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 users to display, optional.static java.lang.String
CONFIGURATION_GROUP
Configuration parameter to set the group of users to display, optional.-
Fields inherited from class org.opencms.widgets.A_CmsSelectWidget
CONFIGURATION_HEIGHT
-
Fields inherited from class org.opencms.widgets.A_CmsWidget
HELP_POSTFIX, LABEL_PREFIX
-
-
Constructor Summary
Constructors Constructor Description CmsUserWidget()
Creates a new user selection widget.CmsUserWidget(java.lang.Integer flags, java.lang.String groupName)
Creates a new user selection widget with the parameters to configure the popup window behaviour.CmsUserWidget(java.lang.String configuration)
Creates a new user selection widget with the given configuration.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getConfiguration()
Returns the configuration string.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, ornull
if all.java.lang.String
getGroupName()
Returns the group name, ornull
if all.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, 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.-
Methods inherited from class org.opencms.widgets.CmsSelectWidget
getWidgetStringValue
-
Methods inherited from class org.opencms.widgets.A_CmsSelectWidget
addSelectOption, getConfiguration, getCssResourceLinks, getDefaultDisplayType, getHeight, getInitCall, getJavaScriptResourceLinks, getResourcePath, getSelectedValue, getSelectedValues, getSelectOptions, isInternal, setSelectOptions
-
Methods inherited from class org.opencms.widgets.A_CmsWidget
equals, getDialogHtmlEnd, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, 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, isCompactViewEnabled, setEditorValue
-
-
-
-
Field Detail
-
CONFIGURATION_FLAGS
public static final java.lang.String CONFIGURATION_FLAGS
Configuration parameter to set the flags of the users to display, optional.- See Also:
- Constant Field Values
-
CONFIGURATION_GROUP
public static final java.lang.String CONFIGURATION_GROUP
Configuration parameter to set the group of users to display, optional.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsUserWidget
public CmsUserWidget()
Creates a new user selection widget.
-
CmsUserWidget
public CmsUserWidget(java.lang.Integer flags, java.lang.String groupName)
Creates a new user selection widget with the parameters to configure the popup window behaviour.- Parameters:
flags
- the group flags to restrict the group selection, can benull
groupName
- the group to restrict the user selection, can benull
-
CmsUserWidget
public CmsUserWidget(java.lang.String configuration)
Creates a new user 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 interfaceI_CmsWidget
- Overrides:
getConfiguration
in classA_CmsSelectWidget
- Returns:
- the configuration string
- See Also:
A_CmsWidget.getConfiguration()
-
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 interfaceI_CmsWidget
- Overrides:
getDialogIncludes
in classA_CmsWidget
- Parameters:
cms
- the current users OpenCms contextwidgetDialog
- 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 interfaceI_CmsWidget
- Overrides:
getDialogWidget
in classCmsSelectWidget
- Parameters:
cms
- an initialized instance of a CmsObjectwidgetDialog
- the dialog where the widget is used onparam
- 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, ornull
if all.- Returns:
- the flags, or
null
if all
-
getGroupName
public java.lang.String getGroupName()
Returns the group name, ornull
if all.- Returns:
- the group name, or
null
if all
-
getWidgetName
public java.lang.String getWidgetName()
Description copied from interface:I_CmsADEWidget
Returns the class name of the widget.- Specified by:
getWidgetName
in interfaceI_CmsADEWidget
- Overrides:
getWidgetName
in classCmsSelectWidget
- Returns:
- the class name
- See Also:
I_CmsADEWidget.getWidgetName()
-
newInstance
public I_CmsWidget newInstance()
Description copied from interface:I_CmsWidget
Creates a duplicate of this widget instance.- Specified by:
newInstance
in interfaceI_CmsWidget
- Overrides:
newInstance
in classCmsSelectWidget
- 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 interfaceI_CmsWidget
- Overrides:
setConfiguration
in classA_CmsSelectWidget
- Parameters:
configuration
- the configuration to set- See Also:
A_CmsWidget.setConfiguration(java.lang.String)
-
parseSelectOptions
protected java.util.List<CmsSelectWidgetOption> parseSelectOptions(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
Description copied from class:A_CmsSelectWidget
Returns the list of configured select options, parsing the configuration String if required.The list elements are of type
. The configuration String is parsed only once and then stored internally.CmsSelectWidgetOption
- Overrides:
parseSelectOptions
in classA_CmsSelectWidget
- Parameters:
cms
- the current users OpenCms contextwidgetDialog
- the dialog of this widgetparam
- 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)
-
-