org.opencms.widgets
Class CmsTextareaWidget

java.lang.Object
  extended by org.opencms.widgets.A_CmsWidget
      extended by org.opencms.widgets.CmsTextareaWidget
All Implemented Interfaces:
I_CmsWidget
Direct Known Subclasses:
CmsTextareaWidgetPlaintext

public class CmsTextareaWidget
extends A_CmsWidget

Provides a standard HTML form textarea widget, for use on a widget dialog.

Displays a textarea with 4 rows to enter String values conveniently.

Since:
6.0.0
Version:
$Revision: 1.17 $
Author:
Andreas Zahner

Field Summary
 
Fields inherited from class org.opencms.widgets.A_CmsWidget
HELP_POSTFIX, LABEL_PREFIX
 
Constructor Summary
CmsTextareaWidget()
          Creates a new textarea widget.
CmsTextareaWidget(int rows)
          Creates a new textarea widget with the given number of rows.
CmsTextareaWidget(java.lang.String configuration)
          Creates a new textarea 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.
 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, getHelpBubble, getHelpKey, getHelpText, 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

CmsTextareaWidget

public CmsTextareaWidget()
Creates a new textarea widget.


CmsTextareaWidget

public CmsTextareaWidget(int rows)
Creates a new textarea widget with the given number of rows.

Parameters:
rows - the number of rows to display

CmsTextareaWidget

public CmsTextareaWidget(java.lang.String configuration)
Creates a new textarea 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)

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