org.opencms.workplace.explorer

类 CmsExplorer

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.explorer.CmsExplorer

public class CmsExplorer
extends 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

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
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.

从类继承的字段 org.opencms.workplace.CmsWorkplace

DEBUG, 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, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, 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_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_DIRECT_EDIT, VIEW_WORKPLACE

构造器概要

构造器

构造器和说明
CmsExplorer(CmsJspActionElement jsp) Public constructor.

方法概要

方法

限定符和类型	方法和说明
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(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(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.
static java.lang.String	getWorkplaceExplorerLink(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.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

从类继承的方法 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, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, htmlStart, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, pageBody, pageHtml, pageHtmlStyle, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, switchToCurrentProject, switchToTempProject

从类继承的方法 java.lang.Object

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

字段详细资料

PARAMETER_CONTEXTMENUPARAMS

public static final java.lang.String PARAMETER_CONTEXTMENUPARAMS

The 'ctxmenuparams' parameter.

另请参阅:

常量字段值

PARAMETER_MODE

public static final java.lang.String PARAMETER_MODE

The "mode" parameter.

另请参阅:

常量字段值

VIEW_EXPLORER

public static final java.lang.String VIEW_EXPLORER

The "explorerview" view selection.

另请参阅:

常量字段值

VIEW_GALLERY

public static final java.lang.String VIEW_GALLERY

The "galleryview" view selection.

另请参阅:

常量字段值

VIEW_LIST

public static final java.lang.String VIEW_LIST

The "list" view selection.

另请参阅:

常量字段值

构造器详细资料

CmsExplorer

public CmsExplorer(CmsJspActionElement jsp)

Public constructor.

参数:

jsp - an initialized JSP action element

方法详细资料

getWorkplaceExplorerLink

public static java.lang.String getWorkplaceExplorerLink(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.

参数:

jsp - needed for link functionality.

explorerRootPath - a root relative folder link (has to end with '/').

返回:

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(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.

参数:

cms - the cms object

explorerRootPath - a root relative folder link (has to end with '/').

返回:

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.

返回:

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.

返回:

the explorer files frame content uri

getFileList

public java.lang.String getFileList()

Returns the html for the explorer file list.

返回:

the html for the explorer file list

getInitializationEntry

public java.lang.String getInitializationEntry(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.

参数:

resUtil - the resource util object to generate the entry for

showPath - if the path should be given or taken from top.setDirectory

showTitle - if the title should be shown

showNavText - if the navtext should be shown

showPermissions - if the permissions should be shown

showDateLastModified - if the date of modification should be shown

showUserWhoLastModified - if the user who last modified the resource should be shown

showDateCreated - if the date of creation should be shown

showUserWhoCreated - if the user who created the resource should be shown

showDateReleased - if the date of release should be shown

showDateExpired - if the date of expiration should be shown

返回:

js code for initializing the explorer view

另请参阅:

getInitializationHeader(), getInitializationFooter(int, int)

getInitializationFooter

public java.lang.String getInitializationFooter(int numberOfPages,
                                       int selectedPage)

Generates the footer of the explorer initialization code.

参数:

numberOfPages - the number of pages

selectedPage - the selected page to display

返回:

js code for initializing the explorer view

另请参阅:

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.

返回:

js code for initializing the explorer view

另请参阅:

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.

返回:

the root folder resource name to display

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                              javax.servlet.http.HttpServletRequest request)

从类复制的说明: CmsWorkplace

Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

指定者:

initWorkplaceRequestValues 在类中 CmsWorkplace

参数:

settings - the workplace settings

request - the current request

另请参阅:

CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)