org.opencms.widgets

Class CmsDefaultComplexWidget

java.lang.Object

org.opencms.widgets.CmsDefaultComplexWidget

All Implemented Interfaces:

I_CmsComplexWidget

public class CmsDefaultComplexWidget
extends java.lang.Object
implements I_CmsComplexWidget

Dummy widget class that causes the Acacia editor to render a nested content normally without a special widget.

This could be used to override a default widget defined for a nested content in its XSD on a per-attribute basis.

Constructor Summary

Constructors

Constructor and Description
CmsDefaultComplexWidget()

Method Summary

Methods

Modifier and Type	Method and 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsDefaultComplexWidget

public CmsDefaultComplexWidget()

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 interface I_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 interface I_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 interface I_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)