org.opencms.workplace.commons
Class CmsHistoryList

java.lang.Object
  org.opencms.workplace.CmsWorkplace
      org.opencms.workplace.tools.CmsToolDialog
          org.opencms.workplace.CmsDialog
              org.opencms.workplace.list.A_CmsListDialog
                  org.opencms.workplace.commons.CmsHistoryList

public class CmsHistoryList
extends A_CmsListDialog

Displays the history of a file.

Since:

6.0.2

Version:

$Revision: 1.5 $

Author:

Jan Baudisch, Armen Markarian

Nested Class Summary

static class

CmsHistoryList.CmsVersionWrapper Wrapper class for the version which is either an integer or the string "offline".

Field Summary

static String	LIST_ACTION_RESTORE List action export.
static String	LIST_ACTION_VIEW list action id constant.
static String	LIST_COLUMN_DATE_LAST_MODIFIED list column id constant.
static String	LIST_COLUMN_DATE_PUBLISHED list column id constant.
static String	LIST_COLUMN_FILE_TYPE list column id constant.
static String	LIST_COLUMN_ICON list column id constant.
static String	LIST_COLUMN_RESOURCE_PATH list column id constant.
static String	LIST_COLUMN_RESTORE List column delete.
static String	LIST_COLUMN_SEL1 list column id constant.
static String	LIST_COLUMN_SEL2 list column id constant.
static String	LIST_COLUMN_SIZE list column id constant.
static String	LIST_COLUMN_USER List column export.
static String	LIST_COLUMN_VERSION list column id constant.
static String	LIST_COLUMN_VIEW List column export.
static String	LIST_ID list id constant.
static String	LIST_RACTION_SEL1 list independent action id constant.
static String	LIST_RACTION_SEL2 list independent action id constant.
static String	OFFLINE_PROJECT constant for the offline project.
static String	PARAM_PATH_1 parameter for the path of the first resource.
static String	PARAM_PATH_2 parameter for the path of the second resource.
static String	PARAM_TAGID_1 parameter for the version of the first resource.
static String	PARAM_TAGID_2 parameter for the tag id of the second resource.
static String	PARAM_VERSION_1 parameter for the version of the first resource.
static String	PARAM_VERSION_2 parameter for the version of the second resource.
static String	PATH_BUTTONS Path to the list buttons.

Fields inherited from class org.opencms.workplace.list.A_CmsListDialog

ACTION_LIST_INDEPENDENT_ACTION, ACTION_LIST_MULTI_ACTION, ACTION_LIST_SEARCH, ACTION_LIST_SELECT_PAGE, ACTION_LIST_SINGLE_ACTION, ACTION_LIST_SORT, ICON_ACTIVE, ICON_ADD, ICON_DELETE, ICON_DETAILS_HIDE, ICON_DETAILS_SHOW, ICON_DISABLED, ICON_INACTIVE, ICON_MINUS, ICON_MULTI_ACTIVATE, ICON_MULTI_ADD, ICON_MULTI_DEACTIVATE, ICON_MULTI_DELETE, ICON_MULTI_MINUS, LIST_INDEPENDENT_ACTION, LIST_MULTI_ACTION, LIST_SEARCH, LIST_SELECT_PAGE, LIST_SINGLE_ACTION, LIST_SORT, PARAM_FORMNAME, PARAM_LIST_ACTION, PARAM_PAGE, PARAM_SEARCH_FILTER, PARAM_SEL_ITEMS, PARAM_SORT_COL

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_BASE, 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

CmsHistoryList(CmsJspActionElement jsp)
Public constructor.

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

Method Summary

protected String	defaultActionHtmlStart() Generates the dialog starting html code.
void	executeListMultiActions() This method should handle every defined list multi action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.
void	executeListSingleActions() This method should handle every defined list single action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.
protected void	fillDetails(String detailId) Lazy initialization for detail data.
static String	getBackupLink(String resourcePath, String versionId) Returns the link to a backup file.
protected List	getListItems() Should generate a list with the list items to be displayed.
protected void	performRestoreOperation() Restores a backed up resource version.
static String	readUserNameOfBackupFile(CmsObject cms, CmsFile file) Returns the user last modified of a backup resource.
protected void	setColumns(CmsListMetadata metadata) Should create the columns and add them to the given list metadata object.
protected void	setIndependentActions(CmsListMetadata metadata) Should add the independent actions to the given list metadata object.
protected void	setMultiActions(CmsListMetadata metadata) Should add the multi actions to the given list metadata object.

