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 CmsDialog

Provides a GUI for the configuration file comparison dialog.

Since:

6.0.0

Version:

$Revision: 1.10 $

Author:

Michael Moossen, Jan Baudisch

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_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_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

Fields inherited from class org.opencms.workplace.CmsWorkplace

DEBUG, 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, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, TEMP_FILE_PREFIX, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE

Constructor Summary

protected

A_CmsDiffViewDialog(CmsJspActionElement jsp) Default constructor.

Method Summary

java.lang.String	deactivatedEmphasizedButtonHtml(java.lang.String name, java.lang.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 java.lang.String	getCopySource() Returns the text to compare as copy.
protected abstract int	getLinesBeforeSkip() Returns the number of lines to show before they are skipped.
CmsDiffViewMode	getMode() Returns the mode.
protected abstract java.lang.String	getOriginalSource() Returns the text to compare as original.
java.lang.String	getParamMode() Returns the parameter value for the Mode.
java.lang.String	getTwoButtonsHtml(java.lang.String label1, java.lang.String label2, java.lang.String onClick1, java.lang.String onClick2, boolean firstActive) Returns the html for two buttons, whereby the third parameter determines which one is active.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
void	setMode(CmsDiffViewMode mode) Sets the mode.
void	setParamMode(java.lang.String mode) Sets the parameter value for the Mode.
protected abstract void	validateParamaters() Validates the parameters.
protected java.lang.String	wrapLinesWithUnchangedStyle(java.lang.String diff) Returns a diff text wrapped with formatting style.

Methods inherited from class org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, 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, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

Methods inherited from class org.opencms.workplace.tools.CmsToolDialog

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, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, isTemporaryFileName, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, switchToCurrentProject, switchToTempProject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

A_CmsDiffViewDialog

protected A_CmsDiffViewDialog(CmsJspActionElement jsp)

Default constructor.

Parameters:

jsp - an initialized JSP action element

Method Detail

displayDialog

public void displayDialog()
                   throws java.lang.Exception

Performs the dialog actions depending on the initialized action and displays the dialog form.

Throws:

java.lang.Exception - if writing to the JSP out fails

getTwoButtonsHtml

public java.lang.String getTwoButtonsHtml(java.lang.String label1,
                                          java.lang.String label2,
                                          java.lang.String onClick1,
                                          java.lang.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 java.lang.String deactivatedEmphasizedButtonHtml(java.lang.String name,
                                                        java.lang.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 CmsDiffViewMode getMode()

Returns the mode.

Returns:

the mode

getParamMode

public java.lang.String getParamMode()

Returns the parameter value for the Mode.

Returns:

the parameter value for the Mode

setMode

public void setMode(CmsDiffViewMode mode)

Sets the mode.

Parameters:

mode - the mode to set

setParamMode

public void setParamMode(java.lang.String mode)

Sets the parameter value for the Mode.

Parameters:

mode - the parameter value for the Mode to set

getCopySource

protected abstract java.lang.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 java.lang.String getOriginalSource()

Returns the text to compare as original.

Returns:

the text to compare as original

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                                          javax.servlet.http.HttpServletRequest request)

Description copied from class: CmsWorkplace

Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

Overrides:

initWorkplaceRequestValues in class CmsDialog

Parameters:

settings - the workplace settings

request - the current request

See Also:

CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

validateParamaters

protected abstract void validateParamaters()
                                    throws java.lang.Exception

Validates the parameters.

Throws:

java.lang.Exception - if something goes wrong

wrapLinesWithUnchangedStyle

protected java.lang.String wrapLinesWithUnchangedStyle(java.lang.String diff)
                                                throws java.io.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:

java.io.IOException - if something goes wrong