Package org.opencms.workplace.comparison

Class CmsPropertyComparisonList

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

Direct Known Subclasses:

CmsAttributeComparisonList

public class CmsPropertyComparisonList
extends A_CmsListDialog

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

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	LIST_ACTION_VIEW1	view first file action constant.
static java.lang.String	LIST_ACTION_VIEW2	view second file action constant.
static java.lang.String	LIST_COLUMN_ICON	list action id constant.
static java.lang.String	LIST_COLUMN_PROPERTY_NAME	list column id constant.
static java.lang.String	LIST_COLUMN_TYPE	list action id constant.
static java.lang.String	LIST_COLUMN_VERSION_1	list column id constant.
static java.lang.String	LIST_COLUMN_VERSION_2	list column id constant.
static java.lang.String	LIST_DEFACTION_VIEW	list default action id constant.
static java.lang.String	LIST_DETAIL_TYPE	list independent action id constant.
static java.lang.String	LIST_IACTION_SHOW	list independent action id constant.
static java.lang.String	LIST_ID	List id constant.
static java.lang.String	PARAM_COMPARE	request parameter indicating whether attributes, elements or properties are compared.
protected static int	TRIM_AT_LENGTH	The maximum length of properties and attributes to be displayed.

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

Modifier	Constructor	Description
protected	CmsPropertyComparisonList(java.lang.String listId, org.opencms.jsp.CmsJspActionElement jsp)	Protected constructor.
	CmsPropertyComparisonList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Public constructor with JSP variables.
	CmsPropertyComparisonList(org.opencms.jsp.CmsJspActionElement jsp)	Public constructor.
protected	CmsPropertyComparisonList(org.opencms.jsp.CmsJspActionElement jsp, java.lang.String listId, org.opencms.i18n.CmsMessageContainer listName, java.lang.String sortedColId, CmsListOrderEnum sortOrder, java.lang.String searchableColId)	Public constructor.

Method Summary

Modifier and Type	Method	Description
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.
protected java.util.List<CmsListItem>	getListItems()	Should generate a list with the list items to be displayed.
java.lang.String	getParamId1()	Returns the paramId1.
java.lang.String	getParamId2()	Returns the paramId2.
java.lang.String	getParamVersion1()	Returns the paramNewversionid.
java.lang.String	getParamVersion2()	Returns the paramOldversionid.
org.opencms.file.CmsResource	getResource1()	Returns the resource 1.
org.opencms.file.CmsResource	getResource2()	Returns the resource 2.
int	getResourceType()	Returns the resourceType.
protected void	initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
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.
void	setParamId1(java.lang.String paramId1)	Sets the paramId1.
void	setParamId2(java.lang.String paramId2)	Sets the paramId2.
void	setParamVersion1(java.lang.String paramNewversionid)	Sets the paramNewversionid.
void	setParamVersion2(java.lang.String paramOldversionid)	Sets the paramOldversionid.

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

Methods inherited from class java.lang.Object

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

Field Detail

LIST_ACTION_VIEW1

public static final java.lang.String LIST_ACTION_VIEW1

view first file action constant.

See Also:

Constant Field Values

LIST_ACTION_VIEW2

public static final java.lang.String LIST_ACTION_VIEW2

view second file action constant.

See Also:

Constant Field Values

LIST_COLUMN_ICON

public static final java.lang.String LIST_COLUMN_ICON

list action id constant.

See Also:

Constant Field Values

LIST_COLUMN_PROPERTY_NAME

public static final java.lang.String LIST_COLUMN_PROPERTY_NAME

list column id constant.

See Also:

Constant Field Values

LIST_COLUMN_TYPE

public static final java.lang.String LIST_COLUMN_TYPE

list action id constant.

See Also:

Constant Field Values

LIST_COLUMN_VERSION_1

public static final java.lang.String LIST_COLUMN_VERSION_1

list column id constant.

See Also:

Constant Field Values

LIST_COLUMN_VERSION_2

public static final java.lang.String LIST_COLUMN_VERSION_2

list column id constant.

