Package org.opencms.ade.galleries
Class CmsGalleryActionElement
- java.lang.Object
-
- org.opencms.jsp.CmsJspBean
-
- org.opencms.jsp.CmsJspActionElement
-
- org.opencms.gwt.CmsGwtActionElement
-
- org.opencms.ade.galleries.CmsGalleryActionElement
-
public class CmsGalleryActionElement extends CmsGwtActionElement
Gallery action used to generate the gallery dialog.see jsp file /system/modules/org.opencms.ade.galleries/testVfs.jsp.
- Since:
- 8.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CMS_MODULE_NAME
The OpenCms module name.static java.lang.String
GWT_MODULE_NAME
The GWT module name.-
Fields inherited from class org.opencms.gwt.CmsGwtActionElement
SCRIPT_TAG_CLOSE, SCRIPT_TAG_OPEN
-
Fields inherited from class org.opencms.jsp.CmsJspActionElement
NOT_INITIALIZED
-
-
Constructor Summary
Constructors Constructor Description CmsGalleryActionElement(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
export()
Returns the serialized data for the core provider wrapped in a script tag.java.lang.String
exportAll()
Returns the serialized data for the core provider.java.lang.String
exportForContainerpage()
Returns the serialized initial data for gallery dialog within the container-page editor.java.lang.String
exportWidget()
Exports the gallery messages for widget use.java.lang.String
getTitle()
Returns the editor title.boolean
isEditorMode()
Returns if the current gallery mode is the editor mode (used inside a rich text editor).boolean
isViewMode()
Returns true if the gallery mode is set to 'view'.boolean
isWidgetMode()
Returns if the current gallery mode is the widget mode (used within xml-content editor etc.).-
Methods inherited from class org.opencms.gwt.CmsGwtActionElement
createNoCacheScript, createNoCacheScript, export, exportCommon, exportDictionary, exportDictionary, exportMeta, exportModuleScriptTag, getCoreData, getFontIconCssLink, getWorkplaceLocale, serialize, wrapScript
-
Methods inherited from class org.opencms.jsp.CmsJspActionElement
editable, editable, editable, editableManualClose, editableManualOpen, getContent, getContent, getMessages, getMessages, getMessages, getMessages, getNavigation, getNavigationUri, img, img, include, include, include, include, include, include, includeSilent, includeSilent, includeSilent, includeSilent, info, label, link, link, properties, properties, property, property, property, property, template, template, template, toAbsolute, user
-
Methods inherited from class org.opencms.jsp.CmsJspBean
getCmsObject, getController, getJspContext, getMessage, getRequest, getRequestContext, getResponse, handleException, handleMissingFlexController, init, isNotInitialized, isSupressingExceptions, setContentType, setStatus, setSupressingExceptions
-
-
-
-
Field Detail
-
CMS_MODULE_NAME
public static final java.lang.String CMS_MODULE_NAME
The OpenCms module name.- See Also:
- Constant Field Values
-
GWT_MODULE_NAME
public static final java.lang.String GWT_MODULE_NAME
The GWT module name.
-
-
Constructor Detail
-
CmsGalleryActionElement
public CmsGalleryActionElement(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Constructor.- Parameters:
context
- the JSP page context objectreq
- the JSP requestres
- the JSP response
-
-
Method Detail
-
export
public java.lang.String export() throws java.lang.Exception
Description copied from class:CmsGwtActionElement
Returns the serialized data for the core provider wrapped in a script tag.- Overrides:
export
in classCmsGwtActionElement
- Returns:
- the data
- Throws:
java.lang.Exception
- if something goes wrong- See Also:
CmsGwtActionElement.export()
-
exportAll
public java.lang.String exportAll() throws java.lang.Exception
Description copied from class:CmsGwtActionElement
Returns the serialized data for the core provider.- Overrides:
exportAll
in classCmsGwtActionElement
- Returns:
- the data
- Throws:
java.lang.Exception
- if something goes wrong- See Also:
CmsGwtActionElement.exportAll()
-
exportForContainerpage
public java.lang.String exportForContainerpage() throws java.lang.Exception
Returns the serialized initial data for gallery dialog within the container-page editor.- Returns:
- the data
- Throws:
java.lang.Exception
- if something goes wrong
-
exportWidget
public java.lang.String exportWidget()
Exports the gallery messages for widget use.- Returns:
- the gallery messages
-
getTitle
public java.lang.String getTitle()
Returns the editor title.- Returns:
- the editor title
-
isEditorMode
public boolean isEditorMode()
Returns if the current gallery mode is the editor mode (used inside a rich text editor).- Returns:
true
if the gallery was opened from the editor
-
isViewMode
public boolean isViewMode()
Returns true if the gallery mode is set to 'view'.- Returns:
- true if the gallery mode is 'view'
-
isWidgetMode
public boolean isWidgetMode()
Returns if the current gallery mode is the widget mode (used within xml-content editor etc.).- Returns:
true
if the gallery was opened as a widget
-
-