Package org.opencms.workplace.comparison

Class A_CmsDiffViewDialog

java.lang.Object
org.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.comparison.A_CmsDiffViewDialog
Direct Known Subclasses:
CmsDifferenceDialog
public abstract class A_CmsDiffViewDialog extends org.opencms.workplace.CmsDialog
Provides a GUI for the configuration file comparison dialog.

Since:
6.0.0

  • Field Summary

    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
    Modifier
    Constructor
    Description
    protected
    A_CmsDiffViewDialog(org.opencms.jsp.CmsJspActionElement jsp)
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    deactivatedEmphasizedButtonHtml(String name, String iconPath)
    Returns the html code for a deactivated empfasized button.
    void
    displayDialog()
    Performs the dialog actions depending on the initialized action and displays the dialog form.
    protected abstract String
    getCopySource()
    Returns the text to compare as copy.
    protected abstract int
    getLinesBeforeSkip()
    Returns the number of lines to show before they are skipped.
    org.opencms.workplace.comparison.CmsDiffViewMode
    getMode()
    Returns the mode.
    protected abstract String
    getOriginalSource()
    Returns the text to compare as original.
    String
    getParamMode()
    Returns the parameter value for the Mode.
    String
    getTwoButtonsHtml(String label1, String label2, String onClick1, String onClick2, boolean firstActive)
    Returns the html for two buttons, whereby the third parameter determines which one is active.
    protected void
    initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
     
    void
    setMode(org.opencms.workplace.comparison.CmsDiffViewMode mode)
    Sets the mode.
    void
    setParamMode(String mode)
    Sets the parameter value for the Mode.
    protected abstract void
    validateParamaters()
    Validates the parameters.
    protected String
    wrapLinesWithUnchangedStyle(String diff)
    Returns a diff text wrapped with formatting style.

    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 Details

    • A_CmsDiffViewDialog

      protected A_CmsDiffViewDialog(org.opencms.jsp.CmsJspActionElement jsp)
      Default constructor.

      Parameters:
      jsp - an initialized JSP action element

  • Method Details

    • displayDialog

      public void displayDialog() throws Exception
      Performs the dialog actions depending on the initialized action and displays the dialog form.

      Throws:
      Exception - if writing to the JSP out fails

    • getTwoButtonsHtml

      public String getTwoButtonsHtml(String label1, String label2, String onClick1, String onClick2, boolean firstActive)
      Returns the html for two buttons, whereby the third parameter determines which one is active.

      Parameters:
      label1 - the label for the first button
      label2 - the label for the second button
      firstActive - a flag indicating wheter the first or second button is active
      onClick1 - the action to be performed if the first button is clicked
      onClick2 - the action to be performed if the second button is clicked
      Returns:
      the html for two buttons, whereby the third parameter determines which one is active

    • deactivatedEmphasizedButtonHtml

      public String deactivatedEmphasizedButtonHtml(String name, String iconPath)
      Returns the html code for a deactivated empfasized button.

      Parameters:
      name - the label of the button
      iconPath - the path to the icon
      Returns:
      the html code for a deactivated empfasized button

    • getMode

      public org.opencms.workplace.comparison.CmsDiffViewMode getMode()
      Returns the mode.

      Returns:
      the mode

    • getParamMode

      public String getParamMode()
      Returns the parameter value for the Mode.

      Returns:
      the parameter value for the Mode

    • setMode

      public void setMode(org.opencms.workplace.comparison.CmsDiffViewMode mode)
      Sets the mode.

      Parameters:
      mode - the mode to set

    • setParamMode

      public void setParamMode(String mode)
      Sets the parameter value for the Mode.

      Parameters:
      mode - the parameter value for the Mode to set

    • getCopySource

      protected abstract String getCopySource()
      Returns the text to compare as copy.

      Returns:
      the text to compare as copy

    • getLinesBeforeSkip

      protected abstract int getLinesBeforeSkip()
      Returns the number of lines to show before they are skipped.

      Returns:
      the number of lines to show before they are skipped

    • getOriginalSource

      protected abstract String getOriginalSource()
      Returns the text to compare as original.

      Returns:
      the text to compare as original

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

    • validateParamaters

      protected abstract void validateParamaters() throws Exception
      Validates the parameters.

      Throws:
      Exception - if something goes wrong

    • wrapLinesWithUnchangedStyle

      protected String wrapLinesWithUnchangedStyle(String diff) throws IOException
      Returns a diff text wrapped with formatting style.

      Parameters:
      diff - the text to wrap with CSS formatting
      Returns:
      the text with formatting styles wrapped
      Throws:
      IOException - if something goes wrong