org.opencms.workplace.editors

类 CmsDialogElements

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.tools.CmsToolDialog

org.opencms.workplace.CmsDialog

org.opencms.workplace.editors.CmsDialogElements

public class CmsDialogElements
extends CmsDialog

Provides methods for the editor elements dialog.

The following files use this class:

• /jsp/editors/dialogs/elements.html

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static int	ACTION_UPDATE_ELEMENTS Value for the action: update the elements of the page.
static java.lang.String	DIALOG_TYPE The dialog type.
static java.lang.String	DIALOG_UPDATE_ELEMENTS Request parameter value for the action: update the elements of the page.
static java.lang.String	PREFIX_PARAM_BODY Prefix for the html input field for the body.

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

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
void	actionUpdateElements() Updates the enabled/diabled status of all elements of the current page.
java.lang.String	buildElementList() Builds the html String for a form list of all possible page elements.
java.util.List<CmsDialogElement>	computeElements() Creates a list of possible elements of a template from the template property "template-elements".
static java.util.List<CmsDialogElement>	computeElements(CmsObject cms, CmsXmlPage xmlPage, java.lang.String xmlPageUri, java.util.Locale locale) Creates a list of possible elements of a template from the template property "template-elements" and the elements available in the provided xmlPage.
static java.util.List<CmsDialogElement>	computeElements(CmsObject cms, java.lang.String xmlPageUri, java.util.Locale locale) Creates a list of possible elements of a template from the template property "template-elements" and the elements available in the provided resource file.
java.lang.String	getChangeElement() Returns the element name that has to be changed.
java.util.Locale	getElementLocale() Returns the current element locale.
java.lang.String	getParamElementlanguage() Returns the current element language.
java.lang.String	getParamElementname() Returns the current element name.
java.lang.String	getParamTempfile() Returns the name of the temporary file.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
void	setParamElementlanguage(java.lang.String elementLanguage) Sets the current element language.
void	setParamElementname(java.lang.String elementName) Sets the current element name.
void	setParamTempfile(java.lang.String fileName) Sets the name of the temporary file.

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

public static final int ACTION_UPDATE_ELEMENTS

Value for the action: update the elements of the page.

另请参阅:

常量字段值

DIALOG_TYPE

public static final java.lang.String DIALOG_TYPE

The dialog type.

另请参阅:

常量字段值

DIALOG_UPDATE_ELEMENTS

public static final java.lang.String DIALOG_UPDATE_ELEMENTS

Request parameter value for the action: update the elements of the page.

另请参阅:

常量字段值

PREFIX_PARAM_BODY

public static final java.lang.String PREFIX_PARAM_BODY

Prefix for the html input field for the body.

另请参阅:

常量字段值

构造器详细资料

CmsDialogElements

public CmsDialogElements(CmsJspActionElement jsp)

Public constructor.

参数:

jsp - an initialized JSP action element

CmsDialogElements

public CmsDialogElements(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

方法详细资料

computeElements

public static java.util.List<CmsDialogElement> computeElements(CmsObject cms,
                                               CmsXmlPage xmlPage,
                                               java.lang.String xmlPageUri,
                                               java.util.Locale locale)

Creates a list of possible elements of a template from the template property "template-elements" and the elements available in the provided xmlPage.

参数:

cms - the CmsObject

xmlPage - the resource to read the elements from

xmlPageUri - the URI of the resource to read the template property from

locale - the current element locale

返回:

the list of elements in a String array with element name, nice name (if present) and mandatory flag

computeElements

public static java.util.List<CmsDialogElement> computeElements(CmsObject cms,
                                               java.lang.String xmlPageUri,
                                               java.util.Locale locale)

Creates a list of possible elements of a template from the template property "template-elements" and the elements available in the provided resource file.

参数:

cms - the CmsObject

xmlPageUri - the resource to read the elements from

locale - the current element locale

返回:

the list of elements in a String array with element name, nice name (if present) and mandatory flag

actionUpdateElements

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

Updates the enabled/diabled status of all elements of the current page.

抛出:

javax.servlet.jsp.JspException - if there is an error including the error page

buildElementList

public java.lang.String buildElementList()

Builds the html String for a form list of all possible page elements.

返回:

the html String for a form list

computeElements

public java.util.List<CmsDialogElement> computeElements()

Creates a list of possible elements of a template from the template property "template-elements".

返回:

the list of elements in a String array with element name, nice name (if present) and mandatory flag

getChangeElement

public java.lang.String getChangeElement()

Returns the element name that has to be changed.

返回:

the element name that has to be changed

getElementLocale

public java.util.Locale getElementLocale()

Returns the current element locale.

返回:

the current element locale

getParamElementlanguage

public java.lang.String getParamElementlanguage()

Returns the current element language.

返回:

the current element language

getParamElementname

public java.lang.String getParamElementname()

Returns the current element name.

返回:

the current element name

getParamTempfile

public java.lang.String getParamTempfile()

Returns the name of the temporary file.

返回:

the name of the temporary file

setParamElementlanguage

public void setParamElementlanguage(java.lang.String elementLanguage)

Sets the current element language.

参数:

elementLanguage - the current element language

setParamElementname

public void setParamElementname(java.lang.String elementName)

Sets the current element name.

参数:

elementName - the current element name

setParamTempfile

public void setParamTempfile(java.lang.String fileName)

Sets the name of the temporary file.

参数:

fileName - the name of the temporary file

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)