Package org.opencms.workplace.comparison

Class CmsResourceComparisonDialog

java.lang.Object
org.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.comparison.CmsResourceComparisonDialog
public class CmsResourceComparisonDialog extends org.opencms.workplace.CmsDialog
Helper class for managing three lists on the same dialog.

Since:
6.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    COMPARE_ALL_ELEMENTS
    Constant indicating that all elements are compared.
    static final String
    COMPARE_ATTRIBUTES
    Constant indicating that the attributes are compared.
    static final String
    COMPARE_PROPERTIES
    Constant indicating that the properties are compared.

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    displayDialog()
    Display method for two list dialogs.
    void
    displayDifferenceDialog()
    Displays the difference dialog.
    String[]
    getAttributesAsString(List<?> attributes)
    Converts an attribute list to a string.
    String
    getParamCompare()
    Returns the paramCompare.
    String
    getParamElement()
    Returns the paramElement.
    String
    getParamId1()
    Returns the paramId1.
    String
    getParamId2()
    Returns the paramId2.
    String
    getParamLocale()
    Returns the paramLocale.
    String
    getParamTextmode()
    Returns the paramTextmode.
    String
    getParamVersion1()
    Returns the paramVersion1.
    String
    getParamVersion2()
    Returns the paramVersion2.
    String[]
    getPropertiesAsString(List<?> properties)
    Converts an attribute list to a string.
    protected void
    initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
     
    static org.opencms.file.CmsFile
    readFile(org.opencms.file.CmsObject cms, org.opencms.util.CmsUUID structureId, String version)
    Returns either the historical file or the offline file, depending on the version number.
    protected static org.opencms.file.CmsResource
    readResource(org.opencms.file.CmsObject cms, org.opencms.util.CmsUUID id, String version)
    Returns either the historical resource or the offline resource, depending on the version number.
    void
    setParamCompare(String paramCompare)
    Sets the paramCompare.
    void
    setParamElement(String paramElement)
    Sets the paramElement.
    void
    setParamId1(String paramId1)
    Sets the paramId1.
    void
    setParamId2(String paramId2)
    Sets the paramId2.
    void
    setParamLocale(String paramLocale)
    Sets the paramLocale.
    void
    setParamTextmode(String paramTextmode)
    Sets the paramTextmode.
    void
    setParamVersion1(String paramVersion1)
    Sets the paramVersion1.
    void
    setParamVersion2(String paramVersion2)
    Sets the paramVersion2.

    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

    • CmsResourceComparisonDialog

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

      Parameters:
      jsp - an initialized JSP action element

    • CmsResourceComparisonDialog

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

    • readFile

      public static org.opencms.file.CmsFile readFile(org.opencms.file.CmsObject cms, org.opencms.util.CmsUUID structureId, String version) throws org.opencms.main.CmsException
      Returns either the historical file or the offline file, depending on the version number.

      Parameters:
      cms - the CmsObject to use
      structureId - the structure id of the file
      version - the historical version number
      Returns:
      either the historical file or the offline file, depending on the version number
      Throws:
      org.opencms.main.CmsException - if something goes wrong

    • readResource

      protected static org.opencms.file.CmsResource readResource(org.opencms.file.CmsObject cms, org.opencms.util.CmsUUID id, String version) throws org.opencms.main.CmsException
      Returns either the historical resource or the offline resource, depending on the version number.

      Parameters:
      cms - the CmsObject to use
      id - the structure id of the resource
      version - the historical version number
      Returns:
      either the historical resource or the offline resource, depending on the version number
      Throws:
      org.opencms.main.CmsException - if something goes wrong

    • displayDialog

      public void displayDialog() throws Exception
      Display method for two list dialogs.

      Throws:
      Exception - if something goes wrong

    • displayDifferenceDialog

      public void displayDifferenceDialog() throws Exception
      Displays the difference dialog.

      Throws:
      Exception - if something goes wrong

    • getAttributesAsString

      public String[] getAttributesAsString(List<?> attributes)
      Converts an attribute list to a string.

      Parameters:
      attributes - a list of compared attributes to be converted to a string
      Returns:
      a string respresentation of the attribute list

    • getParamCompare

      public String getParamCompare()
      Returns the paramCompare.

      Returns:
      the paramCompare

    • getParamElement

      public String getParamElement()
      Returns the paramElement.

      Returns:
      the paramElement

    • getParamId1

      public String getParamId1()
      Returns the paramId1.

      Returns:
      the paramId1

    • getParamId2

      public String getParamId2()
      Returns the paramId2.

      Returns:
      the paramId2

    • getParamLocale

      public String getParamLocale()
      Returns the paramLocale.

      Returns:
      the paramLocale

    • getParamTextmode

      public String getParamTextmode()
      Returns the paramTextmode.

      Returns:
      the paramTextmode

    • getParamVersion1

      public String getParamVersion1()
      Returns the paramVersion1.

      Returns:
      the paramVersion1

    • getParamVersion2

      public String getParamVersion2()
      Returns the paramVersion2.

      Returns:
      the paramVersion2

    • getPropertiesAsString

      public String[] getPropertiesAsString(List<?> properties)
      Converts an attribute list to a string.

      Parameters:
      properties - a list of compared properties to be converted to a string
      Returns:
      a string respresentation of the attribute list

    • setParamCompare

      public void setParamCompare(String paramCompare)
      Sets the paramCompare.

      Parameters:
      paramCompare - the paramCompare to set

    • setParamElement

      public void setParamElement(String paramElement)
      Sets the paramElement.

      Parameters:
      paramElement - the paramElement to set

    • setParamId1

      public void setParamId1(String paramId1)
      Sets the paramId1.

      Parameters:
      paramId1 - the paramId1 to set

    • setParamId2

      public void setParamId2(String paramId2)
      Sets the paramId2.

      Parameters:
      paramId2 - the paramId2 to set

    • setParamLocale

      public void setParamLocale(String paramLocale)
      Sets the paramLocale.

      Parameters:
      paramLocale - the paramLocale to set

    • setParamTextmode

      public void setParamTextmode(String paramTextmode)
      Sets the paramTextmode.

      Parameters:
      paramTextmode - the paramTextmode to set

    • setParamVersion1

      public void setParamVersion1(String paramVersion1)
      Sets the paramVersion1.

      Parameters:
      paramVersion1 - the paramVersion1 to set

    • setParamVersion2

      public void setParamVersion2(String paramVersion2)
      Sets the paramVersion2.

      Parameters:
      paramVersion2 - the paramVersion2 to set

    • 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)