Package org.opencms.widgets
Class A_CmsAdeGalleryWidget
- java.lang.Object
-
- org.opencms.widgets.A_CmsWidget
-
- org.opencms.widgets.A_CmsAdeGalleryWidget
-
- All Implemented Interfaces:
I_CmsADEWidget
,I_CmsWidget
- Direct Known Subclasses:
CmsAdeDownloadGalleryWidget
,CmsAdeImageGalleryWidget
public abstract class A_CmsAdeGalleryWidget extends A_CmsWidget implements I_CmsADEWidget
Base class for all ADE gallery widget implementations.- Since:
- 8.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.opencms.widgets.A_CmsWidget
A_CmsWidget.CmsDummyWidgetDialog
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.String
PATH_GALLERY_JSP
The gallery JSP path.-
Fields inherited from class org.opencms.widgets.A_CmsWidget
HELP_POSTFIX, LABEL_PREFIX
-
-
Constructor Summary
Constructors Modifier Constructor Description A_CmsAdeGalleryWidget()
Constructor.protected
A_CmsAdeGalleryWidget(java.lang.String configuration)
Creates a new gallery widget with the given configuration.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract JSONObject
getAdditionalGalleryInfo(CmsObject cms, java.lang.String resource, CmsMessages messages, I_CmsWidgetParameter param)
Returns additional widget information encapsulated in a JSON object.java.lang.String
getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
Returns the configuration string for the ADE content editor widget.java.util.List<java.lang.String>
getCssResourceLinks(CmsObject cms)
Returns a list of CSS resources required by the widget.I_CmsXmlContentHandler.DisplayType
getDefaultDisplayType()
Returns the default display type of this widget.java.lang.String
getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
Generates the widget HTML for the provided widget parameter.abstract java.lang.String
getGalleryName()
Returns the lower case name of the gallery, for example"html"
.protected java.util.Map<java.lang.String,java.lang.String>
getGalleryOpenParams(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param, java.lang.String resource, long hashId)
Returns the required gallery open parameters.protected java.lang.String
getGalleryStoragePrefix()
Gets the prefix for the key used to store the last selected gallery.protected abstract java.lang.String
getGalleryTypes()
Returns the resource type names available within this gallery widget.java.lang.String
getInitCall()
Returns the java script initialization call.java.util.List<java.lang.String>
getJavaScriptResourceLinks(CmsObject cms)
Returns a list of java script resources required by the widget.protected JSONObject
getJSONConfig(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
Returns the gallery widget configuration as a JSON object.protected java.lang.String
getOpenGalleryCall(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param, long hashId)
Returns the javascript call to open the gallery widget dialog.protected java.lang.String
getOpenPreviewCall(I_CmsWidgetDialog widgetDialog, java.lang.String id)
Returns the javascript call to open the preview dialog.protected CmsGalleryWidgetConfiguration
getWidgetConfiguration(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param)
Returns the widget configuration.java.lang.String
getWidgetName()
Returns the class name of the widget.boolean
isCompactViewEnabled()
Returns if the widget is compact view enabled.boolean
isInternal()
Returns if this is an internal widget.-
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
-
Methods inherited from interface org.opencms.widgets.I_CmsWidget
getConfiguration, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpText, getWidgetStringValue, newInstance, setConfiguration, setEditorValue
-
-
-
-
Field Detail
-
PATH_GALLERY_JSP
protected static final java.lang.String PATH_GALLERY_JSP
The gallery JSP path.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
A_CmsAdeGalleryWidget
public A_CmsAdeGalleryWidget()
Constructor.
-
A_CmsAdeGalleryWidget
protected A_CmsAdeGalleryWidget(java.lang.String configuration)
Creates a new gallery widget with the given configuration.- Parameters:
configuration
- the configuration to use
-
-
Method Detail
-
getConfiguration
public java.lang.String getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
Description copied from interface:I_CmsADEWidget
Returns the configuration string for the ADE content editor widget.- Specified by:
getConfiguration
in interfaceI_CmsADEWidget
- Parameters:
cms
- the OpenCms contextschemaType
- the schema typemessages
- the messagesresource
- the edited resourcecontentLocale
- the content locale- Returns:
- the configuration string
- See Also:
I_CmsADEWidget.getConfiguration(org.opencms.file.CmsObject, org.opencms.xml.types.A_CmsXmlContentValue, org.opencms.i18n.CmsMessages, org.opencms.file.CmsResource, java.util.Locale)
-
getCssResourceLinks
public java.util.List<java.lang.String> getCssResourceLinks(CmsObject cms)
Description copied from interface:I_CmsADEWidget
Returns a list of CSS resources required by the widget.- Specified by:
getCssResourceLinks
in interfaceI_CmsADEWidget
- Parameters:
cms
- the current OpenCms context- Returns:
- the required CSS resource links
- See Also:
I_CmsADEWidget.getCssResourceLinks(org.opencms.file.CmsObject)
-
getDefaultDisplayType
public I_CmsXmlContentHandler.DisplayType getDefaultDisplayType()
Description copied from interface:I_CmsADEWidget
Returns the default display type of this widget.- Specified by:
getDefaultDisplayType
in interfaceI_CmsADEWidget
- Returns:
- the default display type
- See Also:
I_CmsADEWidget.getDefaultDisplayType()
-
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.- Specified by:
getDialogWidget
in interfaceI_CmsWidget
- Parameters:
cms
- an initialized instance of a CmsObjectwidgetDialog
- the dialog where the widget is used onparam
- 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)
-
getGalleryName
public abstract java.lang.String getGalleryName()
Returns the lower case name of the gallery, for example"html"
.- Returns:
- the lower case name of the gallery
-
getInitCall
public java.lang.String getInitCall()
Description copied from interface:I_CmsADEWidget
Returns the java script initialization call.- Specified by:
getInitCall
in interfaceI_CmsADEWidget
- Returns:
- the java script initialization call
- See Also:
I_CmsADEWidget.getInitCall()
-
getJavaScriptResourceLinks
public java.util.List<java.lang.String> getJavaScriptResourceLinks(CmsObject cms)
Description copied from interface:I_CmsADEWidget
Returns a list of java script resources required by the widget.- Specified by:
getJavaScriptResourceLinks
in interfaceI_CmsADEWidget
- Parameters:
cms
- the current OpenCms context- Returns:
- the required java script resource links
- See Also:
I_CmsADEWidget.getJavaScriptResourceLinks(org.opencms.file.CmsObject)
-
getWidgetName
public java.lang.String getWidgetName()
Description copied from interface:I_CmsADEWidget
Returns the class name of the widget.- Specified by:
getWidgetName
in interfaceI_CmsADEWidget
- Returns:
- the class name
- See Also:
I_CmsADEWidget.getWidgetName()
-
isCompactViewEnabled
public boolean isCompactViewEnabled()
Description copied from interface:I_CmsWidget
Returns if the widget is compact view enabled.- Specified by:
isCompactViewEnabled
in interfaceI_CmsWidget
- Overrides:
isCompactViewEnabled
in classA_CmsWidget
- Returns:
true
if the widget is compact view enabled- See Also:
A_CmsWidget.isCompactViewEnabled()
-
isInternal
public boolean isInternal()
Description copied from interface:I_CmsADEWidget
Returns if this is an internal widget.Only widgets belonging to the OpenCms core should be marked as internal.
- Specified by:
isInternal
in interfaceI_CmsADEWidget
- Returns:
true
if this is an internal widget- See Also:
I_CmsADEWidget.isInternal()
-
getAdditionalGalleryInfo
protected abstract JSONObject getAdditionalGalleryInfo(CmsObject cms, java.lang.String resource, CmsMessages messages, I_CmsWidgetParameter param) throws JSONException
Returns additional widget information encapsulated in a JSON object.May be
null
.- Parameters:
cms
- an initialized instance of a CmsObjectresource
- the edited resourcemessages
- the dialog messagesparam
- the widget parameter to generate the widget for- Returns:
- additional widget information
- Throws:
JSONException
- if something goes wrong generating the JSON object
-
getGalleryOpenParams
protected java.util.Map<java.lang.String,java.lang.String> getGalleryOpenParams(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param, java.lang.String resource, long hashId)
Returns the required gallery open parameters.- Parameters:
cms
- an initialized instance of a CmsObjectmessages
- the dialog messagesparam
- the widget parameter to generate the widget forresource
- the resource being editedhashId
- the field id hash- Returns:
- the gallery open parameters
-
getGalleryStoragePrefix
protected java.lang.String getGalleryStoragePrefix()
Gets the prefix for the key used to store the last selected gallery.- Returns:
- the key prefix
-
getGalleryTypes
protected abstract java.lang.String getGalleryTypes()
Returns the resource type names available within this gallery widget.- Returns:
- the resource type names
-
getJSONConfig
protected JSONObject getJSONConfig(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
Returns the gallery widget configuration as a JSON object.- Parameters:
cms
- the cms contextschemaType
- the schema typemessages
- the messagesresource
- the edited resourcecontentLocale
- the content locale- Returns:
- the gallery widget configuration
-
getOpenGalleryCall
protected java.lang.String getOpenGalleryCall(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param, long hashId)
Returns the javascript call to open the gallery widget dialog.- Parameters:
cms
- an initialized instance of a CmsObjectwidgetDialog
- the dialog where the widget is used onparam
- the widget parameter to generate the widget forhashId
- the field id hash- Returns:
- the javascript call to open the gallery widget dialog
-
getOpenPreviewCall
protected java.lang.String getOpenPreviewCall(I_CmsWidgetDialog widgetDialog, java.lang.String id)
Returns the javascript call to open the preview dialog.- Parameters:
widgetDialog
- the dialog where the widget is used onid
- the field id- Returns:
- the javascript call to open the preview dialog
-
getWidgetConfiguration
protected CmsGalleryWidgetConfiguration getWidgetConfiguration(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param)
Returns the widget configuration.- Parameters:
cms
- an initialized instance of a CmsObjectmessages
- the dialog where the widget is used onparam
- the widget parameter to generate the widget for- Returns:
- the widget configuration
-
-