org.opencms.workplace.commons
Class CmsDeletedResources

java.lang.Object
  org.opencms.workplace.CmsWorkplace
      org.opencms.workplace.tools.CmsToolDialog
          org.opencms.workplace.CmsDialog
              org.opencms.workplace.commons.CmsDeletedResources

public class CmsDeletedResources
extends CmsDialog

Creates the dialogs for showing and restoring deleted resources.

The following files use this class:

• /commons/show-deleted.jsp

Since:

6.9.1

Field Summary

static java.lang.String

PARAM_READTREE Request parameter name for the relatedresources parameter.

Fields inherited from class 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

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_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

Constructor Summary

CmsDeletedResources(CmsJspActionElement jsp)
Public constructor with JSP action element.

CmsDeletedResources(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables.

Method Summary

java.lang.String	buildIncludeJs() Returns the html code to include the needed js code.
java.lang.String	buildOptions() Override to display additional options in the dialog.
java.lang.String	buildReport() Builds the html code for the report with the list of deleted resources.
java.lang.String	buildReportRequest() Builds the java script code to build the report.
java.lang.String	dialogButtons() Builds the necessary button row.
void	executeListMultiActions() Executes the actions from the deleted resources list.
java.lang.String	getParamListAction() Returns the paramListAction.
java.lang.String	getParamReadtree() Returns the paramReadtree.
java.lang.String	getParamSelItems() Returns the paramSelItems.
java.util.List	getSelectedItems() Returns a list of resource ids of the current selected items.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
java.lang.String	paramsAsHidden() Returns all initialized parameters of the current workplace class as hidden field tags that can be inserted in a form.
void	setParamListAction(java.lang.String paramListAction) Sets the paramListAction.
void	setParamReadtree(java.lang.String paramReadtree) Sets the paramReadtree.
void	setParamSelItems(java.lang.String paramSelItems) Sets the paramSelItems.

Methods inherited from class org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, autoTimeWarp, 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

Methods inherited from class 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

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, 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, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, switchToCurrentProject, switchToTempProject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARAM_READTREE

public static final java.lang.String PARAM_READTREE

Request parameter name for the relatedresources parameter.

See Also:

Constant Field Values

Constructor Detail

CmsDeletedResources

public CmsDeletedResources(CmsJspActionElement jsp)

Public constructor with JSP action element.

Parameters:

jsp - an initialized JSP action element

CmsDeletedResources

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

Public constructor with JSP variables.

Parameters:

context - the JSP page context

req - the JSP request

res - the JSP response

Method Detail

buildIncludeJs

public java.lang.String buildIncludeJs()

Returns the html code to include the needed js code.

Returns:

html code

buildOptions

public java.lang.String buildOptions()

Override to display additional options in the dialog.

Returns:

html code to display additional options

buildReport

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

Builds the html code for the report with the list of deleted resources.

Returns:

html code for the report with the list of deleted resources

Throws:

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

buildReportRequest

public java.lang.String buildReportRequest()

Builds the java script code to build the report.

Returns:

html code with the java script to use ajax to create the report

dialogButtons

public java.lang.String dialogButtons()

Builds the necessary button row.

Returns:

the button row

executeListMultiActions

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

Executes the actions from the deleted resources list.

Throws:

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

See Also:

A_CmsListDialog.executeListMultiActions()

getParamListAction

public java.lang.String getParamListAction()

Returns the paramListAction.

Returns:

the paramListAction

getParamReadtree

public java.lang.String getParamReadtree()

Returns the paramReadtree.

Returns:

the paramReadtree

getParamSelItems

public java.lang.String getParamSelItems()

Returns the paramSelItems.

Returns:

the paramSelItems

getSelectedItems

public java.util.List getSelectedItems()

Returns a list of resource ids of the current selected items.

Returns:

a list of resource ids of the current selected items

paramsAsHidden

public java.lang.String paramsAsHidden()

Description copied from class: CmsWorkplace

Returns all initialized parameters of the current workplace class as hidden field tags that can be inserted in a form.

Overrides:

paramsAsHidden in class CmsWorkplace

Returns:

all initialized parameters of the current workplace class as hidden field tags that can be inserted in a html form

See Also:

CmsWorkplace.paramsAsHidden()

setParamListAction

public void setParamListAction(java.lang.String paramListAction)

Sets the paramListAction.

Parameters:

paramListAction - the paramListAction to set

setParamReadtree

public void setParamReadtree(java.lang.String paramReadtree)

Sets the paramReadtree.

Parameters:

paramReadtree - the paramReadtree to set

setParamSelItems

public void setParamSelItems(java.lang.String paramSelItems)

Sets the paramSelItems.

Parameters:

paramSelItems - the paramSelItems to set

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                                          javax.servlet.http.HttpServletRequest request)

Description copied from class: CmsWorkplace

Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

Overrides:

initWorkplaceRequestValues in class CmsDialog

Parameters:

settings - the workplace settings

request - the current request

See Also:

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