Package org.opencms.workplace.explorer

Class CmsResourceUtil

java.lang.Object
org.opencms.workplace.explorer.CmsResourceUtil
public final class CmsResourceUtil extends Object
Provides CmsResource utility functions.

This class provides in java all resource information used by the explorer view, mostly generated in javascript (see explorer.js)

Since:
6.0.0

  • Field Details

  • Constructor Details

  • Method Details

    • getBigIconResource

      public static com.vaadin.server.Resource getBigIconResource(CmsExplorerTypeSettings explorerType, String resourceName)
      Returns the big icon resource for the given resource.

      Parameters:
      explorerType - the resource explorer type settings
      resourceName - the resource name
      Returns:
      the icon resource

    • getSmallIconResource

      public static com.vaadin.server.Resource getSmallIconResource(CmsExplorerTypeSettings explorerType, String resourceName)
      Returns the small icon resource for the given resource.

      Parameters:
      explorerType - the resource explorer type settings
      resourceName - the resource name
      Returns:
      the icon resource

    • getAbbrevLength

      public int getAbbrevLength()
      Returns the path abbreviation length.

      If greater than zero, the path will be formatted to this number of chars.

      This only affects the generation of the path for the current resource.

      Returns:
      the path abbreviation Length

    • getBigIconResource

      public com.vaadin.server.Resource getBigIconResource()
      Returns the big icon resource of the current resource.

      Returns:
      the icon resource

    • getCms

      public CmsObject getCms()
      Returns the cms context.

      Returns:
      the cms context

    • getDateExpired

      public String getDateExpired()
      Returns the formatted date of expiration.

      Returns:
      the formatted date of expiration

    • getDateReleased

      public String getDateReleased()
      Returns the formatted date of release.

      Returns:
      the formatted date of release

    • getFullPath

      public String getFullPath()
      Returns the path of the current resource, taking into account just the site mode.

      Returns:
      the full path

    • getGalleryDescription

      public String getGalleryDescription(Locale locale)
      Returns the gallery description of the current resource.

      Parameters:
      locale - the content locale
      Returns:
      the gallery description

    • getGalleryTitle

      public String getGalleryTitle(Locale locale)
      Returns the gallery title of the current resource.

      Parameters:
      locale - the content locale
      Returns:
      the gallery title

    • getIconPathExplorer

      public String getIconPathExplorer()
      Returns the resource icon path displayed in the explorer view for the given resource.

      Relative to /system/workplace/resources/.

      If the resource has no sibling it is the same as getIconPathResourceType().

      Returns:
      the resource icon path displayed in the explorer view for the given resource
      See Also:

    • getIconPathLock

      public String getIconPathLock()
      Returns the lock icon path for the given resource.

      Relative to /system/workplace/resources/.

      Returns explorer/project_none.gif if request context is null.

      Returns:
      the lock icon path for the given resource

    • getIconPathProjectState

      public String getIconPathProjectState()
      Returns the project state icon path for the given resource.

      Relative to /system/workplace/resources/.

      Returns:
      the project state icon path for the given resource

    • getIconPathResourceType

      public String getIconPathResourceType()
      Returns the resource type icon path for the given resource.

      Relative to /system/workplace/resources/.

      Returns:
      the resource type icon path for the given resource

    • getLinkType

      public int getLinkType()
      Returns an integer representation for the link type.

      • 0: No sibling
      • 1: Sibling
      • 2: Labeled sibling
      Returns:
      an integer representation for the link type

    • getLock

      public CmsLock getLock()
      Returns the the lock for the given resource.

      Returns:
      the lock the given resource

    • getLockedByName

      public String getLockedByName()
      Returns the user name who owns the lock for the given resource.

      Returns:
      the user name who owns the lock for the given resource

    • getLockedInProjectId

      public CmsUUID getLockedInProjectId()
      Returns the id of the project in which the given resource is locked.

      Returns:
      the id of the project in which the given resource is locked

    • getLockedInProjectName

      public String getLockedInProjectName()
      Returns the project name that locked the current resource's.

      Returns:
      the the project name that locked the current resource's

    • getLockState

      public int getLockState()
      Returns the lock state of the current resource.

      Returns:
      the lock state of the current resource

    • getNavText

      public String getNavText()
      Returns the navtext of a resource.

      Returns:
      the navtext for that resource

    • getNoEditReason

      public String getNoEditReason(Locale locale) throws CmsException
      Checks is the current resource can be edited by the current user.

      Parameters:
      locale - the locale to use for the messages
      Returns:
      an empty string if editable, or a localized string with the reason
      Throws:
      CmsException - if something goes wrong

    • getNoEditReason

      public String getNoEditReason(Locale locale, boolean ignoreExpiration) throws CmsException
      Checks is the current resource can be edited by the current user.

      Parameters:
      locale - the locale to use for the messages
      ignoreExpiration - true to ignore resource release and expiration date
      Returns:
      an empty string if editable, or a localized string with the reason
      Throws:
      CmsException - if something goes wrong

    • getPath

      public String getPath()
      Returns the path of the current resource.

      Taking into account following settings:

      • site mode
      • abbreviation length
      • relative to
      Returns:
      the path

    • getPermissionSet

      public CmsPermissionSet getPermissionSet()
      Returns the permission set for the given resource.

      Returns:
      the permission set for the given resource

    • getPermissionString

      public String getPermissionString()
      Returns the permissions string for the given resource.

      Returns:
      the permissions string for the given resource

    • getProjectId

      public CmsUUID getProjectId()
      Returns the id of the project which the resource belongs to.

      Returns:
      the id of the project which the resource belongs to

    • getProjectState

      public CmsResourceUtil.CmsResourceProjectState getProjectState()
      Returns the project state of the given resource.

      • null: unchanged.
      • true: locked in current project.
      • false: not locked in current project.
      Returns:
      the project state of the given resource

    • getReferenceProject

      public CmsProject getReferenceProject()
      Returns the project to use to check project state.

      Returns:
      the project to use to check project state

    • getRelativeTo

      public String getRelativeTo()
      Returns the 'relative to' path.

      This only affects the generation of the path for the current resource.

      Returns:
      the 'relative to' path

    • getResource

      public CmsResource getResource()
      Returns the resource.

      Returns:
      the resource

    • getResourceType

      public I_CmsResourceType getResourceType()
      Returns the resource type for the given resource.

      Returns:
      the resource type for the given resource

    • getResourceTypeId

      public int getResourceTypeId()
      Returns the resource type id for the given resource.

      Returns:
      the resource type id for the given resource

    • getResourceTypeName

      public String getResourceTypeName()
      Returns the resource type name for the given resource.

      Returns:
      the resource type name for the given resource

    • getSearchResult

      public CmsGallerySearchResult getSearchResult(Locale locale)
      Returns the SOLR search result for the current resource.

      Parameters:
      locale - the content locale
      Returns:
      the search result

    • getSite

      public String getSite()
      Returns the site of the current resources, taking into account the set site mode.

      Returns:
      the site path

    • getSiteMode

      public org.opencms.workplace.explorer.CmsResourceUtil.CmsResourceUtilSiteMode getSiteMode()
      Returns the site mode.

      This only affects the generation of the path for the current resource.

      Returns:
      the site mode

    • getSiteTitle

      public String getSiteTitle()
      Returns the title of the site.

      Returns:
      the title of the site

    • getSizeString

      public String getSizeString()
      Returns the size of the given resource as a String.

      For directories it returns SIZE_DIR.

      Returns:
      the size of the given resource as a String

    • getSmallIconResource

      public com.vaadin.server.Resource getSmallIconResource()
      Returns the small icon resource of the current resource.

      Returns:
      the icon resource

    • getStateAbbreviation

      public char getStateAbbreviation()
      Returns resource state abbreviation.

      Returns:
      resource state abbreviation

    • getStateName

      public String getStateName()
      Returns the state name for a resource.

      Uses default locale if request context is null.

      Returns:
      the state name for that resource

    • getStyleClassName

      public String getStyleClassName()
      Returns the style class to use for the given resource.

      Returns:
      style class name
      See Also:
      • CmsListExplorerColumn.getExplorerStyleDef()

    • getStyleSiblings

      public String getStyleSiblings()
      Returns additional style sheets for the resource type icon depending on siblings.

      That is, depending on CmsResource.getSiblingCount() Use it with the getIconPathExplorer() method.

      Returns:
      additional style sheets depending on siblings

    • getSystemLockInfo

      public String getSystemLockInfo(boolean forExplorer)
      Returns the system lock information tooltip for the explorer view.

      Parameters:
      forExplorer - if the tool tip should be generated for the explorer view
      Returns:
      the system lock information tooltip

    • getTimeWindowLayoutStyle

      public String getTimeWindowLayoutStyle()
      Returns additional style sheets depending on publication constraints.

      That is, depending on CmsResource.getDateReleased() and CmsResource.getDateExpired().

      Returns:
      additional style sheets depending on publication constraints
      See Also:

    • getTimeWindowLayoutType

      public int getTimeWindowLayoutType()
      Returns the layout style for the current time window state.

      Returns:
      the layout style for the current time window state
      See Also:

    • getTitle

      public String getTitle()
      Returns the title of a resource.

      Returns:
      the title for that resource

    • getUserCreated

      public String getUserCreated()
      Returns the name of the user who created the given resource.

      Returns:
      the name of the user who created the given resource

    • getUserLastModified

      public String getUserLastModified()
      Returns the name of the user who last modified the given resource.

      Returns:
      the name of the user who last modified the given resource

    • isEditable

      public boolean isEditable()
      Returns true if the given resource is editable by the current user.

      Returns false if no request context is set.

      Returns:
      true if the given resource is editable by the current user

    • isInsideProject

      public boolean isInsideProject()
      Returns true if the given resource is in the reference project.

      Returns false if the request context is null.

      Returns:
      true if the given resource is in the reference project
      See Also:

    • isReleasedAndNotExpired

      public boolean isReleasedAndNotExpired()
      Returns true if the stored resource has been released and has not expired.

      If no request context is available, the current time is used for the validation check.

      Returns:
      true if the stored resource has been released and has not expired
      See Also:

    • setAbbrevLength

      public void setAbbrevLength(int abbrevLength)
      Sets the path abbreviation length.

      If greater than zero, the path will be formatted to this number of chars.

      This only affects the generation of the path for the current resource.

      Parameters:
      abbrevLength - the path abbreviation length to set

    • setCms

      public void setCms(CmsObject cms)
      Sets the cms context.

      Parameters:
      cms - the cms context to set

    • setReferenceProject

      public void setReferenceProject(CmsProject project)
      Sets the project to use to check project state.

      Parameters:
      project - the project to set

    • setRelativeTo

      public void setRelativeTo(String relativeTo)
      Sets the 'relative to' path.

      This only affects the generation of the path for the current resource.

      Parameters:
      relativeTo - the 'relative to' path to set

    • setResource

      public void setResource(CmsResource resource)
      Sets the resource.

      Parameters:
      resource - the resource to set

    • setSiteMode

      public void setSiteMode(org.opencms.workplace.explorer.CmsResourceUtil.CmsResourceUtilSiteMode siteMode)
      Sets the site mode.

      This only affects the generation of the path for the current resource.

      Parameters:
      siteMode - the site mode to set