org.opencms.workplace.commons

类 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.

从以下版本开始:

6.0.2

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	CmsHistoryList.CmsVersionWrapper Wrapper class for the version which is either an integer or the string "offline".

字段概要

字段

限定符和类型	字段和说明
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.

从类继承的字段 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, m_lazy, PARAM_FORMNAME, PARAM_LIST_ACTION, PARAM_PAGE, PARAM_SEARCH_FILTER, PARAM_SEL_ITEMS, PARAM_SORT_COL

从类继承的字段 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

从类继承的字段 org.opencms.workplace.tools.CmsToolDialog

PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

从类继承的字段 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, 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_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_DIRECT_EDIT, VIEW_WORKPLACE

构造器概要

构造器

构造器和说明
CmsHistoryList(CmsJspActionElement jsp) Public constructor.
CmsHistoryList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.

方法概要

方法

限定符和类型	方法和说明
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 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(java.lang.String detailId) Lazy initialization for detail data.
static java.lang.String	getDisplayVersion(java.lang.String version, java.util.Locale locale) Returns the version number from a version parameter.
static java.lang.String	getHistoryLink(CmsObject cms, CmsUUID structureId, java.lang.String version) Returns the link to an historical file.
protected java.util.List<CmsListItem>	getListItems() Should generate a list with the list items to be displayed.
static int	getVersion(java.lang.String version) Returns the version number from a version parameter.
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.

从类继承的方法 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, 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

从类继承的方法 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

从类继承的方法 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

从类继承的方法 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, getStartSiteRoot, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, switchToCurrentProject, switchToTempProject

从类继承的方法 java.lang.Object

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

字段详细资料

GUI_LIST_HISTORY_DETAIL_PROJECT_0

public static final java.lang.String GUI_LIST_HISTORY_DETAIL_PROJECT_0

list item detail id constant.

另请参阅:

常量字段值

LIST_ACTION_RESTORE

public static final java.lang.String LIST_ACTION_RESTORE

List action export.

另请参阅:

常量字段值

LIST_ACTION_VIEW

public static final java.lang.String LIST_ACTION_VIEW

list action id constant.

另请参阅:

常量字段值

LIST_COLUMN_DATE_LAST_MODIFIED

public static final java.lang.String LIST_COLUMN_DATE_LAST_MODIFIED

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_DATE_PUBLISHED

public static final java.lang.String LIST_COLUMN_DATE_PUBLISHED

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_FILE_TYPE

public static final java.lang.String LIST_COLUMN_FILE_TYPE

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_ICON

public static final java.lang.String LIST_COLUMN_ICON

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_PUBLISH_TAG

public static final java.lang.String LIST_COLUMN_PUBLISH_TAG

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_RESOURCE_PATH

public static final java.lang.String LIST_COLUMN_RESOURCE_PATH

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_RESTORE

public static final java.lang.String LIST_COLUMN_RESTORE

List column delete.

另请参阅:

常量字段值

LIST_COLUMN_SEL1

public static final java.lang.String LIST_COLUMN_SEL1

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_SEL2

public static final java.lang.String LIST_COLUMN_SEL2

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_SIZE

public static final java.lang.String LIST_COLUMN_SIZE

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_STRUCTURE_ID

public static final java.lang.String LIST_COLUMN_STRUCTURE_ID

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_USER

public static final java.lang.String LIST_COLUMN_USER

List column export.

另请参阅:

常量字段值

LIST_COLUMN_VERSION

public static final java.lang.String LIST_COLUMN_VERSION

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_VERSION_ENABLE

public static final java.lang.String LIST_COLUMN_VERSION_ENABLE

list column id constant.

另请参阅:

常量字段值

LIST_COLUMN_VIEW

public static final java.lang.String LIST_COLUMN_VIEW

List column export.

另请参阅:

常量字段值

LIST_ID

public static final java.lang.String LIST_ID

list id constant.

另请参阅:

常量字段值

LIST_RACTION_SEL1

public static final java.lang.String LIST_RACTION_SEL1

list independent action id constant.

另请参阅:

常量字段值

LIST_RACTION_SEL2

public static final java.lang.String LIST_RACTION_SEL2

list independent action id constant.

另请参阅:

常量字段值

PARAM_ID_1

public static final java.lang.String PARAM_ID_1

parameter for the path of the first resource.

另请参阅:

常量字段值

PARAM_ID_2

public static final java.lang.String PARAM_ID_2

parameter for the path of the second resource.

另请参阅:

