Class CmsRenameImages


  • public class CmsRenameImages
    extends org.opencms.workplace.CmsDialog
    Provides methods for the rename images dialog.

    The following files use this class:

    • /commons/renameimages.jsp

    Since:
    6.1.3
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ACTION_RENAMEIMAGES
      Value for the action: rename images.
      static java.lang.String DIALOG_TYPE
      The dialog type.
      static java.lang.String OPTION_DECIMALPLACES_1
      Selectbox option for decimal places selection: 1 place.
      static java.lang.String OPTION_DECIMALPLACES_2
      Selectbox option for decimal places selection: 2 places.
      static java.lang.String OPTION_DECIMALPLACES_3
      Selectbox option for decimal places selection: 3 places.
      static java.lang.String OPTION_DECIMALPLACES_4
      Selectbox option for decimal places selection: 4 places.
      static java.lang.String PARAM_PLACES
      Request parameter name for the counter places.
      static java.lang.String PARAM_PREFIX
      Request parameter name for the image prefix.
      static java.lang.String PARAM_REMOVETITLE
      Request parameter name for the remove title flag.
      static java.lang.String PARAM_STARTCOUNT
      Request parameter name for the start count.
      • 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
      CmsRenameImages​(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
      Public constructor with JSP variables.
      CmsRenameImages​(org.opencms.jsp.CmsJspActionElement jsp)
      Public constructor with JSP action element.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void actionRenameImages()
      Performs the rename images action, will be called by the JSP page.
      java.lang.String buildImageInformation()
      Returns information about the image count of the selected gallery folder.
      java.lang.String buildSelectPlaces​(java.lang.String htmlAttributes)
      Builds the html for the default copy folder mode select box.
      java.lang.String getDefaultPrefix()
      Returns the default prefix shown when opening the dialog.
      java.lang.String getDefaultStartcount()
      Returns the default start count shown when opening the dialog.
      java.lang.String getParamPlaces()
      Returns the value of the places parameter.
      java.lang.String getParamPrefix()
      Returns the value of the prefix parameter.
      java.lang.String getParamRemovetitle()
      Returns the value of the remove title parameter.
      java.lang.String getParamStartcount()
      Returns the value of the startcount parameter.
      protected void initWorkplaceRequestValues​(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)  
      protected boolean performDialogOperation()
      Performs the rename images operation.
      void setParamPlaces​(java.lang.String paramPlaces)
      Sets the value of the places parameter.
      void setParamPrefix​(java.lang.String paramPrefix)
      Sets the value of the prefix parameter.
      void setParamRemovetitle​(java.lang.String paramRemovetitle)
      Sets the value of the remove title parameter.
      void setParamStartcount​(java.lang.String paramStartcount)
      Sets the value of the startcount parameter.
      • Methods inherited from class org.opencms.workplace.CmsDialog

        actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, 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, openLaunchpad, openWorkplaceLink, 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, canEditPermissionsForRoles, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, 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
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CmsRenameImages

        public CmsRenameImages​(org.opencms.jsp.CmsJspActionElement jsp)
        Public constructor with JSP action element.

        Parameters:
        jsp - an initialized JSP action element
      • CmsRenameImages

        public CmsRenameImages​(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

      • actionRenameImages

        public void actionRenameImages()
                                throws javax.servlet.jsp.JspException
        Performs the rename images action, will be called by the JSP page.

        Throws:
        javax.servlet.jsp.JspException - if problems including sub-elements occur
      • buildImageInformation

        public java.lang.String buildImageInformation()
        Returns information about the image count of the selected gallery folder.

        Returns:
        information about the image count of the selected gallery folder
      • buildSelectPlaces

        public java.lang.String buildSelectPlaces​(java.lang.String htmlAttributes)
        Builds the html for the default copy folder mode select box.

        Parameters:
        htmlAttributes - optional html attributes for the &lgt;select> tag
        Returns:
        the html for the default copy folder mode select box
      • getDefaultPrefix

        public java.lang.String getDefaultPrefix()
        Returns the default prefix shown when opening the dialog.

        Returns:
        the default prefix shown when opening the dialog
      • getDefaultStartcount

        public java.lang.String getDefaultStartcount()
        Returns the default start count shown when opening the dialog.

        Returns:
        the default start count shown when opening the dialog
      • getParamPlaces

        public java.lang.String getParamPlaces()
        Returns the value of the places parameter.

        Returns:
        the value of the places parameter
      • getParamPrefix

        public java.lang.String getParamPrefix()
        Returns the value of the prefix parameter.

        Returns:
        the value of the prefix parameter
      • getParamRemovetitle

        public java.lang.String getParamRemovetitle()
        Returns the value of the remove title parameter.

        Returns:
        the value of the remove title parameter
      • getParamStartcount

        public java.lang.String getParamStartcount()
        Returns the value of the startcount parameter.

        Returns:
        the value of the startcount parameter
      • setParamPlaces

        public void setParamPlaces​(java.lang.String paramPlaces)
        Sets the value of the places parameter.

        Parameters:
        paramPlaces - the value of the places parameter
      • setParamPrefix

        public void setParamPrefix​(java.lang.String paramPrefix)
        Sets the value of the prefix parameter.

        Parameters:
        paramPrefix - the value of the prefix parameter
      • setParamRemovetitle

        public void setParamRemovetitle​(java.lang.String paramRemovetitle)
        Sets the value of the remove title parameter.

        Parameters:
        paramRemovetitle - the value of the remove title parameter
      • setParamStartcount

        public void setParamStartcount​(java.lang.String paramStartcount)
        Sets the value of the startcount parameter.

        Parameters:
        paramStartcount - the value of the startcount parameter
      • initWorkplaceRequestValues

        protected void initWorkplaceRequestValues​(org.opencms.workplace.CmsWorkplaceSettings settings,
                                                  javax.servlet.http.HttpServletRequest request)
        Overrides:
        initWorkplaceRequestValues in class org.opencms.workplace.CmsDialog
        See Also:
        CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
      • performDialogOperation

        protected boolean performDialogOperation()
                                          throws org.opencms.main.CmsException
        Performs the rename images operation.

        Returns:
        true, if the resources were successfully renamed, otherwise false
        Throws:
        org.opencms.main.CmsException - if renaming is not successful