org.opencms.widgets
Class CmsDisplayWidget

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

All Implemented Interfaces:

I_CmsWidget

public class CmsDisplayWidget
extends A_CmsWidget

Provides a display only widget, for use on a widget dialog.

Since:

6.0.0

Version:

$Revision: 1.20 $

Author:

Michael Moossen

Field Summary

Fields inherited from class org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

Constructor Summary

CmsDisplayWidget()
Creates a new input widget.

CmsDisplayWidget(java.lang.String configuration)
Creates a new input widget with the given configuration.

Method Summary

java.lang.String	getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Generates the widget HTML for the provided widget parameter.
java.lang.String	getHelpBubble(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Creates the HTML code for the help bubble for this widget.
java.lang.String	getHelpText(I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Creates a HTML <div> containing the help text for this widget.
I_CmsWidget	newInstance() Creates a duplicate of this widget instance.

Methods inherited from class org.opencms.widgets.A_CmsWidget

equals, getConfiguration, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpKey, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, getWidgetStringValue, hashCode, setConfiguration, setEditorValue

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsDisplayWidget

public CmsDisplayWidget()

Creates a new input widget.

CmsDisplayWidget

public CmsDisplayWidget(java.lang.String configuration)

Creates a new input widget with the given configuration.

Parameters:

configuration - the configuration to use

Method Detail

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)

getHelpBubble

public java.lang.String getHelpBubble(CmsObject cms,
                                      I_CmsWidgetDialog widgetDialog,
                                      I_CmsWidgetParameter param)

Description copied from interface: I_CmsWidget

Creates the HTML code for the help bubble for this widget.

Specified by:

getHelpBubble in interface I_CmsWidget

Overrides:

getHelpBubble in class A_CmsWidget

Parameters:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

Returns:

the HTML code for the help bubble for this widget

See Also:

A_CmsWidget.getHelpBubble(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

getHelpText

public java.lang.String getHelpText(I_CmsWidgetDialog widgetDialog,
                                    I_CmsWidgetParameter param)

Description copied from interface: I_CmsWidget

Creates a HTML <div> containing the help text for this widget.

Specified by:

getHelpText in interface I_CmsWidget

Overrides:

getHelpText in class A_CmsWidget

Parameters:

widgetDialog - the dialog where the widget is used on

param - the value to create the help bubble for

Returns:

a HTML <div> containing the help text for this widget

See Also:

A_CmsWidget.getHelpText(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()