常量字段值

PARAM_VERSION_1

public static final java.lang.String PARAM_VERSION_1

parameter for the version of the first resource.

另请参阅:

常量字段值

PARAM_VERSION_2

public static final java.lang.String PARAM_VERSION_2

parameter for the version of the second resource.

另请参阅:

常量字段值

PATH_BUTTONS

public static final java.lang.String PATH_BUTTONS

Path to the list buttons.

另请参阅:

常量字段值

构造器详细资料

CmsHistoryList

public CmsHistoryList(CmsJspActionElement jsp)

Public constructor.

参数:

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.

参数:

context - the JSP page context

req - the JSP request

res - the JSP response

方法详细资料

getDisplayVersion

public static java.lang.String getDisplayVersion(java.lang.String version,
                                 java.util.Locale locale)

Returns the version number from a version parameter.

参数:

version - might be negative for the online version

locale - if the result is for display purposes, the locale has to be != null

返回:

the display name

getHistoryLink

public static java.lang.String getHistoryLink(CmsObject cms,
                              CmsUUID structureId,
                              java.lang.String version)

Returns the link to an historical file.

参数:

cms - the cms context

structureId - the structure id of the file

version - the version number of the file

返回:

the link to an historical file

getVersion

public static int getVersion(java.lang.String version)

Returns the version number from a version parameter.

参数:

version - might be negative for the online version

返回:

the positive value

actionDialog

public void actionDialog()
                  throws javax.servlet.jsp.JspException,
                         javax.servlet.ServletException,
                         java.io.IOException

从类复制的说明: A_CmsListDialog

Performs the dialog actions depending on the initialized action.

覆盖:

actionDialog 在类中 A_CmsListDialog

抛出:

javax.servlet.jsp.JspException - if dialog actions fail

javax.servlet.ServletException - in case of errors forwarding to the required result page

java.io.IOException - in case of errors forwarding to the required result page

另请参阅:

A_CmsListDialog.actionDialog()

executeListMultiActions

public void executeListMultiActions()
                             throws java.io.IOException,
                                    javax.servlet.ServletException

从类复制的说明: A_CmsListDialog

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

指定者:

executeListMultiActions 在类中 A_CmsListDialog

抛出:

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

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

另请参阅:

A_CmsListDialog.executeListMultiActions()

executeListSingleActions

public void executeListSingleActions()
                              throws java.io.IOException,
                                     javax.servlet.ServletException

从类复制的说明: A_CmsListDialog

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

指定者:

executeListSingleActions 在类中 A_CmsListDialog

抛出:

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

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

另请参阅:

A_CmsListDialog.executeListSingleActions()

defaultActionHtmlStart

protected java.lang.String defaultActionHtmlStart()

从类复制的说明: A_CmsListDialog

Generates the dialog starting html code.

覆盖:

defaultActionHtmlStart 在类中 A_CmsListDialog

返回:

html code

另请参阅:

A_CmsListDialog.defaultActionHtmlStart()

fillDetails

protected void fillDetails(java.lang.String detailId)

从类复制的说明: A_CmsListDialog

Lazy initialization for detail data.

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

指定者:

fillDetails 在类中 A_CmsListDialog

参数:

detailId - the id of the detail to initialize

另请参阅:

A_CmsListDialog.fillDetails(java.lang.String)

getListItems

protected java.util.List<CmsListItem> getListItems()
                                            throws CmsException

从类复制的说明: A_CmsListDialog

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

指定者:

getListItems 在类中 A_CmsListDialog

返回:

a list of CmsListItems

抛出:

CmsException - if something goes wrong

另请参阅:

A_CmsListDialog.getListItems()

performRestoreOperation

protected void performRestoreOperation()
                                throws CmsException

Restores a backed up resource version.

抛出:

CmsException - if something goes wrong

setColumns

protected void setColumns(CmsListMetadata metadata)

从类复制的说明: 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.

指定者:

setColumns 在类中 A_CmsListDialog

参数:

metadata - the list metadata

另请参阅:

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

setIndependentActions

protected void setIndependentActions(CmsListMetadata metadata)

从类复制的说明: 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.

指定者:

setIndependentActions 在类中 A_CmsListDialog

参数:

metadata - the list metadata

另请参阅:

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

setMultiActions

protected void setMultiActions(CmsListMetadata metadata)

从类复制的说明: 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.

指定者:

setMultiActions 在类中 A_CmsListDialog

参数:

metadata - the list metadata

另请参阅:

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