org.opencms.workplace.explorer
Class CmsExplorer

java.lang.Object
  extended byorg.opencms.workplace.CmsWorkplace
      extended byorg.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:

Since:
6.0.0
Version:
$Revision: 1.41 $
Author:
Alexander Kandzior

Field Summary
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_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, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, TEMP_FILE_PREFIX, 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
 
Constructor Summary
CmsExplorer(CmsJspActionElement jsp)
          Public constructor.
 
Method Summary
 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.
protected  void initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
          Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
 
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, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, htmlStart, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, isTemporaryFileName, key, key, keyDefault, nullToEmpty, pageBody, pageHtml, pageHtmlStyle, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, switchToCurrentProject, switchToTempProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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(CmsJspActionElement jsp)
Public constructor.

Parameters:
jsp - an initialized JSP action element
Method Detail

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(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 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
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 pages
selectedPage - 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(CmsWorkplaceSettings settings,
                                          javax.servlet.http.HttpServletRequest request)
Description copied from class: CmsWorkplace
Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

Specified by:
initWorkplaceRequestValues in class CmsWorkplace
Parameters:
settings - the workplace settings
request - the current request
See Also:
CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)