Methods inherited from class org.opencms.workplace.list.A_CmsListDialog

actionDialog, customHtmlEnd, customHtmlStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, displayDialog, displayDialog, executeDefaultActions, executeListIndepActions, executeSearch, executeSelectPage, executeSort, fillList, getList, getListId, getListObject, getMetadata, getParamFormName, getParamListAction, getParamPage, getParamSearchFilter, getParamSelItems, getParamSortCol, getSelectedItem, getSelectedItems, initWorkplaceRequestValues, isActive, listRecovery, listSave, refreshList, removeList, setList, setListObject, setParamFormName, setParamListAction, setParamPage, setParamSearchFilter, setParamSelItems, setParamSortCol, setSearchAction, throwListUnsupportedActionException, validateParamaters, writeDialog

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, getParamBase, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, 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, 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, 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

Field Detail

LIST_ACTION_RESTORE

public static final String LIST_ACTION_RESTORE

List action export.

See Also:

Constant Field Values

LIST_ACTION_VIEW

public static final String LIST_ACTION_VIEW

list action id constant.

See Also:

Constant Field Values

LIST_COLUMN_DATE_LAST_MODIFIED

public static final String LIST_COLUMN_DATE_LAST_MODIFIED

list column id constant.

See Also:

Constant Field Values

LIST_COLUMN_DATE_PUBLISHED

public static final String LIST_COLUMN_DATE_PUBLISHED

list column id constant.

See Also:

Constant Field Values

LIST_COLUMN_FILE_TYPE

public static final String LIST_COLUMN_FILE_TYPE

list column id constant.

See Also:

Constant Field Values

LIST_COLUMN_ICON

public static final String LIST_COLUMN_ICON

list column id constant.

See Also:

Constant Field Values

LIST_COLUMN_RESOURCE_PATH

public static final String LIST_COLUMN_RESOURCE_PATH

list column id constant.

See Also:

Constant Field Values

LIST_COLUMN_RESTORE

public static final String LIST_COLUMN_RESTORE

List column delete.

See Also:

Constant Field Values

LIST_COLUMN_SEL1

public static final String LIST_COLUMN_SEL1

list column id constant.

See Also:

Constant Field Values

LIST_COLUMN_SEL2

public static final String LIST_COLUMN_SEL2

list column id constant.

See Also:

Constant Field Values

LIST_COLUMN_SIZE

public static final String LIST_COLUMN_SIZE

list column id constant.

See Also:

Constant Field Values

LIST_COLUMN_USER

public static final String LIST_COLUMN_USER

List column export.

See Also:

Constant Field Values

LIST_COLUMN_VERSION

public static final String LIST_COLUMN_VERSION

list column id constant.

See Also:

Constant Field Values

LIST_COLUMN_VIEW

public static final String LIST_COLUMN_VIEW

List column export.

See Also:

Constant Field Values

LIST_ID

public static final String LIST_ID

list id constant.

See Also:

Constant Field Values

LIST_RACTION_SEL1

public static final String LIST_RACTION_SEL1

list independent action id constant.

See Also:

Constant Field Values

LIST_RACTION_SEL2

public static final String LIST_RACTION_SEL2

list independent action id constant.

See Also:

Constant Field Values

OFFLINE_PROJECT

public static final String OFFLINE_PROJECT

constant for the offline project.

See Also:

Constant Field Values

PARAM_TAGID_1

public static final String PARAM_TAGID_1

parameter for the version of the first resource.

See Also:

Constant Field Values

PARAM_TAGID_2

public static final String PARAM_TAGID_2

parameter for the tag id of the second resource.

See Also:

Constant Field Values

PARAM_VERSION_1

public static final String PARAM_VERSION_1

parameter for the version of the first resource.

See Also:

Constant Field Values

PARAM_VERSION_2

public static final String PARAM_VERSION_2

parameter for the version of the second resource.

See Also:

Constant Field Values

PARAM_PATH_1

public static final String PARAM_PATH_1

parameter for the path of the first resource.

See Also:

Constant Field Values

PARAM_PATH_2

public static final String PARAM_PATH_2

