org.opencms.widgets
Class CmsPrincipalWidget

java.lang.Object
  org.opencms.widgets.A_CmsWidget
      org.opencms.widgets.CmsPrincipalWidget

All Implemented Interfaces:

I_CmsWidget

public class CmsPrincipalWidget
extends A_CmsWidget

Provides an OpenCms Principal selection widget, for use on a widget dialog.

Since:

6.5.6

Version:

$Revision: 1.7 $

Author:

Michael Moossen

Field Summary

static java.lang.String

CONFIGURATION_FLAGS Configuration parameter to set the flags of the principals to display, optional.

Fields inherited from class org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

Constructor Summary

CmsPrincipalWidget()
Creates a new principals selection widget.

CmsPrincipalWidget(java.lang.Integer flags)
Creates a new principals selection widget with the parameters to configure the popup window behaviour.

CmsPrincipalWidget(java.lang.String configuration)
Creates a new principals selection widget with the given configuration.

Method Summary

java.lang.String	getButtonJs(java.lang.String id, java.lang.String form) Returns the needed java script for the search button.
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, or null if all.
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, setEditorValue

Methods inherited from class java.lang.Object

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

Field Detail

CONFIGURATION_FLAGS

public static final java.lang.String CONFIGURATION_FLAGS

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

See Also:

Constant Field Values

Constructor Detail

CmsPrincipalWidget

public CmsPrincipalWidget()

Creates a new principals selection widget.

CmsPrincipalWidget

public CmsPrincipalWidget(java.lang.Integer flags)

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

Parameters:

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

CmsPrincipalWidget

public CmsPrincipalWidget(java.lang.String configuration)

Creates a new principals 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()

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.

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)

getButtonJs

public java.lang.String getButtonJs(java.lang.String id,
                                    java.lang.String form)

Returns the needed java script for the search button.

Parameters:

id - the id of the widget to generate the search button for

form - the id of the form where to which the widget belongs

Returns:

javascript code

getFlags

public java.lang.Integer getFlags()

Returns the flags, or null if all.

Returns:

the flags, or null if all

newInstance

public I_CmsWidget newInstance()

Description copied from interface: I_CmsWidget

Creates a duplicate of this widget instance.

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)