Package org.opencms.widgets
Class CmsImageGalleryWidget
- java.lang.Object
-
- org.opencms.widgets.A_CmsWidget
-
- org.opencms.widgets.A_CmsGalleryWidget
-
- org.opencms.widgets.CmsImageGalleryWidget
-
- All Implemented Interfaces:
I_CmsADEWidget
,I_CmsWidget
public class CmsImageGalleryWidget extends A_CmsGalleryWidget
Provides a widget that allows access to the available OpenCms image galleries, for use on a widget dialog.- 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 Constructor Description CmsImageGalleryWidget()
Creates a new image gallery widget.CmsImageGalleryWidget(java.lang.String configuration)
Creates a new image gallery widget with the given configuration.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getNameLower()
Returns the lower case name of the gallery, for example"html"
.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.I_CmsWidget
newInstance()
Creates a duplicate of this widget instance.boolean
showPreview(java.lang.String value)
Returnstrue
if the preview button should be shown.-
Methods inherited from class org.opencms.widgets.A_CmsGalleryWidget
getConfiguration, getCssResourceLinks, getDefaultDisplayType, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getDialogWidget, getInitCall, getJavaScriptResourceLinks, isCompactViewEnabled, isInternal
-
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, setConfiguration, setEditorValue
-
-
-
-
Constructor Detail
-
CmsImageGalleryWidget
public CmsImageGalleryWidget()
Creates a new image gallery widget.
-
CmsImageGalleryWidget
public CmsImageGalleryWidget(java.lang.String configuration)
Creates a new image gallery widget with the given configuration.- Parameters:
configuration
- the configuration to use
-
-
Method Detail
-
getNameLower
public java.lang.String getNameLower()
Description copied from class:A_CmsGalleryWidget
Returns the lower case name of the gallery, for example"html"
.- Specified by:
getNameLower
in classA_CmsGalleryWidget
- Returns:
- the lower case name of the gallery
- See Also:
A_CmsGalleryWidget.getNameLower()
-
getNameUpper
public java.lang.String getNameUpper()
Description copied from class:A_CmsGalleryWidget
Returns the upper case name of the gallery, for example"Html"
.- Specified by:
getNameUpper
in classA_CmsGalleryWidget
- Returns:
- the upper case name of the gallery
- See Also:
A_CmsGalleryWidget.getNameUpper()
-
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
- Overrides:
getWidgetName
in classA_CmsGalleryWidget
- Returns:
- the class name
- See Also:
I_CmsADEWidget.getWidgetName()
-
newInstance
public I_CmsWidget newInstance()
Description copied from interface:I_CmsWidget
Creates a duplicate of this widget instance.- Returns:
- a duplicate of this widget instance
- See Also:
I_CmsWidget.newInstance()
-
showPreview
public boolean showPreview(java.lang.String value)
Description copied from class:A_CmsGalleryWidget
Returnstrue
if the preview button should be shown.- Specified by:
showPreview
in classA_CmsGalleryWidget
- Parameters:
value
- the current widget value- Returns:
true
if the preview button should be shown- See Also:
A_CmsGalleryWidget.showPreview(java.lang.String)
-
-