org.opencms.workplace.commons

类 CmsChnav

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.tools.CmsToolDialog

org.opencms.workplace.CmsDialog

org.opencms.workplace.commons.CmsChnav

public class CmsChnav
extends CmsDialog

Provides methods for the change navigation dialog.

The following files use this class:

• /commons/chnav.jsp

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static int	ACTION_CHNAV Value for the action: change the navigation.
static java.lang.String	DIALOG_TYPE The dialog type.
static java.lang.String	PARAM_NAVPOS Request parameter name for the navigation position.
static java.lang.String	PARAM_NAVTEXT Request parameter name for the navigation text.

从类继承的字段 org.opencms.workplace.CmsDialog

ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_LOCKS_CONFIRMED, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_ORIGINALPARAMS, PARAM_PREACTIONDONE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

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

构造器概要

构造器

构造器和说明
CmsChnav(CmsJspActionElement jsp) Public constructor.
CmsChnav(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.

方法概要

方法

限定符和类型	方法和说明
void	actionChangeNav() Performs the navigation change.
java.lang.String	buildNavPosSelector() Builds the HTML for the select box of the navigation position.
static java.lang.String	buildNavPosSelector(CmsObject cms, java.lang.String filename, java.lang.String attributes, CmsMessages messages) Builds the HTML for the select box of the navigation position.
java.lang.String	getCurrentNavText() Returns the escaped NavText property value of the current resource.
java.lang.String	getParamNavpos() Returns the value of the navigation position parameter, or null if this parameter was not provided.
java.lang.String	getParamNavtext() Returns the value of the navigation text parameter, or null if this parameter was not provided.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
void	setParamNavpos(java.lang.String value) Sets the value of the navigation position parameter.
void	setParamNavtext(java.lang.String value) Sets the value of the navigation text parameter.

从类继承的方法 org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

从类继承的方法 org.opencms.workplace.tools.CmsToolDialog

computeUpLevelLink, dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, 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, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, 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

字段详细资料

ACTION_CHNAV

public static final int ACTION_CHNAV

Value for the action: change the navigation.

另请参阅:

常量字段值

DIALOG_TYPE

public static final java.lang.String DIALOG_TYPE

The dialog type.

另请参阅:

常量字段值

PARAM_NAVPOS

public static final java.lang.String PARAM_NAVPOS

Request parameter name for the navigation position.

另请参阅:

常量字段值

PARAM_NAVTEXT

public static final java.lang.String PARAM_NAVTEXT

Request parameter name for the navigation text.

另请参阅:

常量字段值

构造器详细资料

CmsChnav

public CmsChnav(CmsJspActionElement jsp)

Public constructor.

参数:

jsp - an initialized JSP action element

CmsChnav

public CmsChnav(javax.servlet.jsp.PageContext context,
        javax.servlet.http.HttpServletRequest req,
        javax.servlet.http.HttpServletResponse res)

Public constructor with JSP variables.

参数:

context - the JSP page context

req - the JSP request

res - the JSP response

方法详细资料

buildNavPosSelector

public static java.lang.String buildNavPosSelector(CmsObject cms,
                                   java.lang.String filename,
                                   java.lang.String attributes,
                                   CmsMessages messages)

Builds the HTML for the select box of the navigation position.

参数:

cms - the CmsObject

filename - the current file

attributes - optional attributes for the <select> tag, do not add the "name" atribute!

messages - the localized workplace messages

返回:

the HTML for a navigation position select box

actionChangeNav

public void actionChangeNav()
                     throws javax.servlet.jsp.JspException

Performs the navigation change.

抛出:

javax.servlet.jsp.JspException - if including a JSP subelement is not successful

buildNavPosSelector

public java.lang.String buildNavPosSelector()

Builds the HTML for the select box of the navigation position.

返回:

the HTML for a navigation position select box

getCurrentNavText

public java.lang.String getCurrentNavText()

Returns the escaped NavText property value of the current resource.

返回:

the NavText property value of the current resource

getParamNavpos

public java.lang.String getParamNavpos()

Returns the value of the navigation position parameter, or null if this parameter was not provided.

The navigation position parameter defines the new value for the NavPos property.

返回:

the value of the target parameter

getParamNavtext

public java.lang.String getParamNavtext()

Returns the value of the navigation text parameter, or null if this parameter was not provided.

The navigation text parameter defines the new value for the NavText property.

返回:

the value of the target parameter

setParamNavpos

public void setParamNavpos(java.lang.String value)

Sets the value of the navigation position parameter.

参数:

value - the value to set

setParamNavtext

public void setParamNavtext(java.lang.String value)

Sets the value of the navigation text parameter.

参数:

value - the value to set

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

参数:

settings - the workplace settings

request - the current request

另请参阅:

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