Package org.opencms.gwt.shared

Class CmsQuickLaunchParams

java.lang.Object

org.opencms.gwt.shared.CmsQuickLaunchParams

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable

public class CmsQuickLaunchParams
extends Object
implements com.google.gwt.user.client.rpc.IsSerializable

Parameters used by the quick launch provider.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CmsQuickLaunchParams()	Default constructor for serialization.
	CmsQuickLaunchParams(String context, CmsUUID pageId, CmsUUID detailId, String returnCode, String path, CmsUUID sessionPageId)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	getContext()	Returns the context.
CmsUUID	getDetailId()	Returns the detailId.
CmsUUID	getPageId()	Returns the pageId.
String	getPath()	Gets the path.
String	getReturnCode()	Returns the returnCode.
CmsUUID	getSessionPageId()	Gets the id of the last edited container page.
boolean	isPageContext()	Returns true if the quick launcher is called from the page editor.
boolean	isSitemapContext()	Returns true if the quick launcher is called from the sitemap editor.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsQuickLaunchParams

public CmsQuickLaunchParams(String context,
 CmsUUID pageId,
 CmsUUID detailId,
 String returnCode,
 String path,
 CmsUUID sessionPageId)

Creates a new instance.

Parameters:

context - the quick launch context

pageId - the page id

detailId - the detail content id

returnCode - the return code

path - the path

sessionPageId - the id of the last opened page from the browser sessionStorage

CmsQuickLaunchParams

protected CmsQuickLaunchParams()

Default constructor for serialization.

Method Details

getContext

public String getContext()

Returns the context.

Returns:

the context

getDetailId

public CmsUUID getDetailId()

Returns the detailId.

Returns:

the detailId

getPageId

public CmsUUID getPageId()

Returns the pageId.

Returns:

the pageId

getPath

public String getPath()

Gets the path.

Returns:

the path

getReturnCode

public String getReturnCode()

Returns the returnCode.

Returns:

the returnCode

getSessionPageId

public CmsUUID getSessionPageId()

Gets the id of the last edited container page.

Returns:

the id of the last edited container page

isPageContext

public boolean isPageContext()

Returns true if the quick launcher is called from the page editor.

Returns:

true if the quick launcher was called from the page editor

isSitemapContext

public boolean isSitemapContext()

Returns true if the quick launcher is called from the sitemap editor.

Returns:

true if the quick launcher was called from the sitemap editor