Package org.opencms.workplace.tools.content

Class CmsPropertyChange

java.lang.Object
org.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.tools.content.CmsPropertyChange
public class CmsPropertyChange extends org.opencms.workplace.CmsDialog
Provides methods for the change property values dialog.

Since:
6.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ACTION_SHOWRESULT
    Value for the action: show result.
    static final String
    DIALOG_SHOWRESULT
    Request parameter value for the action: show result.
    static final String
    DIALOG_TYPE
    The dialog type.
    static final String
    PARAM_NEWVALUE
    Request parameter name for the property name.
    static final String
    PARAM_OLDVALUE
    Request parameter name for the property name.
    static final String
    PARAM_PROPERTYNAME
    Request parameter name for the property name.
    static final String
    PARAM_RECURSIVE
    Request parameter name for the property name.

    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
    CmsPropertyChange(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
    Public constructor with JSP variables.
    CmsPropertyChange(org.opencms.jsp.CmsJspActionElement jsp)
    Public constructor with JSP action element.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    actionChange()
    Changes the property values on the specified resources.
    String
    buildResultList()
    Builds the html for the result list of resources where the property was changed.
    String
    buildSelectProperty(String attributes)
    Builds the html for the property definition select box.
    static String
    buildSelectProperty(org.opencms.file.CmsObject cms, String selectValue, String attributes, String selectedValue)
    Builds the html for the property definition select box.
    String
    getErrorMessage()
    Returns the error message.
    String
    getParamNewValue()
    Returns the value of the newvalue parameter.
    String
    getParamOldValue()
    Returns the value of the oldvalue parametere.
    String
    getParamPropertyName()
    Returns the value of the propertyname parameter.
    String
    getParamRecursive()
    Returns the value of the recursive parameter.
    String
    getResultListHeight()
    Returns the height for the result list of changed resources.
    boolean
    hasValidationErrors()
    Returns if validation errors were found.
    protected void
    initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
     
    protected void
    setErrorMessage(String errorMessage)
    Sets the error message.
    void
    setParamNewValue(String paramNewValue)
    Sets the value of the newvalue parameter.
    void
    setParamOldValue(String paramOldValue)
    Sets the value of the oldvalue parameter.
    void
    setParamPropertyName(String paramPropertyName)
    Sets the value of the propertyname parameter.
    void
    setParamRecursive(String paramRecursive)
    Sets the value of the recursive parameter.
    protected void
    setValidationErrors(boolean validationErrors)
    Sets the validation error flag.

    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

  • Field Details

  • Constructor Details

    • CmsPropertyChange

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

      Parameters:
      jsp - an initialized JSP action element

    • CmsPropertyChange

      public CmsPropertyChange(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 Details

    • buildSelectProperty

      public static String buildSelectProperty(org.opencms.file.CmsObject cms, String selectValue, String attributes, String selectedValue)
      Builds the html for the property definition select box.

      Parameters:
      cms - the CmsObject
      selectValue - the localized value for the "Please select" option
      attributes - optional attributes for the <select> tag
      selectedValue - the value that is currently selected
      Returns:
      the html for the property definition select box

    • actionChange

      public void actionChange() throws javax.servlet.jsp.JspException
      Changes the property values on the specified resources.

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

    • buildResultList

      public String buildResultList()
      Builds the html for the result list of resources where the property was changed.

      Returns:
      the html for the result list

    • buildSelectProperty

      public String buildSelectProperty(String attributes)
      Builds the html for the property definition select box.

      Parameters:
      attributes - optional attributes for the <select> tag
      Returns:
      the html for the property definition select box

    • getErrorMessage

      public String getErrorMessage()
      Returns the error message.

      Returns:
      the error message

    • getParamNewValue

      public String getParamNewValue()
      Returns the value of the newvalue parameter.

      Returns:
      the value of the newvalue parameter

    • getParamOldValue

      public String getParamOldValue()
      Returns the value of the oldvalue parametere.

      Returns:
      the value of the oldvalue parameter

    • getParamPropertyName

      public String getParamPropertyName()
      Returns the value of the propertyname parameter.

      Returns:
      the value of the propertyname parameter

    • getParamRecursive

      public String getParamRecursive()
      Returns the value of the recursive parameter.

      Returns:
      the value of the recursive parameter

    • getResultListHeight

      public String getResultListHeight()
      Returns the height for the result list of changed resources.

      Returns:
      the height for the result list of changed resources

    • hasValidationErrors

      public boolean hasValidationErrors()
      Returns if validation errors were found.

      Returns:
      true if validation errors were found, otherwise false

    • setParamNewValue

      public void setParamNewValue(String paramNewValue)
      Sets the value of the newvalue parameter.

      Parameters:
      paramNewValue - the value of the newvalue parameter

    • setParamOldValue

      public void setParamOldValue(String paramOldValue)
      Sets the value of the oldvalue parameter.

      Parameters:
      paramOldValue - the value of the oldvalue parameter

    • setParamPropertyName

      public void setParamPropertyName(String paramPropertyName)
      Sets the value of the propertyname parameter.

      Parameters:
      paramPropertyName - the value of the propertyname parameter

    • setParamRecursive

      public void setParamRecursive(String paramRecursive)
      Sets the value of the recursive parameter.

      Parameters:
      paramRecursive - the value of the recursive 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)

    • setErrorMessage

      protected void setErrorMessage(String errorMessage)
      Sets the error message.

      Parameters:
      errorMessage - the error message to set

    • setValidationErrors

      protected void setValidationErrors(boolean validationErrors)
      Sets the validation error flag.

      Parameters:
      validationErrors - the validation error flag, true if validation errors were found