org.opencms.workplace.commons

类 CmsDelete

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.tools.CmsToolDialog

org.opencms.workplace.CmsDialog

org.opencms.workplace.CmsMultiDialog

org.opencms.workplace.commons.CmsDelete

所有已实现的接口:

I_CmsConfigurationParameterHandler, I_CmsDialogHandler

public class CmsDelete
extends CmsMultiDialog
implements I_CmsDialogHandler

Provides methods for the delete resources dialog.

The following files use this class:

• /commons/delete_standard.jsp

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static int	ACTION_DELETE Value for the action: delete the resource.
static java.lang.String	DIALOG_TYPE The dialog type.
static org.apache.commons.logging.Log	LOG The log object for this class.
static java.lang.String	PARAM_DELETE_SIBLINGS Request parameter name for the deletesiblings parameter.
static java.lang.String	URI_DELETE_DIALOG The delete dialog URI.

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

DELIMITER_RESOURCES, PARAM_RESOURCELIST

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

从接口继承的字段 org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

构造器概要

构造器

构造器和说明
CmsDelete() Default constructor needed for dialog handler implementation.
CmsDelete(CmsJspActionElement jsp) Public constructor with JSP action element.
CmsDelete(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.

方法概要

方法

限定符和类型	方法和说明
void	actionDelete() Performs the delete action, will be called by the JSP page.
void	addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue) Adds a configuration parameter to this parameter configurable class instance.
java.lang.String	buildConfirmation() Returns the html for the confirmation message.
java.lang.String	buildDeleteSiblings() Returns the html for the "delete siblings" options when deleting a a resource with siblings.
java.lang.String	buildReport() Returns html code for the possible broken relations.
CmsParameterConfiguration	getConfiguration() Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
java.lang.String	getDialogHandler() Returns the name of the handler which is used as key for the OpenCms runtime properties.
java.lang.String	getDialogUri(java.lang.String resource, CmsJspActionElement jsp) Returns the dialog URI in the OpenCms VFS to the dialog selector class.
java.lang.String	getParamDeleteSiblings() Returns the value of the boolean option to delete siblings.
void	initConfiguration() Initializes a configuration after all parameters have been added.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
boolean	isCanDelete() Returns true if the current user is allowed to delete the selected resources.
protected boolean	performDialogOperation() Performs the resource deletion.
protected void	performSingleDeleteOperation(java.lang.String resource, CmsResourceDeleteMode deleteOption) Performs the delete operation for a single VFS resource.
void	setParamDeleteSiblings(java.lang.String value) Sets the value of the boolean option to delete siblings.

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

addMultiOperationException, buildLockHeaderBox, buildResourceList, checkMultiOperationException, checkResourcePermissions, getParamResourcelist, getResourceList, getResourceListAsParam, isMultiOperation, isOperationOnFolder, setDialogTitle, setParamResource, setParamResourcelist

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

actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, 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, 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_DELETE

public static final int ACTION_DELETE

Value for the action: delete the resource.

另请参阅:

常量字段值

DIALOG_TYPE

public static final java.lang.String DIALOG_TYPE

The dialog type.

另请参阅:

常量字段值

LOG

public static final org.apache.commons.logging.Log LOG

The log object for this class.

PARAM_DELETE_SIBLINGS

public static final java.lang.String PARAM_DELETE_SIBLINGS

Request parameter name for the deletesiblings parameter.

另请参阅:

常量字段值

URI_DELETE_DIALOG

public static final java.lang.String URI_DELETE_DIALOG

The delete dialog URI.

另请参阅:

常量字段值

构造器详细资料

CmsDelete

public CmsDelete()

Default constructor needed for dialog handler implementation.

CmsDelete

public CmsDelete(CmsJspActionElement jsp)

Public constructor with JSP action element.

参数:

jsp - an initialized JSP action element

CmsDelete

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

方法详细资料

actionDelete

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

Performs the delete action, will be called by the JSP page.

抛出:

javax.servlet.jsp.JspException - if problems including sub-elements occur

