org.opencms.workplace.administration

类 CmsAdminMenu

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.tools.CmsToolDialog

org.opencms.workplace.administration.CmsAdminMenu

public class CmsAdminMenu
extends CmsToolDialog

Implementation of the administration view leftside's menu.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DEFAULT_TARGET Default link target constant.

从类继承的字段 org.opencms.workplace.tools.CmsToolDialog

PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

从类继承的字段 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

构造器概要

构造器

构造器和说明
CmsAdminMenu(CmsJspActionElement jsp) Default Constructor.

方法概要

方法

限定符和类型	方法和说明
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.
CmsToolManager	getToolManager() Returns the admin manager.
java.lang.String	groupHtml(CmsWorkplace wp) Generates the necesary html code for the groups.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
void	installMenu() Creates the default menu as the root tool structure.

从类继承的方法 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

从类继承的方法 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, pageHtml, 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

字段详细资料

DEFAULT_TARGET

public static final java.lang.String DEFAULT_TARGET

Default link target constant.

另请参阅:

常量字段值

构造器详细资料

CmsAdminMenu

public CmsAdminMenu(CmsJspActionElement jsp)

Default Constructor.

参数:

jsp - the jsp context

方法详细资料

addGroup

public void addGroup(CmsAdminMenuGroup group)

Adds a group.

参数:

group - the group

另请参阅:

CmsIdentifiableObjectContainer.addIdentifiableObject(String, Object)

addGroup

public void addGroup(CmsAdminMenuGroup group,
            float position)

Adds a menu item at the given position.

参数:

group - the group

position - the position

另请参阅:

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.

参数:

groupName - the name of the group

name - the name of the item

icon - the icon to display

link - the link to open when selected

helpText - the help text to display

enabled - if enabled or not

position - the relative position to install the item

target - the target frame to open the link into

返回:

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.

参数:

excludes - the parameters to exclude

返回:

all initialized parameters of the current request

getGroup

public CmsAdminMenuGroup getGroup(java.lang.String name)

Returns the requested group.

参数:

name - the name of the group

返回:

the group

另请参阅:

CmsIdentifiableObjectContainer.getObject(String)

getToolManager

public CmsToolManager getToolManager()

Returns the admin manager.

覆盖:

getToolManager 在类中 CmsToolDialog

返回:

the admin manager

groupHtml

public java.lang.String groupHtml(CmsWorkplace wp)

Generates the necesary html code for the groups.

参数:

wp - the page for which the code is generated

返回:

html code

installMenu

public void installMenu()

Creates the default menu as the root tool structure.

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 在类中 CmsToolDialog

参数:

settings - the workplace settings

request - the current request

另请参阅:

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