parameter for the path of the second resource.

See Also:

Constant Field Values

PATH_BUTTONS

public static final String PATH_BUTTONS

Path to the list buttons.

See Also:

Constant Field Values

Constructor Detail

CmsHistoryList

public CmsHistoryList(CmsJspActionElement jsp)

Public constructor.

Parameters:

jsp - an initialized JSP action element

CmsHistoryList

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

executeListMultiActions

public void executeListMultiActions()
                             throws IOException,
                                    ServletException

Description copied from class: A_CmsListDialog

This method should handle every defined list multi action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.

Specified by:

executeListMultiActions in class A_CmsListDialog

Throws:

IOException - in case of errors when including a required sub-element

ServletException - in case of errors when including a required sub-element

See Also:

A_CmsListDialog.executeListMultiActions()

executeListSingleActions

public void executeListSingleActions()
                              throws IOException,
                                     ServletException

Description copied from class: A_CmsListDialog

This method should handle every defined list single action, by comparing A_CmsListDialog.getParamListAction() with the id of the action to execute.

Specified by:

executeListSingleActions in class A_CmsListDialog

Throws:

IOException - in case of errors when including a required sub-element

ServletException - in case of errors when including a required sub-element

See Also:

A_CmsListDialog.executeListSingleActions()

defaultActionHtmlStart

protected String defaultActionHtmlStart()

Description copied from class: A_CmsListDialog

Generates the dialog starting html code.

Overrides:

defaultActionHtmlStart in class A_CmsListDialog

Returns:

html code

See Also:

A_CmsListDialog.defaultActionHtmlStart()

fillDetails

protected void fillDetails(String detailId)

Description copied from class: A_CmsListDialog

Lazy initialization for detail data.

Should fill the given detail column for every list item in CmsHtmlList.getAllContent() Should not throw any kind of exception.

Specified by:

fillDetails in class A_CmsListDialog

Parameters:

detailId - the id of the detail to initialize

See Also:

A_CmsListDialog.fillDetails(java.lang.String)

getListItems

protected List getListItems()
                     throws CmsException

Description copied from class: A_CmsListDialog

Should generate a list with the list items to be displayed.

Specified by:

getListItems in class A_CmsListDialog

Returns:

a list of CmsListItems

Throws:

CmsException - if something goes wrong

See Also:

A_CmsListDialog.getListItems()

readUserNameOfBackupFile

public static String readUserNameOfBackupFile(CmsObject cms,
                                              CmsFile file)
                                       throws CmsException

Returns the user last modified of a backup resource.

Parameters:

cms - the cms object

file - the file to use

Returns:

the user last modified of a backup resource

Throws:

CmsException - if something goes wrong

performRestoreOperation

protected void performRestoreOperation()
                                throws CmsException

Restores a backed up resource version.

Throws:

CmsException - if something goes wrong

setColumns

protected void setColumns(CmsListMetadata metadata)

Description copied from class: A_CmsListDialog

Should create the columns and add them to the given list metadata object.

This method will be just executed once, the first time the constructor is called.

Specified by:

setColumns in class A_CmsListDialog

Parameters:

metadata - the list metadata

See Also:

A_CmsListDialog.setColumns(org.opencms.workplace.list.CmsListMetadata)

getBackupLink

public static String getBackupLink(String resourcePath,
                                   String versionId)

Returns the link to a backup file.

Parameters:

resourcePath - the path of the file

versionId - the version of the file

Returns:

the link to a backup file

setIndependentActions

protected void setIndependentActions(CmsListMetadata metadata)

Description copied from class: A_CmsListDialog

Should add the independent actions to the given list metadata object.

This method will be just executed once, the first time the constructor is called.

Specified by:

setIndependentActions in class A_CmsListDialog

Parameters:

metadata - the list metadata

See Also:

A_CmsListDialog.setIndependentActions(org.opencms.workplace.list.CmsListMetadata)

setMultiActions

protected void setMultiActions(CmsListMetadata metadata)

Description copied from class: A_CmsListDialog

Should add the multi actions to the given list metadata object.

This method will be just executed once, the first time the constructor is called.

Specified by:

setMultiActions in class A_CmsListDialog

Parameters:

metadata - the list metadata

See Also:

A_CmsListDialog.setMultiActions(org.opencms.workplace.list.CmsListMetadata)