Class CmsElementRename
- java.lang.Object
-
- org.opencms.workplace.CmsWorkplace
-
- org.opencms.workplace.tools.CmsToolDialog
-
- org.opencms.workplace.CmsDialog
-
- org.opencms.workplace.CmsMultiDialog
-
- org.opencms.workplace.CmsReport
-
- org.opencms.workplace.tools.content.CmsElementRename
-
public class CmsElementRename extends CmsReport
Provides methods for the change page element name dialog.- Since:
- 6.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ALL
A constant representing the select option all templates.static java.lang.String
DIALOG_TYPE
The dialog type.static java.lang.String
PARAM_LOCALE
Request parameter name for the locale.static java.lang.String
PARAM_NEW_ELEMENT
Request parameter name for the new element name.static java.lang.String
PARAM_OLD_ELEMENT
Request parameter name for the old element name.static java.lang.String
PARAM_RECURSIVE
Request parameter name for the recursive search.static java.lang.String
PARAM_REMOVE_EMPTYELEMENTS
Request parameter name for the remove empty elements.static java.lang.String
PARAM_TEMPLATE
Request parameter name for the template.static java.lang.String
PARAM_VALIDATE_NEW_ELEMENT
Request parameter name for the validate new element.-
Fields inherited from class org.opencms.workplace.CmsReport
PARAM_REPORT_CONTINUEKEY, PARAM_REPORT_TYPE, REPORT_UPDATE_SIZE, REPORT_UPDATE_TIME
-
Fields inherited from class org.opencms.workplace.CmsMultiDialog
DELIMITER_RESOURCES
-
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_ACTION_VALUE_FOR_CHANGED_INDEX, 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_DATE_STRING, 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, INPUT_DEFAULT, INPUT_NONE, JSP_WORKPLACE_URI, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PARAM_WP_START, PARAM_WP_VIEW, 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_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE
-
-
Constructor Summary
Constructors Constructor Description CmsElementRename(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables.CmsElementRename(org.opencms.jsp.CmsJspActionElement jsp)
Public constructor with JSP action element.CmsElementRename(org.opencms.jsp.CmsJspActionElement jsp, org.opencms.file.CmsObject cms, java.lang.String resource, java.lang.String recursive, java.lang.String template, java.lang.String locale, java.lang.String oldElement, java.lang.String newElement, java.lang.String removeEmptyElements, java.lang.String validateNewElement)
Public constructor for testcase using.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
actionRename(org.opencms.report.I_CmsReport report)
Renames the element name on the specified resources.void
actionReport()
Performs the move report, will be called by the JSP page.java.lang.String
buildSelectLocales(java.lang.String attributes)
Builds the html for the available locales select box.java.lang.String
buildSelectTemplates(java.lang.String attributes)
Builds the html for the template select box.org.opencms.file.CmsObject
getCms()
java.lang.String
getErrorMessage()
Returns the errorMessage.java.lang.String
getParamLocale()
Returns the paramLocale.java.lang.String
getParamNewElement()
Returns the value of the newvalue parameter.java.lang.String
getParamOldElement()
Returns the value of the oldvalue parametere.java.lang.String
getParamRecursive()
Returns the value of the recursive parameter.java.lang.String
getParamRemoveEmptyElements()
Returns true if the user has set remove empty elements parameter; otherwise false.java.lang.String
getParamTemplate()
Returns the template.java.lang.String
getParamValidateNewElement()
Returns true if the user has set validate new element parameter; otherwise false.protected void
initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
void
setErrorMessage(java.lang.String errorMessage)
Sets the errorMessage.void
setParamLocale(java.lang.String paramLocale)
Sets the locale.void
setParamNewElement(java.lang.String paramNewValue)
Sets the value of the newvalue parameter.void
setParamOldElement(java.lang.String paramOldValue)
Sets the value of the oldvalue parameter.void
setParamRecursive(java.lang.String paramRecursive)
Sets the value of the recursive parameter.void
setParamRemoveEmptyElements(java.lang.String paramRemoveEmptyElements)
Sets the remove empty elements parameter to true or false.void
setParamTemplate(java.lang.String paramTemplate)
Sets the param Template.void
setParamValidateNewElement(java.lang.String paramValidateNewElement)
Sets the paramValidateNewElement.void
validateParameters()
Does validate the request parameters and returns a buffer with error messages.-
Methods inherited from class org.opencms.workplace.CmsReport
dialogButtonsContinue, dialogButtonsOkCancelDetails, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getParamRefreshWorkplace, getParamReportContinueKey, getParamReportType, getParamThread, getParamThreadHasNext, getReportUpdate, hasError, htmlStart, htmlStart, initCmsReport, isAlive, isSimpleReport, pageHtml, performDialogOperation, reportConclusionText, reportIntroductionText, setParamRefreshWorkplace, setParamReportContinueKey, setParamReportType, setParamThread, setParamThreadHasNext
-
Methods inherited from class org.opencms.workplace.CmsMultiDialog
addMultiOperationException, buildLockHeaderBox, buildResourceList, checkMultiOperationException, checkResourcePermissions, getParamResourcelist, getResourceList, getResourceListAsParam, isMultiOperation, isOperationOnFolder, setDialogTitle, setParamResource, setParamResourcelist
-
Methods inherited from class org.opencms.workplace.CmsDialog
actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, 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, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, openLaunchpad, openWorkplaceLink, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, 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, canEditPermissionsForRoles, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences
-
-
-
-
Field Detail
-
ALL
public static final java.lang.String ALL
A constant representing the select option all templates.- See Also:
- Constant Field Values
-
DIALOG_TYPE
public static final java.lang.String DIALOG_TYPE
The dialog type.- See Also:
- Constant Field Values
-
PARAM_LOCALE
public static final java.lang.String PARAM_LOCALE
Request parameter name for the locale.- See Also:
- Constant Field Values
-
PARAM_NEW_ELEMENT
public static final java.lang.String PARAM_NEW_ELEMENT
Request parameter name for the new element name.- See Also:
- Constant Field Values
-
PARAM_OLD_ELEMENT
public static final java.lang.String PARAM_OLD_ELEMENT
Request parameter name for the old element name.- See Also:
- Constant Field Values
-
PARAM_RECURSIVE
public static final java.lang.String PARAM_RECURSIVE
Request parameter name for the recursive search.- See Also:
- Constant Field Values
-
PARAM_REMOVE_EMPTYELEMENTS
public static final java.lang.String PARAM_REMOVE_EMPTYELEMENTS
Request parameter name for the remove empty elements.- See Also:
- Constant Field Values
-
PARAM_TEMPLATE
public static final java.lang.String PARAM_TEMPLATE
Request parameter name for the template.- See Also:
- Constant Field Values
-
PARAM_VALIDATE_NEW_ELEMENT
public static final java.lang.String PARAM_VALIDATE_NEW_ELEMENT
Request parameter name for the validate new element.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsElementRename
public CmsElementRename(org.opencms.jsp.CmsJspActionElement jsp)
Public constructor with JSP action element.- Parameters:
jsp
- an initialized JSP action element
-
CmsElementRename
public CmsElementRename(org.opencms.jsp.CmsJspActionElement jsp, org.opencms.file.CmsObject cms, java.lang.String resource, java.lang.String recursive, java.lang.String template, java.lang.String locale, java.lang.String oldElement, java.lang.String newElement, java.lang.String removeEmptyElements, java.lang.String validateNewElement)
Public constructor for testcase using.- Parameters:
jsp
- an initialized JSP action elementcms
- the cms objectresource
- the resource pathrecursive
- if true then do read recursive from the foldertemplate
- the templatelocale
- the localeoldElement
- the old element namenewElement
- the new element nameremoveEmptyElements
- if true then remove all invalid elements with no contentvalidateNewElement
- if true then validate the new element before renaming
-
CmsElementRename
public CmsElementRename(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 contextreq
- the JSP requestres
- the JSP response
-
-
Method Detail
-
actionRename
public void actionRename(org.opencms.report.I_CmsReport report)
Renames the element name on the specified resources.- Parameters:
report
- the cms report
-
actionReport
public void actionReport() throws javax.servlet.jsp.JspException
Performs the move report, will be called by the JSP page.- Throws:
javax.servlet.jsp.JspException
- if problems including sub-elements occur
-
buildSelectLocales
public java.lang.String buildSelectLocales(java.lang.String attributes)
Builds the html for the available locales select box.- Parameters:
attributes
- optional attributes for the <select> tag- Returns:
- the html for the available locales select box
-
buildSelectTemplates
public java.lang.String buildSelectTemplates(java.lang.String attributes)
Builds the html for the template select box.- Parameters:
attributes
- optional attributes for the <select> tag- Returns:
- the html for the template select box
-
getCms
public org.opencms.file.CmsObject getCms()
- Overrides:
getCms
in classorg.opencms.workplace.CmsWorkplace
- See Also:
CmsWorkplace.getCms()
-
getErrorMessage
public java.lang.String getErrorMessage()
Returns the errorMessage.- Returns:
- the errorMessage
-
getParamLocale
public java.lang.String getParamLocale()
Returns the paramLocale.- Returns:
- the paramLocale
-
getParamNewElement
public java.lang.String getParamNewElement()
Returns the value of the newvalue parameter.- Returns:
- the value of the newvalue parameter
-
getParamOldElement
public java.lang.String getParamOldElement()
Returns the value of the oldvalue parametere.- Returns:
- the value of the oldvalue parameter
-
getParamRecursive
public java.lang.String getParamRecursive()
Returns the value of the recursive parameter.- Returns:
- the value of the recursive parameter
-
getParamRemoveEmptyElements
public java.lang.String getParamRemoveEmptyElements()
Returns true if the user has set remove empty elements parameter; otherwise false.- Returns:
- true if the user has set remove empty elements parameter; otherwise false
-
getParamTemplate
public java.lang.String getParamTemplate()
Returns the template.- Returns:
- the template
-
getParamValidateNewElement
public java.lang.String getParamValidateNewElement()
Returns true if the user has set validate new element parameter; otherwise false..
- Returns:
- true if the user has set validate new element parameter; otherwise false
-
setErrorMessage
public void setErrorMessage(java.lang.String errorMessage)
Sets the errorMessage.- Parameters:
errorMessage
- the errorMessage to set
-
setParamLocale
public void setParamLocale(java.lang.String paramLocale)
Sets the locale.- Parameters:
paramLocale
- the locale to set
-
setParamNewElement
public void setParamNewElement(java.lang.String paramNewValue)
Sets the value of the newvalue parameter.- Parameters:
paramNewValue
- the value of the newvalue parameter
-
setParamOldElement
public void setParamOldElement(java.lang.String paramOldValue)
Sets the value of the oldvalue parameter.- Parameters:
paramOldValue
- the value of the oldvalue parameter
-
setParamRecursive
public void setParamRecursive(java.lang.String paramRecursive)
Sets the value of the recursive parameter.- Parameters:
paramRecursive
- the value of the recursive parameter
-
setParamRemoveEmptyElements
public void setParamRemoveEmptyElements(java.lang.String paramRemoveEmptyElements)
Sets the remove empty elements parameter to true or false.- Parameters:
paramRemoveEmptyElements
- the remove empty elements parameter to set
-
setParamTemplate
public void setParamTemplate(java.lang.String paramTemplate)
Sets the param Template.- Parameters:
paramTemplate
- the template name to set
-
setParamValidateNewElement
public void setParamValidateNewElement(java.lang.String paramValidateNewElement)
Sets the paramValidateNewElement.- Parameters:
paramValidateNewElement
- the validate new element parameter to set
-
validateParameters
public void validateParameters()
Does validate the request parameters and returns a buffer with error messages.If there were no error messages, the buffer is empty.
-
initWorkplaceRequestValues
protected void initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
- Overrides:
initWorkplaceRequestValues
in classCmsReport
- See Also:
CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
-
-