org.opencms.workplace.help

类 CmsHelpSearchResultView

java.lang.Object

org.opencms.workplace.help.CmsHelpSearchResultView

public class CmsHelpSearchResultView
extends java.lang.Object

Displays the result of a CmsSearch.

Requires the following request parameters (see constructor):

• index:
  the String identifying the required search index.
• query:
  the search query to run.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
protected CmsProject	m_offlineProject The project that forces evaluation of all dynamic content.
protected CmsProject	m_onlineProject The project that allows static export.

构造器概要

构造器

构造器和说明
CmsHelpSearchResultView(CmsJspActionElement action) Constructor with the action element to use.
CmsHelpSearchResultView(javax.servlet.jsp.PageContext pageContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Constructor with arguments for construction of a CmsJspActionElement.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	displaySearchResult(CmsSearch search) Returns the formatted search results.
boolean	isExportLinks() Returns true if the links to search results shall point to exported content, false else.
void	setExportLinks(boolean exportLinks) Set wether the links to search results point to exported content or not.
void	setSearchRessourceUrl(java.lang.String uri) Set a proprietary resource uri for the search page.

从类继承的方法 java.lang.Object

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

字段详细资料

m_offlineProject

protected CmsProject m_offlineProject

The project that forces evaluation of all dynamic content.

m_onlineProject

protected CmsProject m_onlineProject

The project that allows static export.

构造器详细资料

CmsHelpSearchResultView

public CmsHelpSearchResultView(CmsJspActionElement action)

Constructor with the action element to use.

参数:

action - the action element to use

CmsHelpSearchResultView

public CmsHelpSearchResultView(javax.servlet.jsp.PageContext pageContext,
                       javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)

Constructor with arguments for construction of a CmsJspActionElement.

参数:

pageContext - the page context to use

request - the current request

response - the current response

方法详细资料

displaySearchResult

public java.lang.String displaySearchResult(CmsSearch search)

Returns the formatted search results.

参数:

search - the preconfigured search bean

返回:

the formatted search results

isExportLinks

public boolean isExportLinks()

Returns true if the links to search results shall point to exported content, false else.

返回:

true if the links to search results shall point to exported content, false else

setExportLinks

public void setExportLinks(boolean exportLinks)

Set wether the links to search results point to exported content or not.

参数:

exportLinks - The value that decides Set wether the links to search results point to exported content or not.

setSearchRessourceUrl

public void setSearchRessourceUrl(java.lang.String uri)

Set a proprietary resource uri for the search page.

This is optional but allows to override the standard search result links (for next or previous pages) that point to getJsp().getRequestContext().getUri() whenever the search uri is element of some template and should not be linked directly.

参数:

uri - the proprietary resource uri for the search page