Package org.opencms.widgets
Class CmsDataViewWidget
- java.lang.Object
-
- org.opencms.widgets.CmsDataViewWidget
-
- All Implemented Interfaces:
I_CmsComplexWidget
public class CmsDataViewWidget extends java.lang.Object implements I_CmsComplexWidget
Complex widget for opening selecting data from a data source implementing the I_CmsDataView interface.This widget can only be used
-
-
Constructor Summary
Constructors Constructor Description CmsDataViewWidget()
Default constructor.CmsDataViewWidget(java.lang.String config)
Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description I_CmsComplexWidget
configure(java.lang.String configuration)
Returns a copy of this widget which has been configured with the given configuration string.java.lang.String
getName()
Gets the name of the complex widget.CmsComplexWidgetData
getWidgetData(CmsObject cms)
Gets the data needed for the editor to render the complex widget.void
validateConfiguration(java.lang.String configuration)
Validates the configuration.
-
-
-
Constructor Detail
-
CmsDataViewWidget
public CmsDataViewWidget()
Default constructor.
-
CmsDataViewWidget
public CmsDataViewWidget(java.lang.String config)
Creates a new instance.- Parameters:
config
- the widget configuration
-
-
Method Detail
-
configure
public I_CmsComplexWidget configure(java.lang.String configuration)
Description copied from interface:I_CmsComplexWidget
Returns a copy of this widget which has been configured with the given configuration string.- Specified by:
configure
in interfaceI_CmsComplexWidget
- Parameters:
configuration
- the configuration string- Returns:
- the configured copy of the widget
- See Also:
I_CmsComplexWidget.configure(java.lang.String)
-
getName
public java.lang.String getName()
Description copied from interface:I_CmsComplexWidget
Gets the name of the complex widget.The string returned by this function should be a valid Javascript identifier.
- Specified by:
getName
in interfaceI_CmsComplexWidget
- Returns:
- the name of the complex widget
- See Also:
I_CmsComplexWidget.getName()
-
getWidgetData
public CmsComplexWidgetData getWidgetData(CmsObject cms)
Description copied from interface:I_CmsComplexWidget
Gets the data needed for the editor to render the complex widget.- Specified by:
getWidgetData
in interfaceI_CmsComplexWidget
- Parameters:
cms
- The CMS object to use for VFS operations- Returns:
- the data for the complex widget
- See Also:
I_CmsComplexWidget.getWidgetData(org.opencms.file.CmsObject)
-
validateConfiguration
public void validateConfiguration(java.lang.String configuration)
Validates the configuration.- Parameters:
configuration
- the configuration
-
-