Package org.opencms.widgets

Class CmsOrgUnitWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.A_CmsSelectWidget

org.opencms.widgets.CmsOrgUnitWidget

All Implemented Interfaces:

I_CmsADEWidget, I_CmsWidget

public class CmsOrgUnitWidget
extends A_CmsSelectWidget
implements I_CmsADEWidget

Provides a OpenCms orgaizational unit selection widget, for use on a widget dialog.

Since:

6.5.6

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 final String	CONFIGURATION_ROLE	Configuration parameter to set the role the current user must have in the selected ou, 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
CmsOrgUnitWidget()	Creates a new organizational unit selection widget.
CmsOrgUnitWidget(String configuration)	Creates a new organizational unit selection widget with the given configuration.
CmsOrgUnitWidget(CmsRole role)	Creates a new user selection widget with the parameters to configure the popup window behaviour.

Method Summary

Modifier and Type	Method	Description
String	getConfiguration()	Returns the configuration string.
String	getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)	Generates the necessary JavaScript inclusion code for this widget.
String	getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)	Generates the widget HTML for the provided widget parameter.
CmsRole	getRole()	Returns the role, or null if none.
String	getWidgetName()	Returns the class name of the widget.
I_CmsWidget	newInstance()	Creates a duplicate of this widget instance.
protected 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(String configuration)	Sets the configuration of this widget.

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, 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_CmsADEWidget

getConfiguration, getCssResourceLinks, getDefaultDisplayType, getInitCall, getJavaScriptResourceLinks, isInternal

Methods inherited from interface org.opencms.widgets.I_CmsWidget

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

Field Details

CONFIGURATION_ROLE

public static final String CONFIGURATION_ROLE

Configuration parameter to set the role the current user must have in the selected ou, optional.

See Also:

• Constant Field Values

Constructor Details

CmsOrgUnitWidget

public CmsOrgUnitWidget()

Creates a new organizational unit selection widget.

CmsOrgUnitWidget

public CmsOrgUnitWidget(CmsRole role)

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

Parameters:

role - the role to restrict the organizational unit selection, can be null

CmsOrgUnitWidget

public CmsOrgUnitWidget(String configuration)

Creates a new organizational unit selection widget with the given configuration.

Parameters:

configuration - the configuration to use

Method Details

getConfiguration

public String getConfiguration()

Description copied from class: A_CmsWidget

Returns the configuration string.

Specified by:

getConfiguration in interface I_CmsWidget

Overrides:

getConfiguration in class A_CmsSelectWidget

Returns:

the configuration string

See Also:

• A_CmsWidget.getConfiguration()

getDialogIncludes

public 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 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)

getRole

public CmsRole getRole()

Returns the role, or null if none.

Returns:

the role, or null if none

getWidgetName

public String getWidgetName()

Description copied from interface: I_CmsADEWidget

Returns the class name of the widget.

Specified by:

getWidgetName in interface I_CmsADEWidget

Overrides:

getWidgetName in class A_CmsSelectWidget

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 interface I_CmsWidget

Returns:

a duplicate of this widget instance

See Also:

• I_CmsWidget.newInstance()

setConfiguration

public void setConfiguration(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_CmsSelectWidget

Parameters:

configuration - the configuration to set

See Also:

• A_CmsWidget.setConfiguration(java.lang.String)

parseSelectOptions

protected 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 CmsSelectWidgetOption. The configuration String is parsed only once and then stored internally.

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)