See Also:

Constant Field Values

LIST_DEFACTION_VIEW

public static final java.lang.String LIST_DEFACTION_VIEW

list default action id constant.

See Also:

Constant Field Values

LIST_DETAIL_TYPE

public static final java.lang.String LIST_DETAIL_TYPE

list independent action id constant.

See Also:

Constant Field Values

LIST_IACTION_SHOW

public static final java.lang.String LIST_IACTION_SHOW

list independent action id constant.

See Also:

Constant Field Values

LIST_ID

public static final java.lang.String LIST_ID

List id constant.

See Also:

Constant Field Values

PARAM_COMPARE

public static final java.lang.String PARAM_COMPARE

request parameter indicating whether attributes, elements or properties are compared.

See Also:

Constant Field Values

TRIM_AT_LENGTH

protected static final int TRIM_AT_LENGTH

The maximum length of properties and attributes to be displayed.

See Also:

Constant Field Values

Constructor Detail

CmsPropertyComparisonList

public CmsPropertyComparisonList(org.opencms.jsp.CmsJspActionElement jsp)

Public constructor.

Parameters:

jsp - an initialized JSP action element

CmsPropertyComparisonList

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

CmsPropertyComparisonList

protected CmsPropertyComparisonList(org.opencms.jsp.CmsJspActionElement jsp,
                                    java.lang.String listId,
                                    org.opencms.i18n.CmsMessageContainer listName,
                                    java.lang.String sortedColId,
                                    CmsListOrderEnum sortOrder,
                                    java.lang.String searchableColId)

Public constructor.

Parameters:

jsp - an initialized JSP action element

listId - the id of the displayed list

listName - the name of the list

sortedColId - the a priory sorted column

sortOrder - the order of the sorted column

searchableColId - the column to search into

CmsPropertyComparisonList

protected CmsPropertyComparisonList(java.lang.String listId,
                                    org.opencms.jsp.CmsJspActionElement jsp)

Protected constructor.

Parameters:

listId - the id of the specialized list

jsp - an initialized JSP action element

Method Detail

executeListMultiActions

public void executeListMultiActions()

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

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

Specified by:

executeListSingleActions in class A_CmsListDialog

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()

getParamId1

public java.lang.String getParamId1()

Returns the paramId1.

Returns:

the paramId1

getParamId2

public java.lang.String getParamId2()

Returns the paramId2.

Returns:

the paramId2

getParamVersion1

public java.lang.String getParamVersion1()

Returns the paramNewversionid.

Returns:

the paramNewversionid

getParamVersion2

public java.lang.String getParamVersion2()

Returns the paramOldversionid.

Returns:

the paramOldversionid

getResource1

public org.opencms.file.CmsResource getResource1()

Returns the resource 1.

Returns:

the resource 1

getResource2

public org.opencms.file.CmsResource getResource2()

Returns the resource 2.

Returns:

the resource 2

getResourceType

public int getResourceType()

Returns the resourceType.

Returns:

the resourceType

setParamId1

public void setParamId1(java.lang.String paramId1)

Sets the paramId1.

Parameters:

paramId1 - the paramId1 to set

setParamId2

public void setParamId2(java.lang.String paramId2)

Sets the paramId2.

Parameters:

paramId2 - the paramId2 to set

setParamVersion1

public void setParamVersion1(java.lang.String paramNewversionid)

Sets the paramNewversionid.

Parameters:

paramNewversionid - the paramNewversionid to set

setParamVersion2

public void setParamVersion2(java.lang.String paramOldversionid)

Sets the paramOldversionid.

Parameters:

paramOldversionid - the paramOldversionid to set

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 CmsHtmlList.getContent() 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 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 class A_CmsListDialog

Returns:

a list of CmsListItems

Throws:

org.opencms.main.CmsException - if something goes wrong

See Also:

A_CmsListDialog.getListItems()

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings,
                                          javax.servlet.http.HttpServletRequest request)

Overrides:

initWorkplaceRequestValues in class A_CmsListDialog

See Also:

CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

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)

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)