Package org.opencms.workplace.editors

Class CmsEditorSessionInfo

java.lang.Object

org.opencms.workplace.editors.CmsEditorSessionInfo

public class CmsEditorSessionInfo
extends java.lang.Object

Stores editor session data.

Since:

8.0.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PREFIX_EDITOR_SESSION_INFO	The editor session info key prefix.

Constructor Summary

Constructors

Constructor	Description
CmsEditorSessionInfo(CmsUUID editedStructureId)	Constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getBackLink()	Returns the back link for closing the editor.
CmsUUID	getEditedStructureId()	Returns the id of the edited resource.
java.lang.String	getEditorSessionInfoKey()	Returns the session info key for the bean.
protected static java.lang.String	getEditorSessionInfoKey(CmsResource editedResource)	Returns the session info key for the bean.
java.util.Locale	getElementLocale()	Returns the element locale currently edited.
boolean	isDirectEdit()	Returns if in direct edit mode.
void	setBackLink(java.lang.String backLink)	Sets the back link for closing the editor.
void	setDirectEdit(boolean directEdit)	Sets the flag indicating if in direct edit mode.
void	setEditedStructureId(CmsUUID editedStructureId)	Sets the id of the edited resource.
void	setElementLocale(java.util.Locale elementLocale)	Sets the element locale currently edited.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX_EDITOR_SESSION_INFO

public static final java.lang.String PREFIX_EDITOR_SESSION_INFO

The editor session info key prefix.

See Also:

Constant Field Values

Constructor Detail

CmsEditorSessionInfo

public CmsEditorSessionInfo(CmsUUID editedStructureId)

Constructor.

Parameters:

editedStructureId - the id of the edited resource

Method Detail

getEditorSessionInfoKey

protected static java.lang.String getEditorSessionInfoKey(CmsResource editedResource)

Returns the session info key for the bean.

Parameters:

editedResource - the edited resource

Returns:

the session info key for the bean

getBackLink

public java.lang.String getBackLink()

Returns the back link for closing the editor.

Returns:

the back link for closing the editor

getEditedStructureId

public CmsUUID getEditedStructureId()

Returns the id of the edited resource.

Returns:

the id of the edited resource

getEditorSessionInfoKey

public java.lang.String getEditorSessionInfoKey()

Returns the session info key for the bean.

Returns:

the session info key for the bean

getElementLocale

public java.util.Locale getElementLocale()

Returns the element locale currently edited.

Returns:

the element locale

isDirectEdit

public boolean isDirectEdit()

Returns if in direct edit mode.

Returns:

true if in direct edit mode

setBackLink

public void setBackLink(java.lang.String backLink)

Sets the back link for closing the editor.

Parameters:

backLink - the back link for closing the editor to set

setDirectEdit

public void setDirectEdit(boolean directEdit)

Sets the flag indicating if in direct edit mode.

Parameters:

directEdit - the flag indicating if in direct edit mode

setEditedStructureId

public void setEditedStructureId(CmsUUID editedStructureId)

Sets the id of the edited resource.

Parameters:

editedStructureId - the id of the edited resource to set

setElementLocale

public void setElementLocale(java.util.Locale elementLocale)

Sets the element locale currently edited.

Parameters:

elementLocale - the element locale to set