Package org.opencms.workplace.explorer

Class CmsNewResource

java.lang.Object

org.opencms.workplace.explorer.CmsNewResource

public class CmsNewResource
extends Object

The new resource entry dialog which displays the possible "new actions" for the current user.

It handles the creation of "simple" resource types like plain or JSP resources.

The following files use this class:

• /commons/newresource.jsp

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ACTION_NEWFORM	The value for the resource name form action.
static final int	ACTION_SUBMITFORM	The value for the resource name form submission action.
static final int	BUTTON_NEXT	Constant for the "Next" button in the build button methods.
static final String	DEFAULT_SUFFIX	The default suffix.
static final char	DELIM_PROPERTYVALUES	Delimiter for property values, e.g.
static final String	DIALOG_ADVANCED	The name for the advanced resource form action.
static final String	DIALOG_NEWFORM	The name for the resource form action.
static final String	DIALOG_SUBMITFORM	The name for the resource form submission action.
static final String	DIALOG_TYPE	The dialog type.
static final String	LIST_COLUMN_URI	List column id constant.
static final String	PARAM_APPENDSUFFIXHTML	Request parameter name for the append html suffix checkbox.
static final String	PARAM_CURRENTFOLDER	Request parameter name for the current folder name.
static final String	PARAM_NEWFORMURI	Request parameter name for the new form uri.
static final String	PARAM_NEWRESOURCEEDITPROPS	Request parameter name for the new resource edit properties flag.
static final String	PARAM_NEWRESOURCETYPE	Request parameter name for the new resource type.
static final String	PARAM_NEWRESOURCEURI	Request parameter name for the new resource uri.
static final String	SESSION_ATTR_ADVANCED	Session attribute to store advanced mode.
static final String	SESSION_ATTR_PAGE	Session attribute to store current page.
static final String	VALUE_DEFAULT	The property value for available resource to reset behaviour to default dialog.

Constructor Summary

Constructors

Constructor	Description
CmsNewResource()

Method Summary

Modifier and Type	Method	Description
static String	computeNewTitleProperty(String name)	Returns the value for the Title property from the given resource name.
protected static org.opencms.file.CmsProperty	createPropertyObject(String name, String value)	Creates a single property object and sets the value individual or shared depending on the OpenCms settings.
protected static List<org.opencms.file.CmsProperty>	createResourceProperties(org.opencms.file.CmsObject cms, String resourceName, String resTypeName, String title)	Returns the properties to create automatically with the new VFS resource.
static Object	getNewResourceHandler(String type, String defaultClassName, javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	A factory to return handlers to create new resources.

Methods inherited from class java.lang.Object

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

Field Details

ACTION_NEWFORM

public static final int ACTION_NEWFORM

The value for the resource name form action.

See Also:

• Constant Field Values

ACTION_SUBMITFORM

public static final int ACTION_SUBMITFORM

The value for the resource name form submission action.

See Also:

• Constant Field Values

BUTTON_NEXT

public static final int BUTTON_NEXT

Constant for the "Next" button in the build button methods.

See Also:

• Constant Field Values

DEFAULT_SUFFIX

public static final String DEFAULT_SUFFIX

The default suffix.

See Also:

• Constant Field Values

DELIM_PROPERTYVALUES

public static final char DELIM_PROPERTYVALUES

Delimiter for property values, e.g. for available resource types or template sites.

See Also:

• Constant Field Values

DIALOG_ADVANCED

public static final String DIALOG_ADVANCED

The name for the advanced resource form action.

See Also:

• Constant Field Values

DIALOG_NEWFORM

public static final String DIALOG_NEWFORM

The name for the resource form action.

See Also:

• Constant Field Values

DIALOG_SUBMITFORM

public static final String DIALOG_SUBMITFORM

The name for the resource form submission action.

See Also:

• Constant Field Values

DIALOG_TYPE

public static final String DIALOG_TYPE

The dialog type.

See Also:

• Constant Field Values

LIST_COLUMN_URI

public static final String LIST_COLUMN_URI

List column id constant.

See Also:

• Constant Field Values

PARAM_APPENDSUFFIXHTML

public static final String PARAM_APPENDSUFFIXHTML

Request parameter name for the append html suffix checkbox.

See Also:

• Constant Field Values

PARAM_CURRENTFOLDER

public static final String PARAM_CURRENTFOLDER

Request parameter name for the current folder name.

See Also:

• Constant Field Values

PARAM_NEWFORMURI

public static final String PARAM_NEWFORMURI

Request parameter name for the new form uri.

See Also:

• Constant Field Values

PARAM_NEWRESOURCEEDITPROPS

public static final String PARAM_NEWRESOURCEEDITPROPS

Request parameter name for the new resource edit properties flag.

See Also:

• Constant Field Values

PARAM_NEWRESOURCETYPE

public static final String PARAM_NEWRESOURCETYPE

Request parameter name for the new resource type.

See Also:

• Constant Field Values

PARAM_NEWRESOURCEURI

public static final String PARAM_NEWRESOURCEURI

Request parameter name for the new resource uri.

See Also:

• Constant Field Values

SESSION_ATTR_ADVANCED

public static final String SESSION_ATTR_ADVANCED

Session attribute to store advanced mode.

See Also:

• Constant Field Values

SESSION_ATTR_PAGE

public static final String SESSION_ATTR_PAGE

Session attribute to store current page.

See Also:

• Constant Field Values

VALUE_DEFAULT

public static final String VALUE_DEFAULT

The property value for available resource to reset behaviour to default dialog.

See Also:

• Constant Field Values

Constructor Details

CmsNewResource

public CmsNewResource()

Method Details

computeNewTitleProperty

public static String computeNewTitleProperty(String name)

Returns the value for the Title property from the given resource name.

Parameters:

name - the name of the resource

Returns:

the value for the Title property from the given resource name

getNewResourceHandler

public static Object getNewResourceHandler(String type,
 String defaultClassName,
 javax.servlet.jsp.PageContext context,
 javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse res)
                                    throws org.opencms.main.CmsRuntimeException

A factory to return handlers to create new resources.

Parameters:

type - the resource type name to get a new resource handler for, as specified in the explorer type settings

defaultClassName - a default handler class name, to be used if the handler class specified in the explorer type settings cannot be found

context - the JSP page context

req - the JSP request

res - the JSP response

Returns:

a new instance of the handler class

Throws:

org.opencms.main.CmsRuntimeException - if something goes wrong

createPropertyObject

protected static org.opencms.file.CmsProperty createPropertyObject(String name,
 String value)

Creates a single property object and sets the value individual or shared depending on the OpenCms settings.

Parameters:

name - the name of the property

value - the value to set

Returns:

an initialized property object

createResourceProperties

protected static List<org.opencms.file.CmsProperty> createResourceProperties(org.opencms.file.CmsObject cms,
 String resourceName,
 String resTypeName,
 String title)

Returns the properties to create automatically with the new VFS resource.

If configured, the Title and Navigation properties are set on resource creation.

Parameters:

cms - the initialized CmsObject

resourceName - the full resource name

resTypeName - the name of the resource type

title - the Title String to use for the property values

Returns:

the List of initialized property objects