org.opencms.widgets
Class CmsCalendarWidget

java.lang.Object
  extended byorg.opencms.widgets.A_CmsWidget
      extended byorg.opencms.widgets.CmsCalendarWidget
All Implemented Interfaces:
I_CmsWidget

public class CmsCalendarWidget
extends A_CmsWidget

Provides a DHTML calendar widget, for use on a widget dialog.

Since:
6.0.0
Version:
$Revision: 1.13 $
Author:
Alexander Kandzior

Field Summary
 
Fields inherited from class org.opencms.widgets.A_CmsWidget
HELP_POSTFIX, LABEL_PREFIX
 
Constructor Summary
CmsCalendarWidget()
          Creates a new calendar widget.
CmsCalendarWidget(java.lang.String configuration)
          Creates a new calendar widget with the given configuration.
 
Method Summary
 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.String getWidgetStringValue(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
          Returns the I_CmsWidgetParameter.getStringValue(CmsObject) processed according to the output rules of this widget and the given widget dialog.
 I_CmsWidget newInstance()
          Creates a duplicate of this widget instance.
 void setEditorValue(CmsObject cms, java.util.Map 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, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, hashCode, setConfiguration
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CmsCalendarWidget

public CmsCalendarWidget()
Creates a new calendar widget.


CmsCalendarWidget

public CmsCalendarWidget(java.lang.String configuration)
Creates a new calendar widget with the given configuration.

Parameters:
configuration - the configuration to use
Method Detail

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
See Also:
I_CmsWidget.getDialogIncludes(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)

getWidgetStringValue

public java.lang.String getWidgetStringValue(CmsObject cms,
                                             I_CmsWidgetDialog widgetDialog,
                                             I_CmsWidgetParameter param)
Description copied from interface: I_CmsWidget
Returns the I_CmsWidgetParameter.getStringValue(CmsObject) processed according to the output rules of this widget and the given widget dialog.

Specified by:
getWidgetStringValue in interface I_CmsWidget
Overrides:
getWidgetStringValue in class A_CmsWidget
See Also:
I_CmsWidget.getWidgetStringValue(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

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)

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,
                           java.util.Map 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
See Also:
I_CmsWidget.setEditorValue(org.opencms.file.CmsObject, java.util.Map, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)