Package org.opencms.ade.sitemap

Class CmsSitemapActionElement

java.lang.Object

org.opencms.jsp.CmsJspBean

org.opencms.jsp.CmsJspActionElement

org.opencms.gwt.CmsGwtActionElement

org.opencms.ade.sitemap.CmsSitemapActionElement

public class CmsSitemapActionElement
extends CmsGwtActionElement

Sitemap action used to generate the sitemap editor.

See jsp file /system/workplace/commons/sitemap.jsp.

Since:

8.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CMS_MODULE_NAME	The OpenCms module name.
static final 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
CmsSitemapActionElement(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	export()	Returns the serialized data for the core provider wrapped in a script tag.
String	exportAll()	Returns the serialized data for the core provider.
CmsSitemapData	getSitemapData()	Returns the needed server data for client-side usage.
String	getTitle()	Returns the editor title.

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CMS_MODULE_NAME

public static final String CMS_MODULE_NAME

The OpenCms module name.

See Also:

• Constant Field Values

GWT_MODULE_NAME

public static final String GWT_MODULE_NAME

The GWT module name.

See Also:

• Constant Field Values

Constructor Details

CmsSitemapActionElement

public CmsSitemapActionElement(javax.servlet.jsp.PageContext context,
 javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse res)

Constructor.

Parameters:

context - the JSP page context object

req - the JSP request

res - the JSP response

Method Details

export

public String export()
              throws Exception

Description copied from class: CmsGwtActionElement

Returns the serialized data for the core provider wrapped in a script tag.

Overrides:

export in class CmsGwtActionElement

Returns:

the data

Throws:

Exception - if something goes wrong

See Also:

• CmsGwtActionElement.export()

exportAll

public String exportAll()
                 throws Exception

Description copied from class: CmsGwtActionElement

Returns the serialized data for the core provider.

Overrides:

exportAll in class CmsGwtActionElement

Returns:

the data

Throws:

Exception - if something goes wrong

See Also:

• CmsGwtActionElement.exportAll()

getSitemapData

public CmsSitemapData getSitemapData()

Returns the needed server data for client-side usage.

Returns:

the needed server data for client-side usage

getTitle

public String getTitle()

Returns the editor title.

Returns:

the editor title