Package org.opencms.workplace.explorer

Class CmsNewResourceXmlPage

java.lang.Object

org.opencms.workplace.explorer.CmsNewResourceXmlPage

public class CmsNewResourceXmlPage
extends Object

The new resource page dialog handles the creation of an xml page.

The following files use this class:

• /commons/newresource_xmlpage.jsp

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_BODYFILE	Request parameter name for the selected body.
static final String	PARAM_SUFFIXCHECK	Request parameter name for the suffix check.
static final String	PARAM_TEMPLATE	Request parameter name for the selected template.

Constructor Summary

Constructors

Constructor	Description
CmsNewResourceXmlPage()

Method Summary

Modifier and Type	Method	Description
static TreeMap<String,String>	getBodies(org.opencms.file.CmsObject cms, String currWpPath)	Returns a sorted Map of all available body files of the OpenCms modules.
static TreeMap<String,String>	getBodies(org.opencms.file.CmsObject cms, String currWpPath, boolean emptyMap)	Returns a sorted Map of all available body files of the OpenCms modules.
protected static TreeMap<String,String>	getElements(org.opencms.file.CmsObject cms, String elementFolder, String currWpPath, boolean emptyMap)	Returns a sorted Map of all available elements in the specified subfolder of the OpenCms modules.
static TreeMap<String,String>	getTemplates(org.opencms.file.CmsObject cms, String currWpPath)	Returns a sorted Map of all available templates of the OpenCms modules.
static TreeMap<String,String>	getTemplates(org.opencms.file.CmsObject cms, String currWpPath, boolean emptyMap)	Returns a sorted Map of all available templates of the OpenCms modules.

Methods inherited from class java.lang.Object

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

Field Details

PARAM_BODYFILE

public static final String PARAM_BODYFILE

Request parameter name for the selected body.

See Also:

• Constant Field Values

PARAM_SUFFIXCHECK

public static final String PARAM_SUFFIXCHECK

Request parameter name for the suffix check.

See Also:

• Constant Field Values

PARAM_TEMPLATE

public static final String PARAM_TEMPLATE

Request parameter name for the selected template.

See Also:

• Constant Field Values

Constructor Details

CmsNewResourceXmlPage

public CmsNewResourceXmlPage()

Method Details

getBodies

public static TreeMap<String,String> getBodies(org.opencms.file.CmsObject cms,
 String currWpPath)
                                        throws org.opencms.main.CmsException

Returns a sorted Map of all available body files of the OpenCms modules.

Parameters:

cms - the current cms object

currWpPath - the current path in the OpenCms workplace

Returns:

a sorted map with the body file title as key and absolute path to the body file as value

Throws:

org.opencms.main.CmsException - if reading a folder or file fails

getBodies

public static TreeMap<String,String> getBodies(org.opencms.file.CmsObject cms,
 String currWpPath,
 boolean emptyMap)
                                        throws org.opencms.main.CmsException

Returns a sorted Map of all available body files of the OpenCms modules.

Parameters:

cms - the current cms object

currWpPath - the current path in the OpenCms workplace

emptyMap - flag indicating if it is OK to return a filtered empty Map

Returns:

a sorted map with the body file title as key and absolute path to the body file as value

Throws:

org.opencms.main.CmsException - if reading a folder or file fails

getTemplates

public static TreeMap<String,String> getTemplates(org.opencms.file.CmsObject cms,
 String currWpPath)
                                           throws org.opencms.main.CmsException

Returns a sorted Map of all available templates of the OpenCms modules.

Parameters:

cms - the current cms object

currWpPath - the current path in the OpenCms workplace

Returns:

a sorted map with the template title as key and absolute path to the template as value

Throws:

org.opencms.main.CmsException - if reading a folder or file fails

getTemplates

public static TreeMap<String,String> getTemplates(org.opencms.file.CmsObject cms,
 String currWpPath,
 boolean emptyMap)
                                           throws org.opencms.main.CmsException

Returns a sorted Map of all available templates of the OpenCms modules.

Parameters:

cms - the current cms object

currWpPath - the current path in the OpenCms workplace

emptyMap - flag indicating if it is OK to return a filtered empty Map

Returns:

a sorted map with the template title as key and absolute path to the template as value

Throws:

org.opencms.main.CmsException - if reading a folder or file fails

getElements

protected static TreeMap<String,String> getElements(org.opencms.file.CmsObject cms,
 String elementFolder,
 String currWpPath,
 boolean emptyMap)
                                             throws org.opencms.main.CmsException

Returns a sorted Map of all available elements in the specified subfolder of the OpenCms modules.

Parameters:

cms - the current cms object

elementFolder - the module subfolder to search for elements

currWpPath - the current path in the OpenCms workplace

emptyMap - flag indicating if it is OK to return a filtered empty Map

Returns:

a sorted map with the element title as key and absolute path to the element as value

Throws:

org.opencms.main.CmsException - if reading a folder or file fails