addConfigurationParameter

public void addConfigurationParameter(java.lang.String paramName,
                             java.lang.String paramValue)

从接口复制的说明: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

指定者:

addConfigurationParameter 在接口中 I_CmsConfigurationParameterHandler

参数:

paramName - the name of the parameter

paramValue - the value for the parameter

另请参阅:

I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

buildConfirmation

public java.lang.String buildConfirmation()

Returns the html for the confirmation message.

返回:

the html for the confirmation message

buildDeleteSiblings

public java.lang.String buildDeleteSiblings()

Returns the html for the "delete siblings" options when deleting a a resource with siblings.

返回:

the html for the "delete siblings" options

buildReport

public java.lang.String buildReport()
                             throws javax.servlet.jsp.JspException,
                                    javax.servlet.ServletException,
                                    java.io.IOException

Returns html code for the possible broken relations.

返回:

html code for the possible broken relations

抛出:

javax.servlet.jsp.JspException - if dialog actions fail

java.io.IOException - in case of errros forwarding to the required result page

javax.servlet.ServletException - in case of errros forwarding to the required result page

getConfiguration

public CmsParameterConfiguration getConfiguration()

从接口复制的说明: I_CmsConfigurationParameterHandler

Returns the parameters of this configurable class instance, or null if the class does not need any parameters.

指定者:

getConfiguration 在接口中 I_CmsConfigurationParameterHandler

返回:

the parameters of this configurable class instance, or null if the class does not need any parameters

另请参阅:

I_CmsConfigurationParameterHandler.getConfiguration()

getDialogHandler

public java.lang.String getDialogHandler()

从接口复制的说明: I_CmsDialogHandler

Returns the name of the handler which is used as key for the OpenCms runtime properties.

Store the name of the key as a public String constant in the CmsDialogSelector class.

指定者:

getDialogHandler 在接口中 I_CmsDialogHandler

返回:

the name of the dialog handler

另请参阅:

I_CmsDialogHandler.getDialogHandler()

getDialogUri

public java.lang.String getDialogUri(java.lang.String resource,
                            CmsJspActionElement jsp)

从接口复制的说明: I_CmsDialogHandler

Returns the dialog URI in the OpenCms VFS to the dialog selector class.

指定者:

getDialogUri 在接口中 I_CmsDialogHandler

参数:

resource - the selected resource

jsp - the CmsJspActionElement

返回:

the absolute path to the property dialog

另请参阅:

I_CmsDialogHandler.getDialogUri(java.lang.String, CmsJspActionElement)

getParamDeleteSiblings

public java.lang.String getParamDeleteSiblings()

Returns the value of the boolean option to delete siblings.

返回:

the value of the boolean option to delete siblings as a lower case string

initConfiguration

public void initConfiguration()

从接口复制的说明: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

指定者:

initConfiguration 在接口中 I_CmsConfigurationParameterHandler

另请参阅:

I_CmsConfigurationParameterHandler.initConfiguration()

isCanDelete

public boolean isCanDelete()

Returns true if the current user is allowed to delete the selected resources.

返回:

true if the current user is allowed to delete the selected resources

setParamDeleteSiblings

public void setParamDeleteSiblings(java.lang.String value)

Sets the value of the boolean option to delete siblings.

参数:

value - the value of the boolean option to delete siblings

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)

performDialogOperation

protected boolean performDialogOperation()
                                  throws CmsException

Performs the resource deletion.

指定者:

performDialogOperation 在类中 CmsMultiDialog

返回:

true, if the resource(s) was/were deleted, otherwise false

抛出:

CmsException - if deletion is not successful

performSingleDeleteOperation

protected void performSingleDeleteOperation(java.lang.String resource,
                                CmsResourceDeleteMode deleteOption)
                                     throws CmsException

Performs the delete operation for a single VFS resource.

参数:

resource - the resource VFS path

deleteOption - the delete option for sibling deletion

抛出:

CmsException - if deleting the resource fails