org.opencms.widgets
Class CmsLocalizationWidget

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

All Implemented Interfaces:

I_CmsWidget

public class CmsLocalizationWidget
extends A_CmsWidget

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

Field Summary

static String	OPTION_KEY The option for the localized key name.
static 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

CmsLocalizationWidget()
Creates a new input localization widget.

CmsLocalizationWidget(String configuration)
Creates a new input localization widget with the given configuration.

Method Summary

String	getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Generates the widget HTML for the provided widget parameter.
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.
I_CmsWidget	newInstance() Creates a duplicate of this widget instance.
void	setEditorValue(CmsObject cms, Map<String,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, setConfiguration

Methods inherited from class java.lang.Object

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

Field Detail

OPTION_KEY

public static final String OPTION_KEY

The option for the localized key name.

See Also:

Constant Field Values

OPTION_LOCALE

public static final 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(String configuration)

Creates a new input localization widget with the given configuration.

Parameters:

configuration - the configuration to use

Method Detail

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.

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)

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

setEditorValue

public void setEditorValue(CmsObject cms,
                           Map<String,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,
                                 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