Package org.opencms.workplace.search

Class CmsSearchResultsList

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.list.A_CmsListExplorerDialog

org.opencms.workplace.search.CmsSearchResultsList

public class CmsSearchResultsList
extends A_CmsListExplorerDialog

Explorer list for the search results.

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	LIST_COLUMN_SCORE	List column id constant.
static java.lang.String	LIST_DETAIL_EXCERPT	list item detail id constant.
static java.lang.String	LIST_ID	list id constant.
static java.lang.String	PATH_BUTTONS	Path to the list buttons.

Fields inherited from class org.opencms.workplace.list.A_CmsListExplorerDialog

LIST_ACTION_EDIT, LIST_ACTION_LOCKICON, LIST_ACTION_PROJSTATEICON, LIST_ACTION_TYPEICON, LIST_COLUMN_DATECREATE, LIST_COLUMN_DATEEXP, LIST_COLUMN_DATELASTMOD, LIST_COLUMN_DATEREL, LIST_COLUMN_EDIT, LIST_COLUMN_LOCKEDBY, LIST_COLUMN_LOCKICON, LIST_COLUMN_NAME, LIST_COLUMN_PERMISSIONS, LIST_COLUMN_PROJSTATEICON, LIST_COLUMN_ROOT_PATH, LIST_COLUMN_SITE, LIST_COLUMN_SIZE, LIST_COLUMN_STATE, LIST_COLUMN_TITLE, LIST_COLUMN_TYPE, LIST_COLUMN_TYPEICON, LIST_COLUMN_USERCREATE, LIST_COLUMN_USERLASTMOD, LIST_DEFACTION_OPEN, PARAM_SHOW_EXPLORER, PATH_EXPLORER_LIST

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
CmsSearchResultsList(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Public constructor with JSP variables.
CmsSearchResultsList(org.opencms.jsp.CmsJspActionElement jsp)	Public constructor with JSP action element.

Method Summary

Modifier and Type	Method	Description
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.
I_CmsListResourceCollector	getCollector()	Returns the collector to use to display the resources.
protected void	initMessages()
protected void	setColumns(CmsListMetadata metadata)	Adds the standard explorer view columns to the list.
protected void	setColumnVisibilities()	Sets the default column visibility flags from the user preferences.
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.
protected void	validateParamaters()	Should be overridden for parameter validation.

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

applyColumnVisibilities, executeListIndepActions, executeSelectPage, fillList, getAdditionalParametersForExplorerForward, getColVisibilities, getListItems, getListStateForCollector, getParamShowexplorer, getProject, getResourceUtil, getResourceUtil, initWorkplaceRequestValues, isColumnVisible, setColumnVisibility, setColVisibilities, setParamShowexplorer

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

actionDialog, customHtmlEnd, customHtmlStart, defaultActionHtml, defaultActionHtmlContent, defaultActionHtmlEnd, displayDialog, displayDialog, executeDefaultActions, executeSearch, executeSort, 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, 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, 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_COLUMN_SCORE

public static final java.lang.String LIST_COLUMN_SCORE

List column id constant.

See Also:

Constant Field Values

LIST_DETAIL_EXCERPT

public static final java.lang.String LIST_DETAIL_EXCERPT

list item detail 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

PATH_BUTTONS

public static final java.lang.String PATH_BUTTONS

Path to the list buttons.

See Also:

Constant Field Values

Constructor Detail

CmsSearchResultsList

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

Public constructor with JSP action element.

Parameters:

jsp - an initialized JSP action element

CmsSearchResultsList

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

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

getCollector

public I_CmsListResourceCollector getCollector()

Description copied from class: A_CmsListExplorerDialog

Returns the collector to use to display the resources.

Specified by:

getCollector in class A_CmsListExplorerDialog

Returns:

the collector to use to display the resources

See Also:

A_CmsListExplorerDialog.getCollector()

defaultActionHtmlStart

protected java.lang.String defaultActionHtmlStart()

Generates the dialog starting html code.

Overrides:

defaultActionHtmlStart in class A_CmsListExplorerDialog

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

initMessages

protected void initMessages()

Overrides:

initMessages in class org.opencms.workplace.CmsWorkplace

See Also:

CmsWorkplace.initMessages()

setColumns

protected void setColumns(CmsListMetadata metadata)

Description copied from class: A_CmsListExplorerDialog

Adds the standard explorer view columns to the list.

Overrides:

setColumns in class A_CmsListExplorerDialog

Parameters:

metadata - the list metadata

See Also:

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

setColumnVisibilities

protected void setColumnVisibilities()

Description copied from class: A_CmsListExplorerDialog

Sets the default column visibility flags from the user preferences.

Overrides:

setColumnVisibilities in class A_CmsListExplorerDialog

See Also:

A_CmsListExplorerDialog.setColumnVisibilities()

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 A_CmsListExplorerDialog

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)

validateParamaters

protected void validateParamaters()
                           throws java.lang.Exception

Description copied from class: A_CmsListDialog

Should be overridden for parameter validation.

Overrides:

validateParamaters in class A_CmsListDialog

Throws:

java.lang.Exception - if the parameters are not valid

See Also:

A_CmsListDialog.validateParamaters()