Package org.opencms.widgets

Contains the widget implementations, these are GUI elements used in editors and dialogs of the OpenCms workplace.

Since:

6.0.0

Interface Summary

Interface	Description
I_CmsADEWidget	Widgets to be used with the new XML content editor are required to implement this interface.
I_CmsComplexWidget	Interface for complex widgets which are used in the Acacia editor to render whole nested contents.
I_CmsGalleryWidgetDynamicConfiguration	Enables a dynamic configuration of values for the A_CmsGalleryWidget.
I_CmsImageWidgetDynamicConfiguration	Enables a dynamic configuration of values for the CmsVfsImageWidget.
I_CmsWidget	Describes an editor widget for use in the OpenCms workplace.
I_CmsWidgetDialog	Describes a widget enabled dialog.
I_CmsWidgetParameter	Parameter value wrapper used by the OpenCms workplace widgets.

Class Summary

Class	Description
A_CmsAdeGalleryWidget	Base class for all ADE gallery widget implementations.
A_CmsCategorizedSelectWidget	Abstract base class for categorized select widgets.
A_CmsFormatterWidget	Abstract superclass for widgets used to enable or disable formatters.
A_CmsFormatterWidget.FormatterSelectComparator	Comparator used to sort formatter beans in the order in which they should be displayed in the selection.
A_CmsGalleryWidget	Base class for all gallery widget implementations.
A_CmsHtmlWidget	Provides a widget that creates a rich input field using the matching component, for use on a widget dialog.
A_CmsNativeComplexWidget	This is an abstract class which you can inherit from to relatively easily implement complex widgets for rendering nested contents in Javascript.
A_CmsSelectWidget	Base class for select widgets.
A_CmsWidget	Base class for XML editor widgets.
CmsAddFormatterWidget	Widget used to select a formatter to add.
CmsAdeDownloadGalleryWidget	ADE download gallery widget implementations.
CmsAdeImageGalleryWidget	ADE image gallery widget implementations.
CmsCalendarWidget	Provides a DHTML calendar widget, for use on a widget dialog.
CmsCategoryWidget	Provides a widget for a category based dependent select boxes.
CmsCategoryXmlContentHandler	Deprecated. no longer needed since logic was moved to the default handler
CmsCheckboxWidget	Provides a standard HTML form checkbox widget, for use on a widget dialog.
CmsCodeWidget	Widget for editing source code.
CmsColorpickerWidget	Provides a HTML "color picker" widget, for use on a widget dialog.
CmsComboWidget	Provides a HTML text input field with optional values to select in a combo box, for use on a widget dialog.
CmsDataViewWidget	Complex widget for opening selecting data from a data source implementing the I_CmsDataView interface.
CmsDefaultComplexWidget	Dummy widget class that causes the Acacia editor to render a nested content normally without a special widget.
CmsDependentSelectWidget	Server-side part of the dependent select box widget.
CmsDisplayTypeSelectWidget	Widget to select a type and formatter combination.
CmsDisplayWidget	Provides a display only widget, for use on a widget dialog.
CmsDownloadGalleryWidget	Provides a widget that allows access to the available OpenCms download galleries, for use on a widget dialog.
CmsElementViewSelectWidget	A widget to select an element view.
CmsGalleryWidgetConfiguration	Configuration options for the gallery widget (e.g.
CmsGroupWidget	Provides a OpenCms Group selection widget, for use on a widget dialog.
CmsHtmlWidget	Provides a widget that creates a rich input field using the matching component, for use on a widget dialog.
CmsHtmlWidgetOption	An option of a HTML type widget.
CmsHttpUploadWidget	Provides a http upload widget, for use on a widget dialog.
CmsImageGalleryWidget	Provides a widget that allows access to the available OpenCms image galleries, for use on a widget dialog.
CmsInputWidget	Provides a standard HTML form input widget, for use on a widget dialog.
CmsInputWidgetPlaintext	CmsInputWidget that strips HTML Tags from the input before storing values.
CmsLinkGalleryWidget	Provides a widget that allows access to the available OpenCms external link galleries, for use on a widget dialog.
CmsLocalizationWidget	Provides a standard HTML form input widget for overwriting localized values of a resource bundle, for use on a widget dialog.
CmsLocationPickerWidget	Provides a display only widget, for use on a widget dialog.
CmsLocationPickerWidgetValue	A value of the google map widget.
CmsMultiSelectGroupWidget	Provides a widget for group selection multi select boxes.
CmsMultiSelectWidget	Provides a widget for a standard HTML form multi select list or a group of check boxes.
CmsOrgUnitWidget	Provides a OpenCms orgaizational unit selection widget, for use on a widget dialog.
CmsPasswordWidget	Provides a standard HTML form password widget, for use on a widget dialog.
CmsPrincipalWidget	Provides an OpenCms Principal selection widget, for use on a widget dialog.
CmsRadioSelectWidget	Provides a widget for a standard HTML form for a group of radio buttons.
CmsRemoveFormatterWidget	Widget used to select a formatter to remove.
CmsSelectComboWidget	Select box widget that can transform into a combo box by clicking an edit icon.
CmsSelectGroupWidget	Provides a widget for group selection select boxes.
CmsSelectOnChangeReloadWidget	Provides a widget for a standard HTML form select box with.
CmsSelectWidget	Provides a widget for a standard HTML form select box.
CmsSelectWidgetOption	An option of a select type widget.
CmsSerialDateWidget	Provides a serial date widget, for use on a widget dialog.
CmsTextareaWidget	Provides a standard HTML form textarea widget, for use on a widget dialog.
CmsTextareaWidgetPlaintext	CmsTextareaWidget that strips HTML Tags from the input before storing values.
CmsTypeComboWidget	A widget for selecting resource types which are direct editable.
CmsUserWidget	Provides a OpenCms User selection widget, for use on a widget dialog.
CmsVfsFileWidget	Provides a OpenCms VFS file selection widget, for use on a widget dialog.
CmsVfsImageWidget	Provides a widget for an extended image selection using the advanced gallery dialog.
CmsVfsImageWidgetConfiguration	Configuration options for the VFS image widget.
Messages	Convenience class to access the localized messages of this OpenCms package.

Enum Summary

Enum	Description
CmsLocationPickerWidgetValue.MapMode	Enumeration class for defining the map mode.
CmsLocationPickerWidgetValue.MapType	Enumeration class for defining the map types.

Exception Summary

Exception	Description
CmsWidgetConfigurationException	Exception thrown by widgets when they can'T parse their configuration.
CmsWidgetException	Describes errors that occur in the context of the OpenCms widgets.