org.opencms.workplace.search

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

从以下版本开始:

6.0.0

字段概要

字段

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

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

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

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
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() Initializes the message object.
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.

从类继承的方法 org.opencms.workplace.list.A_CmsListExplorerDialog

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

从类继承的方法 org.opencms.workplace.list.A_CmsListDialog

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

字段详细资料

LIST_COLUMN_SCORE

public static final java.lang.String LIST_COLUMN_SCORE

List column id constant.

另请参阅:

常量字段值

LIST_DETAIL_EXCERPT

public static final java.lang.String LIST_DETAIL_EXCERPT

list item detail id constant.

另请参阅:

常量字段值

LIST_ID

public static final java.lang.String LIST_ID

list id constant.

另请参阅:

常量字段值

PATH_BUTTONS

public static final java.lang.String PATH_BUTTONS

Path to the list buttons.

另请参阅:

常量字段值

构造器详细资料

CmsSearchResultsList

public CmsSearchResultsList(CmsJspActionElement jsp)

Public constructor with JSP action element.

参数:

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.

参数:

context - the JSP page context

req - the JSP request

res - the JSP response

方法详细资料

executeListMultiActions

public void executeListMultiActions()

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

另请参阅:

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

getCollector

public I_CmsListResourceCollector getCollector()

从类复制的说明: A_CmsListExplorerDialog

Returns the collector to use to display the resources.

指定者:

getCollector 在类中 A_CmsListExplorerDialog

返回:

the collector to use to display the resources

另请参阅:

A_CmsListExplorerDialog.getCollector()

defaultActionHtmlStart

protected java.lang.String defaultActionHtmlStart()

Generates the dialog starting html code.

覆盖:

defaultActionHtmlStart 在类中 A_CmsListExplorerDialog

返回:

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)

initMessages

protected void initMessages()

从类复制的说明: CmsWorkplace

Initializes the message object.

By default the CmsWorkplaceMessages are initialized.

You SHOULD override this method for setting the bundles you really need, using the CmsWorkplace.addMessages(CmsMessages) or CmsWorkplace.addMessages(String) method.

覆盖:

initMessages 在类中 CmsWorkplace

另请参阅:

CmsWorkplace.initMessages()

setColumns

protected void setColumns(CmsListMetadata metadata)

从类复制的说明: A_CmsListExplorerDialog

Adds the standard explorer view columns to the list.

覆盖:

setColumns 在类中 A_CmsListExplorerDialog

参数:

metadata - the list metadata

另请参阅:

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

setColumnVisibilities

protected void setColumnVisibilities()

从类复制的说明: A_CmsListExplorerDialog

Sets the default column visibility flags from the user preferences.

覆盖:

setColumnVisibilities 在类中 A_CmsListExplorerDialog

另请参阅:

A_CmsListExplorerDialog.setColumnVisibilities()

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_CmsListExplorerDialog

参数:

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)

validateParamaters

protected void validateParamaters()
                           throws java.lang.Exception

从类复制的说明: A_CmsListDialog

Should be overridden for parameter validation.

覆盖:

validateParamaters 在类中 A_CmsListDialog

抛出:

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

另请参阅:

A_CmsListDialog.validateParamaters()