Package 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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CmsHistoryList.CmsVersionWrapper
Wrapper class for the version which is either an integer or the string "offline".
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
GUI_LIST_HISTORY_DETAIL_PROJECT_0
list item detail id constant.static java.lang.String
LIST_ACTION_RESTORE
List action export.static java.lang.String
LIST_ACTION_VIEW
list action id constant.static java.lang.String
LIST_COLUMN_DATE_LAST_MODIFIED
list column id constant.static java.lang.String
LIST_COLUMN_DATE_PUBLISHED
list column id constant.static java.lang.String
LIST_COLUMN_FILE_TYPE
list column id constant.static java.lang.String
LIST_COLUMN_ICON
list column id constant.static java.lang.String
LIST_COLUMN_PUBLISH_TAG
list column id constant.static java.lang.String
LIST_COLUMN_RESOURCE_PATH
list column id constant.static java.lang.String
LIST_COLUMN_RESTORE
List column delete.static java.lang.String
LIST_COLUMN_SEL1
list column id constant.static java.lang.String
LIST_COLUMN_SEL2
list column id constant.static java.lang.String
LIST_COLUMN_SIZE
list column id constant.static java.lang.String
LIST_COLUMN_STRUCTURE_ID
list column id constant.static java.lang.String
LIST_COLUMN_USER
List column export.static java.lang.String
LIST_COLUMN_VERSION
list column id constant.static java.lang.String
LIST_COLUMN_VERSION_ENABLE
list column id constant.static java.lang.String
LIST_COLUMN_VIEW
List column export.static java.lang.String
LIST_ID
list id constant.static java.lang.String
LIST_RACTION_SEL1
list independent action id constant.static java.lang.String
LIST_RACTION_SEL2
list independent action id constant.static java.lang.String
PARAM_ID_1
parameter for the path of the first resource.static java.lang.String
PARAM_ID_2
parameter for the path of the second resource.static java.lang.String
PARAM_VERSION_1
parameter for the version of the first resource.static java.lang.String
PARAM_VERSION_2
parameter for the version of the second resource.static java.lang.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, KEY_META_DATA_CACHE, LIST_INDEPENDENT_ACTION, LIST_MULTI_ACTION, LIST_SEARCH, LIST_SELECT_PAGE, LIST_SINGLE_ACTION, LIST_SORT, m_lazy, 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_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 CmsHistoryList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables.CmsHistoryList(org.opencms.jsp.CmsJspActionElement jsp)
Public constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
actionDialog()
Performs the dialog actions depending on the initialized action.protected java.lang.String
defaultActionHtmlStart()
Generates the dialog starting html code.void
executeListMultiActions()
This method should handle every defined list multi action, by comparing
with the id of the action to execute.A_CmsListDialog.getParamListAction()
void
executeListSingleActions()
This method should handle every defined list single action, by comparing
with the id of the action to execute.A_CmsListDialog.getParamListAction()
protected void
fillDetails(java.lang.String detailId)
Lazy initialization for detail data.protected java.util.List<CmsListItem>
getListItems()
Should generate a list with the list items to be displayed.protected void
performRestoreOperation()
Restores a backed up resource version.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
customHtmlEnd, customHtmlStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, displayDialog, displayDialog, executeDefaultActions, executeListIndepActions, executeSearch, executeSelectPage, executeSort, fillList, getList, getListId, getListObject, getListState, getMetadata, getMetadata, getMetadataCache, getParamFormName, getParamListAction, getParamPage, getParamSearchFilter, getParamSelItems, getParamSortCol, getSelectedItem, getSelectedItems, initializeDetail, 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, 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
-
-
-
-
Field Detail
-
GUI_LIST_HISTORY_DETAIL_PROJECT_0
public static final java.lang.String GUI_LIST_HISTORY_DETAIL_PROJECT_0
list item detail id constant.- See Also:
- Constant Field Values
-
LIST_ACTION_RESTORE
public static final java.lang.String LIST_ACTION_RESTORE
List action export.- See Also:
- Constant Field Values
-
LIST_ACTION_VIEW
public static final java.lang.String LIST_ACTION_VIEW
list action id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_DATE_LAST_MODIFIED
public static final java.lang.String LIST_COLUMN_DATE_LAST_MODIFIED
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_DATE_PUBLISHED
public static final java.lang.String LIST_COLUMN_DATE_PUBLISHED
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_FILE_TYPE
public static final java.lang.String LIST_COLUMN_FILE_TYPE
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_ICON
public static final java.lang.String LIST_COLUMN_ICON
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_PUBLISH_TAG
public static final java.lang.String LIST_COLUMN_PUBLISH_TAG
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_RESOURCE_PATH
public static final java.lang.String LIST_COLUMN_RESOURCE_PATH
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_RESTORE
public static final java.lang.String LIST_COLUMN_RESTORE
List column delete.- See Also:
- Constant Field Values
-
LIST_COLUMN_SEL1
public static final java.lang.String LIST_COLUMN_SEL1
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_SEL2
public static final java.lang.String LIST_COLUMN_SEL2
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_SIZE
public static final java.lang.String LIST_COLUMN_SIZE
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_STRUCTURE_ID
public static final java.lang.String LIST_COLUMN_STRUCTURE_ID
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_USER
public static final java.lang.String LIST_COLUMN_USER
List column export.- See Also:
- Constant Field Values
-
LIST_COLUMN_VERSION
public static final java.lang.String LIST_COLUMN_VERSION
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_VERSION_ENABLE
public static final java.lang.String LIST_COLUMN_VERSION_ENABLE
list column id constant.- See Also:
- Constant Field Values
-
LIST_COLUMN_VIEW
public static final java.lang.String LIST_COLUMN_VIEW
List column export.- See Also:
- Constant Field Values
-
LIST_ID
public static final java.lang.String LIST_ID
list id constant.- See Also:
- Constant Field Values
-
LIST_RACTION_SEL1
public static final java.lang.String LIST_RACTION_SEL1
list independent action id constant.- See Also:
- Constant Field Values
-
LIST_RACTION_SEL2
public static final java.lang.String LIST_RACTION_SEL2
list independent action id constant.- See Also:
- Constant Field Values
-
PARAM_ID_1
public static final java.lang.String PARAM_ID_1
parameter for the path of the first resource.- See Also:
- Constant Field Values
-
PARAM_ID_2
public static final java.lang.String PARAM_ID_2
parameter for the path of the second resource.- See Also:
- Constant Field Values
-
PARAM_VERSION_1
public static final java.lang.String PARAM_VERSION_1
parameter for the version of the first resource.- See Also:
- Constant Field Values
-
PARAM_VERSION_2
public static final java.lang.String PARAM_VERSION_2
parameter for the version of the second resource.- See Also:
- Constant Field Values
-
PATH_BUTTONS
public static final java.lang.String PATH_BUTTONS
Path to the list buttons.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsHistoryList
public CmsHistoryList(org.opencms.jsp.CmsJspActionElement jsp)
Public constructor.- Parameters:
jsp
- an initialized JSP action element
-
CmsHistoryList
public CmsHistoryList(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 contextreq
- the JSP requestres
- the JSP response
-
-
Method Detail
-
actionDialog
public void actionDialog() throws javax.servlet.jsp.JspException, javax.servlet.ServletException, java.io.IOException
Description copied from class:A_CmsListDialog
Performs the dialog actions depending on the initialized action.- Overrides:
actionDialog
in classA_CmsListDialog
- Throws:
javax.servlet.jsp.JspException
- if dialog actions failjavax.servlet.ServletException
- in case of errors forwarding to the required result pagejava.io.IOException
- in case of errors forwarding to the required result page- See Also:
A_CmsListDialog.actionDialog()
-
executeListMultiActions
public void executeListMultiActions() throws java.io.IOException, javax.servlet.ServletException
Description copied from class:A_CmsListDialog
This method should handle every defined list multi action, by comparing
with the id of the action to execute.A_CmsListDialog.getParamListAction()
- Specified by:
executeListMultiActions
in classA_CmsListDialog
- Throws:
java.io.IOException
- in case of errors when including a required sub-elementjavax.servlet.ServletException
- in case of errors when including a required sub-element- See Also:
A_CmsListDialog.executeListMultiActions()
-
executeListSingleActions
public void executeListSingleActions() throws java.io.IOException, javax.servlet.ServletException
Description copied from class:A_CmsListDialog
This method should handle every defined list single action, by comparing
with the id of the action to execute.A_CmsListDialog.getParamListAction()
- Specified by:
executeListSingleActions
in classA_CmsListDialog
- Throws:
java.io.IOException
- in case of errors when including a required sub-elementjavax.servlet.ServletException
- in case of errors when including a required sub-element- See Also:
A_CmsListDialog.executeListSingleActions()
-
defaultActionHtmlStart
protected java.lang.String defaultActionHtmlStart()
Description copied from class:A_CmsListDialog
Generates the dialog starting html code.- Overrides:
defaultActionHtmlStart
in classA_CmsListDialog
- Returns:
- html code
- See Also:
A_CmsListDialog.defaultActionHtmlStart()
-
fillDetails
protected void fillDetails(java.lang.String detailId)
Description copied from class:A_CmsListDialog
Lazy initialization for detail data.Should fill the given detail column for every list item in
Should not throw any kind of exception.CmsHtmlList.getContent()
- Specified by:
fillDetails
in classA_CmsListDialog
- Parameters:
detailId
- the id of the detail to initialize- See Also:
A_CmsListDialog.fillDetails(java.lang.String)
-
getListItems
protected java.util.List<CmsListItem> getListItems() throws org.opencms.main.CmsException
Description copied from class:A_CmsListDialog
Should generate a list with the list items to be displayed.- Specified by:
getListItems
in classA_CmsListDialog
- Returns:
- a list of
sCmsListItem
- Throws:
org.opencms.main.CmsException
- if something goes wrong- See Also:
A_CmsListDialog.getListItems()
-
performRestoreOperation
protected void performRestoreOperation() throws org.opencms.main.CmsException
Restores a backed up resource version.- Throws:
org.opencms.main.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 classA_CmsListDialog
- Parameters:
metadata
- the list metadata- See Also:
A_CmsListDialog.setColumns(org.opencms.workplace.list.CmsListMetadata)
-
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 classA_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 classA_CmsListDialog
- Parameters:
metadata
- the list metadata- See Also:
A_CmsListDialog.setMultiActions(org.opencms.workplace.list.CmsListMetadata)
-
-