Package org.opencms.workplace.explorer
Class CmsExplorer
- java.lang.Object
-
- org.opencms.workplace.CmsWorkplace
-
- org.opencms.workplace.explorer.CmsExplorer
-
public class CmsExplorer extends org.opencms.workplace.CmsWorkplace
Provides methods for building the main frame sets of the OpenCms Workplace.The following files use this class:
- /views/explorer/explorer_fs.jsp
- /views/explorer/explorer_files.jsp
- /views/explorer/explorer_body_fs.jsp
- Since:
- 6.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PARAMETER_CONTEXTMENUPARAMS
The 'ctxmenuparams' parameter.static java.lang.String
PARAMETER_MODE
The "mode" parameter.static java.lang.String
VIEW_EXPLORER
The "explorerview" view selection.static java.lang.String
VIEW_GALLERY
The "galleryview" view selection.static java.lang.String
VIEW_LIST
The "list" view selection.-
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_WORKPLACE
-
-
Constructor Summary
Constructors Constructor Description CmsExplorer(org.opencms.jsp.CmsJspActionElement jsp)
Public constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getExplorerBodyUri()
Returns the explorer body frame content uri.java.lang.String
getExplorerFilesUri()
Returns the explorer files frame content uri.java.lang.String
getFileList()
Returns the html for the explorer file list.java.lang.String
getInitializationEntry(org.opencms.workplace.explorer.CmsResourceUtil resUtil, boolean showPath, boolean showTitle, boolean showNavText, boolean showPermissions, boolean showDateLastModified, boolean showUserWhoLastModified, boolean showDateCreated, boolean showUserWhoCreated, boolean showDateReleased, boolean showDateExpired)
Generates a resource entry for the explorer initialization code.java.lang.String
getInitializationFooter(int numberOfPages, int selectedPage)
Generates the footer of the explorer initialization code.java.lang.String
getInitializationHeader()
Generates the header of the initialization code.java.lang.String
getRootFolder()
Determines the root folder of the current tree dependent on users setting of explorer view restriction.static java.lang.String
getWorkplaceExplorerLink(org.opencms.file.CmsObject cms, java.lang.String explorerRootPath)
Creates a link for the OpenCms workplace that will reload the whole workplace, switch to the explorer view, the site of the given explorerRootPath and show the folder given in the explorerRootPath.static java.lang.String
getWorkplaceExplorerLink(org.opencms.jsp.CmsJspActionElement jsp, java.lang.String explorerRootPath)
Creates a link for the OpenCms workplace that will reload the whole workplace, switch to the explorer view, the site of the given explorerRootPath and show the folder given in the explorerRootPath.protected void
initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
-
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, 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
-
-
-
-
Field Detail
-
PARAMETER_CONTEXTMENUPARAMS
public static final java.lang.String PARAMETER_CONTEXTMENUPARAMS
The 'ctxmenuparams' parameter.- See Also:
- Constant Field Values
-
PARAMETER_MODE
public static final java.lang.String PARAMETER_MODE
The "mode" parameter.- See Also:
- Constant Field Values
-
VIEW_EXPLORER
public static final java.lang.String VIEW_EXPLORER
The "explorerview" view selection.- See Also:
- Constant Field Values
-
VIEW_GALLERY
public static final java.lang.String VIEW_GALLERY
The "galleryview" view selection.- See Also:
- Constant Field Values
-
VIEW_LIST
public static final java.lang.String VIEW_LIST
The "list" view selection.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsExplorer
public CmsExplorer(org.opencms.jsp.CmsJspActionElement jsp)
Public constructor.- Parameters:
jsp
- an initialized JSP action element
-
-
Method Detail
-
getWorkplaceExplorerLink
public static java.lang.String getWorkplaceExplorerLink(org.opencms.jsp.CmsJspActionElement jsp, java.lang.String explorerRootPath)
Creates a link for the OpenCms workplace that will reload the whole workplace, switch to the explorer view, the site of the given explorerRootPath and show the folder given in the explorerRootPath.- Parameters:
jsp
- needed for link functionality.explorerRootPath
- a root relative folder link (has to end with '/').- Returns:
- a link for the OpenCms workplace that will reload the whole workplace, switch to the explorer view, the site of the given explorerRootPath and show the folder given in the explorerRootPath.
-
getWorkplaceExplorerLink
public static java.lang.String getWorkplaceExplorerLink(org.opencms.file.CmsObject cms, java.lang.String explorerRootPath)
Creates a link for the OpenCms workplace that will reload the whole workplace, switch to the explorer view, the site of the given explorerRootPath and show the folder given in the explorerRootPath.- Parameters:
cms
- the cms objectexplorerRootPath
- a root relative folder link (has to end with '/').- Returns:
- a link for the OpenCms workplace that will reload the whole workplace, switch to the explorer view, the site of the given explorerRootPath and show the folder given in the explorerRootPath.
-
getExplorerBodyUri
public java.lang.String getExplorerBodyUri()
Returns the explorer body frame content uri.Used by the explorer_fs.jsp.
- Returns:
- the explorer body frame content uri
-
getExplorerFilesUri
public java.lang.String getExplorerFilesUri()
Returns the explorer files frame content uri.Used by the explorer_body_fs.jsp.
- Returns:
- the explorer files frame content uri
-
getFileList
public java.lang.String getFileList()
Returns the html for the explorer file list.- Returns:
- the html for the explorer file list
-
getInitializationEntry
public java.lang.String getInitializationEntry(org.opencms.workplace.explorer.CmsResourceUtil resUtil, boolean showPath, boolean showTitle, boolean showNavText, boolean showPermissions, boolean showDateLastModified, boolean showUserWhoLastModified, boolean showDateCreated, boolean showUserWhoCreated, boolean showDateReleased, boolean showDateExpired)
Generates a resource entry for the explorer initialization code.- Parameters:
resUtil
- the resource util object to generate the entry forshowPath
- if the path should be given or taken fromtop.setDirectory
showTitle
- if the title should be shownshowNavText
- if the navtext should be shownshowPermissions
- if the permissions should be shownshowDateLastModified
- if the date of modification should be shownshowUserWhoLastModified
- if the user who last modified the resource should be shownshowDateCreated
- if the date of creation should be shownshowUserWhoCreated
- if the user who created the resource should be shownshowDateReleased
- if the date of release should be shownshowDateExpired
- if the date of expiration should be shown- Returns:
- js code for initializing the explorer view
- See Also:
getInitializationHeader()
,getInitializationFooter(int, int)
-
getInitializationFooter
public java.lang.String getInitializationFooter(int numberOfPages, int selectedPage)
Generates the footer of the explorer initialization code.- Parameters:
numberOfPages
- the number of pagesselectedPage
- the selected page to display- Returns:
- js code for initializing the explorer view
- See Also:
getInitializationHeader()
,getInitializationEntry(CmsResourceUtil, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean)
-
getInitializationHeader
public java.lang.String getInitializationHeader()
Generates the header of the initialization code.- Returns:
- js code for initializing the explorer view
- See Also:
getInitializationFooter(int, int)
,getInitializationEntry(CmsResourceUtil, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean)
-
getRootFolder
public java.lang.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
-
initWorkplaceRequestValues
protected void initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
- Specified by:
initWorkplaceRequestValues
in classorg.opencms.workplace.CmsWorkplace
- See Also:
CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
-
-