org.opencms.workplace.comparison
Class CmsAttributeComparisonList

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.comparison.CmsPropertyComparisonList
                      org.opencms.workplace.comparison.CmsAttributeComparisonList

public class CmsAttributeComparisonList
extends CmsPropertyComparisonList

List for property comparison including columns for property name and the values.

Since:

6.0.0

Field Summary

static java.lang.String

AC_LIST_ID List id constant.

Fields inherited from class org.opencms.workplace.comparison.CmsPropertyComparisonList

LIST_ACTION_VIEW1, LIST_ACTION_VIEW2, LIST_COLUMN_ICON, LIST_COLUMN_PROPERTY_NAME, LIST_COLUMN_TYPE, LIST_COLUMN_VERSION_1, LIST_COLUMN_VERSION_2, LIST_DEFACTION_VIEW, LIST_DETAIL_TYPE, LIST_IACTION_SHOW, LIST_ID, PARAM_COMPARE, TRIM_AT_LENGTH

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

Constructor Summary

	CmsAttributeComparisonList(CmsJspActionElement jsp) Public constructor.
	CmsAttributeComparisonList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.
protected	CmsAttributeComparisonList(java.lang.String listId, CmsJspActionElement jsp) Protected constructor.

Method Summary

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 java.util.List<CmsListItem>	getListItems() Should generate a list with the list items to be displayed.
protected java.lang.String	getViewVersionButtonHtml(CmsUUID structureId, java.lang.String version) Returns the html code to display a file version.
protected static CmsFile	readFile(CmsObject cms, CmsUUID structureId, java.lang.String version) Returns either the historical file or the offline file, depending on the version number.
protected void	setIndependentActions(CmsListMetadata metadata) Should add the independent actions to the given list metadata object.

Methods inherited from class org.opencms.workplace.comparison.CmsPropertyComparisonList

executeListMultiActions, fillDetails, getParamId1, getParamId2, getParamVersion1, getParamVersion2, getResource1, getResource2, getResourceType, initWorkplaceRequestValues, setColumns, setMultiActions, setParamId1, setParamId2, setParamVersion1, setParamVersion2

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

actionDialog, customHtmlEnd, customHtmlStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, defaultActionHtmlStart, displayDialog, displayDialog, executeDefaultActions, executeListIndepActions, executeSearch, executeSelectPage, executeSort, fillList, getList, getListId, getListObject, getListState, getMetadata, getMetadata, getParamFormName, getParamListAction, getParamPage, getParamSearchFilter, getParamSelItems, getParamSortCol, getSelectedItem, getSelectedItems, initializeDetail, 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, autoTimeWarp, 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

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

Methods inherited from class java.lang.Object

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

Field Detail

AC_LIST_ID

public static final java.lang.String AC_LIST_ID

List id constant.

See Also:

Constant Field Values

Constructor Detail

CmsAttributeComparisonList

public CmsAttributeComparisonList(CmsJspActionElement jsp)

Public constructor.

Parameters:

jsp - an initialized JSP action element

CmsAttributeComparisonList

public CmsAttributeComparisonList(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 context

req - the JSP request

res - the JSP response

CmsAttributeComparisonList

protected CmsAttributeComparisonList(java.lang.String listId,
                                     CmsJspActionElement jsp)

Protected constructor.

Parameters:

listId - the id of the specialized list

jsp - an initialized JSP action element

Method Detail

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 A_CmsListDialog.getParamListAction() with the id of the action to execute.

Overrides:

executeListSingleActions in class CmsPropertyComparisonList

Throws:

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

See Also:

A_CmsListDialog.executeListSingleActions()

getListItems

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

Description copied from class: A_CmsListDialog

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

Overrides:

getListItems in class CmsPropertyComparisonList

Returns:

a list of CmsListItems

See Also:

A_CmsListDialog.getListItems()

getViewVersionButtonHtml

protected java.lang.String getViewVersionButtonHtml(CmsUUID structureId,
                                                    java.lang.String version)

Returns the html code to display a file version.

Parameters:

structureId - the structure id of the file to be displayed

version - the version of the file to be displayed

Returns:

the html code to display a file version

readFile

protected static CmsFile readFile(CmsObject cms,
                                  CmsUUID structureId,
                                  java.lang.String version)
                           throws CmsException

Returns either the historical file or the offline file, depending on the version number.

Parameters:

cms - the CmsObject to use

structureId - the structure id of the file

version - the historical version number

Returns:

either the historical file or the offline file, depending on the version number

Throws:

CmsException - if something goes wrong

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.

Overrides:

setIndependentActions in class CmsPropertyComparisonList

Parameters:

metadata - the list metadata

See Also:

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