Package org.opencms.workplace.editors

Class CmsEditorSessionInfo

java.lang.Object
org.opencms.workplace.editors.CmsEditorSessionInfo
public class CmsEditorSessionInfo extends Object
Stores editor session data.

Since:
8.0.

  • Field Details

  • Constructor Details

    • CmsEditorSessionInfo

      public CmsEditorSessionInfo(CmsUUID editedStructureId)
      Constructor.

      Parameters:
      editedStructureId - the id of the edited resource

  • Method Details

    • getEditorSessionInfoKey

      protected static 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 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 String getEditorSessionInfoKey()
      Returns the session info key for the bean.

      Returns:
      the session info key for the bean

    • getElementLocale

      public 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(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(Locale elementLocale)
      Sets the element locale currently edited.

      Parameters:
      elementLocale - the element locale to set