Class CmsAdminMenu
- java.lang.Object
-
- org.opencms.workplace.CmsWorkplace
-
- org.opencms.workplace.tools.CmsToolDialog
-
- org.opencms.workplace.administration.CmsAdminMenu
-
public class CmsAdminMenu extends org.opencms.workplace.tools.CmsToolDialog
Implementation of the administration view leftside's menu.- Since:
- 6.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DEFAULT_TARGET
Default link target constant.-
Fields inherited from class org.opencms.workplace.tools.CmsToolDialog
PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW
-
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_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE
-
-
Constructor Summary
Constructors Constructor Description CmsAdminMenu(org.opencms.jsp.CmsJspActionElement jsp)
Default Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addGroup(CmsAdminMenuGroup group)
Adds a group.void
addGroup(CmsAdminMenuGroup group, float position)
Adds a menu item at the given position.CmsAdminMenuItem
addItem(java.lang.String groupName, java.lang.String name, java.lang.String icon, java.lang.String link, java.lang.String helpText, boolean enabled, float position, java.lang.String target)
Adds a new item to the specified menu.java.lang.String
allRequestParamsAsUrl(java.util.Collection<java.lang.String> excludes)
Returns all initialized parameters of the current request that are not in the given exclusion list as hidden field tags that can be inserted in a form.CmsAdminMenuGroup
getGroup(java.lang.String name)
Returns the requested group.org.opencms.workplace.tools.CmsToolManager
getToolManager()
Returns the admin manager.java.lang.String
groupHtml(org.opencms.workplace.CmsWorkplace wp)
Generates the necesary html code for the groups.protected void
initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
void
installMenu()
Creates the default menu as the root tool structure.-
Methods inherited from class org.opencms.workplace.tools.CmsToolDialog
computeUpLevelLink, dialogScriptSubmit, dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyle
-
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, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, htmlStart, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, pageHtml, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences
-
-
-
-
Field Detail
-
DEFAULT_TARGET
public static final java.lang.String DEFAULT_TARGET
Default link target constant.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsAdminMenu
public CmsAdminMenu(org.opencms.jsp.CmsJspActionElement jsp)
Default Constructor.- Parameters:
jsp
- the jsp context
-
-
Method Detail
-
addGroup
public void addGroup(CmsAdminMenuGroup group)
Adds a group.- Parameters:
group
- the group- See Also:
CmsIdentifiableObjectContainer.addIdentifiableObject(String, Object)
-
addGroup
public void addGroup(CmsAdminMenuGroup group, float position)
Adds a menu item at the given position.- Parameters:
group
- the groupposition
- the position- See Also:
CmsIdentifiableObjectContainer.addIdentifiableObject(String, Object, float)
-
addItem
public CmsAdminMenuItem addItem(java.lang.String groupName, java.lang.String name, java.lang.String icon, java.lang.String link, java.lang.String helpText, boolean enabled, float position, java.lang.String target)
Adds a new item to the specified menu.If the menu does not exist, it will be created.
- Parameters:
groupName
- the name of the groupname
- the name of the itemicon
- the icon to displaylink
- the link to open when selectedhelpText
- the help text to displayenabled
- if enabled or notposition
- the relative position to install the itemtarget
- the target frame to open the link into- Returns:
- the new item
-
allRequestParamsAsUrl
public java.lang.String allRequestParamsAsUrl(java.util.Collection<java.lang.String> excludes)
Returns all initialized parameters of the current request that are not in the given exclusion list as hidden field tags that can be inserted in a form.- Parameters:
excludes
- the parameters to exclude- Returns:
- all initialized parameters of the current request
-
getGroup
public CmsAdminMenuGroup getGroup(java.lang.String name)
Returns the requested group.- Parameters:
name
- the name of the group- Returns:
- the group
- See Also:
CmsIdentifiableObjectContainer.getObject(String)
-
getToolManager
public org.opencms.workplace.tools.CmsToolManager getToolManager()
Returns the admin manager.- Overrides:
getToolManager
in classorg.opencms.workplace.tools.CmsToolDialog
- Returns:
- the admin manager
-
groupHtml
public java.lang.String groupHtml(org.opencms.workplace.CmsWorkplace wp)
Generates the necesary html code for the groups.- Parameters:
wp
- the page for which the code is generated- Returns:
- html code
-
installMenu
public void installMenu()
Creates the default menu as the root tool structure.
-
initWorkplaceRequestValues
protected void initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
- Overrides:
initWorkplaceRequestValues
in classorg.opencms.workplace.tools.CmsToolDialog
- See Also:
CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
-
-