Package org.opencms.workplace.explorer

Class CmsTree

java.lang.Object
org.opencms.workplace.CmsWorkplace
org.opencms.workplace.explorer.CmsTree
public class CmsTree extends org.opencms.workplace.CmsWorkplace
Generates the tree view for the OpenCms Workplace.

The following Workplace files use this class:

  • /views/explorer/tree_fs.jsp
  • /views/explorer/tree_files.jsp

Since:
6.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PARAM_INCLUDEFILES
    Request parameter name for the includesfiles parameter.
    static final String
    PARAM_INTEGRATOR
    Request parameter name for the integrator parameter.
    static final String
    PARAM_LASTKNOWN
    Request parameter name for the lastknown parameter.
    static final String
    PARAM_PROJECTAWARE
    Request parameter name for the projectaware parameter.
    static final String
    PARAM_RESOURCE
    Request parameter name for the resource parameter.
    static final String
    PARAM_ROOTLOADED
    Request parameter name for the rootloaded parameter.
    static final String
    PARAM_SHOWSITESELECTOR
    Request parameter name for the showsiteselector parameter.
    static final String
    PARAM_TREESITE
    Request parameter name for the treesite parameter.
    static final String
    PARAM_TYPE
    Request parameter name for the type parameter.

    Fields inherited from class org.opencms.workplace.CmsWorkplace

    DEBUG, DEFAULT_DATE_STRING, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, INPUT_DEFAULT, INPUT_NONE, JSP_WORKPLACE_URI, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PARAM_WP_START, PARAM_WP_VIEW, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsTree(org.opencms.jsp.CmsJspActionElement jsp)
    Public constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getRootFolder()
    Determines the root folder of the current tree dependent on users setting of explorer view restriction.
    String
    getSiteSelector(String htmlAttributes)
    Returns the HTML for the site selector box for the explorer tree window.
    String
    getTree()
    Returns the html for the explorer tree.
    String
    getTreeType()
    Returns the type of this tree (e.g.
    boolean
    includeFiles()
    Indicates if only folders or files and folders should be included in the tree.
    String
    initTree()
    Returns the HTML for the tree initialization.
    static String
    initTree(org.opencms.file.CmsObject cms, String encoding, String skinUri)
    Returns the HTML for the tree initialization.
    protected void
    initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
     
    boolean
    isProjectAware()
    Returns the project awareness flag.
    void
    setProjectAware(boolean projectAware)
    Sets the project awareness flag.
    boolean
    showSiteSelector()
    Indicates if the site selector should be shown depending on the tree type, initial settings and the count of accessible sites.

    Methods inherited from class org.opencms.workplace.CmsWorkplace

    addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, canEditPermissionsForRoles, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, htmlStart, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, pageBody, pageHtml, pageHtmlStyle, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • CmsTree

      public CmsTree(org.opencms.jsp.CmsJspActionElement jsp)
      Public constructor.

      Parameters:
      jsp - an initialized JSP action element

  • Method Details

    • initTree

      public static String initTree(org.opencms.file.CmsObject cms, String encoding, String skinUri)
      Returns the HTML for the tree initialization.

      Parameters:
      cms - the CmsObject
      encoding - the current encoding
      skinUri - the current skin URI
      Returns:
      the HTML for the tree initialization

    • getRootFolder

      public String getRootFolder()
      Determines the root folder of the current tree dependent on users setting of explorer view restriction.

      Returns:
      the root folder resource name to display

    • getSiteSelector

      public String getSiteSelector(String htmlAttributes)
      Returns the HTML for the site selector box for the explorer tree window.

      Parameters:
      htmlAttributes - optional attributes for the <select> tag
      Returns:
      HTML code for the site selector box

    • getTree

      public String getTree()
      Returns the html for the explorer tree.

      Returns:
      the html for the explorer tree

    • getTreeType

      public String getTreeType()
      Returns the type of this tree (e.g. "copy", "project" etc.), if null this is the default explorer version.

      Returns:
      the current type of the tree (e.g. "copy", "project" etc.)

    • includeFiles

      public boolean includeFiles()
      Indicates if only folders or files and folders should be included in the tree.

      Returns:
      true if files and folders should be included in the tree

    • initTree

      public String initTree()
      Returns the HTML for the tree initialization.

      Returns:
      the HTML for the tree initialization

    • isProjectAware

      public boolean isProjectAware()
      Returns the project awareness flag.

      Returns:
      the project awareness flag

    • setProjectAware

      public void setProjectAware(boolean projectAware)
      Sets the project awareness flag.

      Parameters:
      projectAware - the project awareness flag to set

    • showSiteSelector

      public boolean showSiteSelector()
      Indicates if the site selector should be shown depending on the tree type, initial settings and the count of accessible sites.

      Returns:
      true if site selector should be shown, otherwise false

    • initWorkplaceRequestValues

      protected void initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
      Specified by:
      initWorkplaceRequestValues in class org.opencms.workplace.CmsWorkplace
      See Also:
      • CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)