|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.list.A_CmsListDialog
org.opencms.workplace.commons.CmsHistoryList
Displays the history of a file.
Nested Class Summary | |
static class |
CmsHistoryList.CmsVersionWrapper
Wrapper class for the version which is either an integer or the string "offline". |
Field Summary | |
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_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.tools.CmsToolDialog |
PARAM_BASE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW |
Constructor Summary | |
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. |
Method Summary | |
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. |
void |
executeListSingleActions()
This method should handle every defined list single action, by comparing 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 |
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. |
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String GUI_LIST_HISTORY_DETAIL_PROJECT_0
public static final java.lang.String LIST_ACTION_RESTORE
public static final java.lang.String LIST_ACTION_VIEW
public static final java.lang.String LIST_COLUMN_DATE_LAST_MODIFIED
public static final java.lang.String LIST_COLUMN_DATE_PUBLISHED
public static final java.lang.String LIST_COLUMN_FILE_TYPE
public static final java.lang.String LIST_COLUMN_ICON
public static final java.lang.String LIST_COLUMN_PUBLISH_TAG
public static final java.lang.String LIST_COLUMN_RESOURCE_PATH
public static final java.lang.String LIST_COLUMN_RESTORE
public static final java.lang.String LIST_COLUMN_SEL1
public static final java.lang.String LIST_COLUMN_SEL2
public static final java.lang.String LIST_COLUMN_SIZE
public static final java.lang.String LIST_COLUMN_STRUCTURE_ID
public static final java.lang.String LIST_COLUMN_USER
public static final java.lang.String LIST_COLUMN_VERSION
public static final java.lang.String LIST_COLUMN_VIEW
public static final java.lang.String LIST_ID
public static final java.lang.String LIST_RACTION_SEL1
public static final java.lang.String LIST_RACTION_SEL2
public static final java.lang.String PARAM_ID_1
public static final java.lang.String PARAM_ID_2
public static final java.lang.String PARAM_VERSION_1
public static final java.lang.String PARAM_VERSION_2
public static final java.lang.String PATH_BUTTONS
Constructor Detail |
public CmsHistoryList(CmsJspActionElement jsp)
jsp
- an initialized JSP action elementpublic CmsHistoryList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
context
- the JSP page contextreq
- the JSP requestres
- the JSP responseMethod Detail |
public static java.lang.String getHistoryLink(CmsObject cms, CmsUUID structureId, java.lang.String version)
cms
- the cms contextstructureId
- the structure id of the fileversion
- the version number of the file
public static java.lang.String getDisplayVersion(java.lang.String version, java.util.Locale locale)
version
- might be negative for the online versionlocale
- if the result is for display purposes, the locale has to be != null
public static int getVersion(java.lang.String version)
version
- might be negative for the online version
public void executeListMultiActions() throws java.io.IOException, javax.servlet.ServletException
A_CmsListDialog
A_CmsListDialog.getParamListAction()
with the id
of the action to execute.
executeListMultiActions
in class A_CmsListDialog
javax.servlet.ServletException
- in case of errors when including a required sub-element
java.io.IOException
- in case of errors when including a required sub-elementA_CmsListDialog.executeListMultiActions()
public void executeListSingleActions() throws java.io.IOException, javax.servlet.ServletException
A_CmsListDialog
A_CmsListDialog.getParamListAction()
with the id
of the action to execute.
executeListSingleActions
in class 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-elementA_CmsListDialog.executeListSingleActions()
protected java.lang.String defaultActionHtmlStart()
A_CmsListDialog
defaultActionHtmlStart
in class A_CmsListDialog
A_CmsListDialog.defaultActionHtmlStart()
protected void fillDetails(java.lang.String detailId)
A_CmsListDialog
Should fill the given detail column for every list item in
Should not throw any kind of exception.CmsHtmlList.getContent()
fillDetails
in class A_CmsListDialog
detailId
- the id of the detail to initializeA_CmsListDialog.fillDetails(java.lang.String)
protected java.util.List getListItems() throws CmsException
A_CmsListDialog
getListItems
in class A_CmsListDialog
CmsListItem
s
CmsException
- if something goes wrongA_CmsListDialog.getListItems()
protected void performRestoreOperation() throws CmsException
CmsException
- if something goes wrongprotected void setColumns(CmsListMetadata metadata)
A_CmsListDialog
This method will be just executed once, the first time the constructor is called.
setColumns
in class A_CmsListDialog
metadata
- the list metadataA_CmsListDialog.setColumns(org.opencms.workplace.list.CmsListMetadata)
protected void setIndependentActions(CmsListMetadata metadata)
A_CmsListDialog
This method will be just executed once, the first time the constructor is called.
setIndependentActions
in class A_CmsListDialog
metadata
- the list metadataA_CmsListDialog.setIndependentActions(org.opencms.workplace.list.CmsListMetadata)
protected void setMultiActions(CmsListMetadata metadata)
A_CmsListDialog
This method will be just executed once, the first time the constructor is called.
setMultiActions
in class A_CmsListDialog
metadata
- the list metadataA_CmsListDialog.setMultiActions(org.opencms.workplace.list.CmsListMetadata)
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |