|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workplace.CmsWorkplace
org.opencms.workplace.explorer.CmsExplorer
public class CmsExplorer
Provides methods for building the main frame sets of the OpenCms Workplace.
The following files use this class:
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. |
static java.lang.String[] |
VIEWS
All views as array. |
static java.util.List |
VIEWS_LIST
All views as list. |
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. |
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. |
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PARAMETER_MODE
public static final java.lang.String VIEW_EXPLORER
public static final java.lang.String VIEW_GALLERY
public static final java.lang.String VIEW_LIST
public static final java.lang.String[] VIEWS
public static final java.util.List VIEWS_LIST
Constructor Detail |
---|
public CmsExplorer(CmsJspActionElement jsp)
jsp
- an initialized JSP action elementMethod Detail |
---|
public static java.lang.String getWorkplaceExplorerLink(CmsJspActionElement jsp, java.lang.String explorerRootPath)
jsp
- needed for link functionality.explorerRootPath
- a root relative folder link (has to end with '/').
public java.lang.String getExplorerBodyUri()
Used by the explorer_fs.jsp.
public java.lang.String getExplorerFilesUri()
Used by the explorer_body_fs.jsp.
public java.lang.String getFileList()
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)
resUtil
- the resource util object to generate the entry forshowPath
- if the path should be given or taken from top.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
getInitializationHeader()
,
getInitializationFooter(int, int)
public java.lang.String getInitializationFooter(int numberOfPages, int selectedPage)
numberOfPages
- the number of pagesselectedPage
- the selected page to display
getInitializationHeader()
,
getInitializationEntry(CmsResourceUtil, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean)
public java.lang.String getInitializationHeader()
getInitializationFooter(int, int)
,
getInitializationEntry(CmsResourceUtil, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean)
public java.lang.String getRootFolder()
protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
CmsWorkplace
initWorkplaceRequestValues
in class CmsWorkplace
settings
- the workplace settingsrequest
- the current requestCmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |