org.opencms.ade.publish

Class CmsCurrentPageProject

java.lang.Object

org.opencms.ade.publish.CmsCurrentPageProject

All Implemented Interfaces:

I_CmsVirtualProject

public class CmsCurrentPageProject
extends java.lang.Object
implements I_CmsVirtualProject

Virtual project which includes the currently edited resource and all its related resources.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CmsCurrentPageProject.Context Context class for the 'current page' project.

Nested classes/interfaces inherited from interface org.opencms.ade.publish.I_CmsVirtualProject

I_CmsVirtualProject.I_Context

Field Summary

Fields

Modifier and Type	Field and Description
static CmsUUID	ID The uuid of this virtual project.
static CmsCurrentPageProject	INSTANCE A static instance of this class.

Constructor Summary

Constructors

Constructor and Description
CmsCurrentPageProject()

Method Summary

Methods

Modifier and Type	Method and Description
CmsCurrentPageProject.Context	createContext(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params) Creates a context object to work with this virtual project.
CmsUUID	getProjectId() Gets the project id.

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final CmsUUID ID

The uuid of this virtual project.

INSTANCE

public static final CmsCurrentPageProject INSTANCE

A static instance of this class.

Constructor Detail

CmsCurrentPageProject

public CmsCurrentPageProject()

Method Detail

createContext

public CmsCurrentPageProject.Context createContext(CmsObject cms,
                                          java.util.Map<java.lang.String,java.lang.String> params)

Description copied from interface: I_CmsVirtualProject

Creates a context object to work with this virtual project.

Specified by:

createContext in interface I_CmsVirtualProject

Parameters:

cms - the current CMS context

params - the current publish parameters

Returns:

a new context based on the CmsObject and the publish parameters

See Also:

I_CmsVirtualProject.createContext(org.opencms.file.CmsObject, java.util.Map)

getProjectId

public CmsUUID getProjectId()

Description copied from interface: I_CmsVirtualProject

Gets the project id.

Specified by:

getProjectId in interface I_CmsVirtualProject

Returns:

the project id

See Also:

I_CmsVirtualProject.getProjectId()