Package org.opencms.widgets

Class CmsLocalizationWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.CmsLocalizationWidget

All Implemented Interfaces:

I_CmsADEWidget, I_CmsWidget

public class CmsLocalizationWidget
extends A_CmsWidget
implements I_CmsADEWidget

Provides a standard HTML form input widget for overwriting localized values of a resource bundle, for use on a widget dialog.

The resource bundle is configured with the widget configuration attribute. An optional key name to look up in the bundle can be given, too, in case it is different from the element name: key=mykey.

The locale to get the value for can be configured, too, by adding a configuration directive: locale=en.

Example: .

To use the stored localization values and have the values of the resource bundles as fallback, use the CmsXmlMessages object.

Since:

6.5.4

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	OPTION_KEY	The option for the localized key name.
static java.lang.String	OPTION_LOCALE	The option for the locale to use.

Fields inherited from class org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

Constructor Summary

Constructors

Constructor	Description
CmsLocalizationWidget()	Creates a new input localization widget.
CmsLocalizationWidget(java.lang.String configuration)	Creates a new input localization widget with the given configuration.

Method Summary

Modifier and Type	Method	Description
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	getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)	Generates the widget HTML for the provided widget parameter.
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	getWidgetName()	Returns the class name of the widget.
protected void	initConfiguration(CmsObject cms, I_CmsWidgetParameter param)	Initializes the localized bundle to get the value from, the optional key name and the optional locale.
protected void	initConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType)	Initializes the localized bundle to get the value from, the optional key name and the optional locale.
boolean	isInternal()	Returns if this is an internal widget.
I_CmsWidget	newInstance()	Creates a duplicate of this widget instance.
void	setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)	Sets the value of in the given widget parameter by reading the "right" value from the offered map of parameters.

Methods inherited from class org.opencms.widgets.A_CmsWidget

equals, getConfiguration, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, getWidgetStringValue, hashCode, isCompactViewEnabled, setConfiguration

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

getConfiguration, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpText, getWidgetStringValue, isCompactViewEnabled, setConfiguration

Field Detail

OPTION_KEY

public static final java.lang.String OPTION_KEY

The option for the localized key name.

See Also:

Constant Field Values

OPTION_LOCALE

public static final java.lang.String OPTION_LOCALE

The option for the locale to use.

See Also:

Constant Field Values

Constructor Detail

CmsLocalizationWidget

public CmsLocalizationWidget()

Creates a new input localization widget.

CmsLocalizationWidget

public CmsLocalizationWidget(java.lang.String configuration)

Creates a new input localization widget with the given configuration.

Parameters:

configuration - the configuration to use

Method Detail

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

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)

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)

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

setEditorValue

public void setEditorValue(CmsObject cms,
                           java.util.Map<java.lang.String,java.lang.String[]> formParameters,
                           I_CmsWidgetDialog widgetDialog,
                           I_CmsWidgetParameter param)

Description copied from interface: I_CmsWidget

Sets the value of in the given widget parameter by reading the "right" value from the offered map of parameters.

Specified by:

setEditorValue in interface I_CmsWidget

Overrides:

setEditorValue in class A_CmsWidget

Parameters:

cms - the current users OpenCms context

formParameters - the map of parameters to get the value from

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

See Also:

I_CmsWidget.setEditorValue(org.opencms.file.CmsObject, java.util.Map, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

initConfiguration

protected void initConfiguration(CmsObject cms,
                                 A_CmsXmlContentValue schemaType)

Initializes the localized bundle to get the value from, the optional key name and the optional locale.

Parameters:

cms - an initialized instance of a CmsObject

schemaType - the widget parameter to generate the widget for

initConfiguration

protected void initConfiguration(CmsObject cms,
                                 I_CmsWidgetParameter param)

Initializes the localized bundle to get the value from, the optional key name and the optional locale.

Parameters:

cms - an initialized instance of a CmsObject

param - the widget parameter to generate the widget for