org.opencms.workplace.commons
Class CmsHistory

java.lang.Object
  org.opencms.workplace.CmsWorkplace
      org.opencms.workplace.tools.CmsToolDialog
          org.opencms.workplace.CmsDialog
              org.opencms.workplace.commons.CmsHistory

public class CmsHistory
extends CmsDialog

Provides methods for displaying the history file dialog.

The following files use this class:

• /commons/history.jsp

Since:

6.0.0

Version:

$Revision: 1.22 $

Author:

Armen Markarian

Field Summary

static int	ACTION_RESTORE_VERSION Value for the action: restore the version.
static String	DIALOG_RESTORE Request parameter value for the action: restore the version.
static String	DIALOG_TYPE The dialog type.

Fields inherited from class org.opencms.workplace.CmsDialog

ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_DEFAULT, 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_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, 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_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

CmsHistory(CmsJspActionElement jsp)
Public constructor with JSP action element.

CmsHistory(PageContext context, HttpServletRequest req, HttpServletResponse res)
Public constructor with JSP variables.

Method Summary

void	actionRestore() Performs the restore action, will be called by the JSP page.
String	buildVersionList() Builds a list of Versions of the specified resource.
String	getParamVersionid() Returns the paramVersionid.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
protected void	performRestoreOperation() Restores a backed up resource version.
void	setParamVersionid(String paramVersionid) Sets the paramVersionid.

Methods inherited from class org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, checkResourcePermissions, checkResourcePermissions, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, 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, getParamRedirect, getParamResource, getParamTitle, getState, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamRedirect, setParamResource, setParamTitle

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

dialogTitle, getAdminTool, getCurrentToolPath, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamPath, setParamRoot, setParamStyle, useNewStyle

Methods inherited from class org.opencms.workplace.CmsWorkplace

addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, calendarIncludes, calendarIncludes, calendarInit, calendarInit, checkLock, checkLock, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCalendarDate, getCalendarJavaDateFormat, getCalendarLocalizedTime, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStyleUri, getStyleUri, getStyleUri, htmlEnd, initMessages, initSettings, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, key, key, key, 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

Field Detail

ACTION_RESTORE_VERSION

public static final int ACTION_RESTORE_VERSION

Value for the action: restore the version.

See Also:

Constant Field Values

DIALOG_TYPE

public static final String DIALOG_TYPE

The dialog type.

See Also:

Constant Field Values

DIALOG_RESTORE

public static final String DIALOG_RESTORE

Request parameter value for the action: restore the version.

See Also:

Constant Field Values

Constructor Detail

CmsHistory

public CmsHistory(CmsJspActionElement jsp)

Public constructor with JSP action element.

Parameters:

jsp - an initialized JSP action element

CmsHistory

public CmsHistory(PageContext context,
                  HttpServletRequest req,
                  HttpServletResponse res)

Public constructor with JSP variables.

Parameters:

context - the JSP page context

req - the JSP request

res - the JSP response

Method Detail

actionRestore

public void actionRestore()
                   throws JspException

Performs the restore action, will be called by the JSP page.

Throws:

JspException - if including a JSP subelement is not successful

buildVersionList

public String buildVersionList()
                        throws CmsException

Builds a list of Versions of the specified resource.

Returns:

the HTML String for the Version list

Throws:

CmsException - if operation was not successful

getParamVersionid

public String getParamVersionid()

Returns the paramVersionid.

Returns:

the paramVersionid

setParamVersionid

public void setParamVersionid(String paramVersionid)

Sets the paramVersionid.

Parameters:

paramVersionid - the paramVersionid to set

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                                          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)

performRestoreOperation

protected void performRestoreOperation()
                                throws CmsException

Restores a backed up resource version.

Throws:

CmsException - if something goes wrong