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 framesets of the OpenCms Workplace.

The following files use this class:

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

Field Summary
static int LAYOUTSTYLE_AFTEREXPIRE
          Layoutstyle for resources after expire date.
static int LAYOUTSTYLE_BEFORERELEASE
          Layoutstyle for resources before release date.
static int LAYOUTSTYLE_INRANGE
          Layoutstyle for resources after release date and before expire date.
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 getFileList()
          Returns the html for the explorer file list.
 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, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, htmlEnd, htmlStart, initMessages, initSettings, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, 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

LAYOUTSTYLE_AFTEREXPIRE

public static final int LAYOUTSTYLE_AFTEREXPIRE
Layoutstyle for resources after expire date.

See Also:
Constant Field Values

LAYOUTSTYLE_BEFORERELEASE

public static final int LAYOUTSTYLE_BEFORERELEASE
Layoutstyle for resources before release date.

See Also:
Constant Field Values

LAYOUTSTYLE_INRANGE

public static final int LAYOUTSTYLE_INRANGE
Layoutstyle for resources after release date and before expire date.

See Also:
Constant Field Values

PARAMETER_MODE

public static final java.lang.String PARAMETER_MODE
The "mode" parameter.

See Also:
Constant Field Values

VIEW_LIST

public static final java.lang.String VIEW_LIST
The "list" view selection.

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
Constructor Detail

CmsExplorer

public CmsExplorer(CmsJspActionElement jsp)
Public constructor.

Parameters:
jsp - an initialized JSP action element
Method Detail

getFileList

public java.lang.String getFileList()
Returns the html for the explorer file list.

Returns:
the html for the explorer file list

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)