Package org.opencms.widgets
Class A_CmsGalleryWidget
- java.lang.Object
-
- org.opencms.widgets.A_CmsWidget
-
- org.opencms.widgets.A_CmsGalleryWidget
-
- All Implemented Interfaces:
I_CmsADEWidget
,I_CmsWidget
- Direct Known Subclasses:
CmsDownloadGalleryWidget
,CmsImageGalleryWidget
,CmsLinkGalleryWidget
public abstract class A_CmsGalleryWidget extends A_CmsWidget implements I_CmsADEWidget
Base class for all gallery widget implementations.- Since:
- 6.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.opencms.widgets.A_CmsWidget
A_CmsWidget.CmsDummyWidgetDialog
-
-
Field Summary
-
Fields inherited from class org.opencms.widgets.A_CmsWidget
HELP_POSTFIX, LABEL_PREFIX
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
A_CmsGalleryWidget()
Creates a new gallery widget.protected
A_CmsGalleryWidget(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 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
getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
Generates the necessary JavaScript inclusion code for this widget.java.lang.String
getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog)
Generates the initialisation method JavaScript code for this widget.java.lang.String
getDialogInitMethod(CmsObject cms, I_CmsWidgetDialog widgetDialog)
Generates the initialization method JavaScript code for this widget.java.lang.String
getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
Generates the widget HTML for the provided widget parameter.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.abstract java.lang.String
getNameLower()
Returns the lower case name of the gallery, for example"html"
.abstract java.lang.String
getNameUpper()
Returns the upper case name of the gallery, for example"Html"
.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.abstract boolean
showPreview(java.lang.String value)
Returnstrue
if the preview button should be shown.-
Methods inherited from class org.opencms.widgets.A_CmsWidget
equals, getConfiguration, getDialogHtmlEnd, 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, getHelpBubble, getHelpText, getWidgetStringValue, newInstance, setConfiguration, setEditorValue
-
-
-
-
Constructor Detail
-
A_CmsGalleryWidget
protected A_CmsGalleryWidget()
Creates a new gallery widget.
-
A_CmsGalleryWidget
protected A_CmsGalleryWidget(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()
-
getDialogIncludes
public java.lang.String getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
Description copied from interface:I_CmsWidget
Generates the necessary JavaScript inclusion code for this widget.- Specified by:
getDialogIncludes
in interfaceI_CmsWidget
- Overrides:
getDialogIncludes
in classA_CmsWidget
- Parameters:
cms
- the current users OpenCms contextwidgetDialog
- the dialog where the widget is used on- Returns:
- the JavaScript inclusion code
- See Also:
I_CmsWidget.getDialogIncludes(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)
-
getDialogInitCall
public java.lang.String getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog)
Description copied from interface:I_CmsWidget
Generates the initialisation method JavaScript code for this widget.- Specified by:
getDialogInitCall
in interfaceI_CmsWidget
- Overrides:
getDialogInitCall
in classA_CmsWidget
- Parameters:
cms
- the current users OpenCms contextwidgetDialog
- the dialog where the widget is used on- Returns:
- the initialisation method JavaScript code
- See Also:
I_CmsWidget.getDialogInitCall(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)
-
getDialogInitMethod
public java.lang.String getDialogInitMethod(CmsObject cms, I_CmsWidgetDialog widgetDialog)
Description copied from interface:I_CmsWidget
Generates the initialization method JavaScript code for this widget.- Specified by:
getDialogInitMethod
in interfaceI_CmsWidget
- Overrides:
getDialogInitMethod
in classA_CmsWidget
- Parameters:
cms
- an initialized instance of a CmsObjectwidgetDialog
- the dialog where the widget is used on- Returns:
- the initialization method JavaScript code
- See Also:
I_CmsWidget.getDialogInitMethod(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)
-
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)
-
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)
-
getNameLower
public abstract java.lang.String getNameLower()
Returns the lower case name of the gallery, for example"html"
.- Returns:
- the lower case name of the gallery
-
getNameUpper
public abstract java.lang.String getNameUpper()
Returns the upper case name of the gallery, for example"Html"
.- Returns:
- the upper case name of the gallery
-
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()
-
showPreview
public abstract boolean showPreview(java.lang.String value)
Returnstrue
if the preview button should be shown.- Parameters:
value
- the current widget value- Returns:
true
if the preview button should be shown
-
-