SearchContainer的用法说明

SearchContainer的用法说明
在Liferay中，列表通常是使用SearchContainer来实现的，如BBS的栏目列表等。在Liferay的源代码中，JSP夹杂了大量的本应在Action中实现的代码，因此导致很难看懂。我尝试写一个Portlet，结果就在JSP处耗费了很长时间。

在此简单总结一下SearchContainer的用法，内容有些不恰当。具体可参考message_boards/view.jsp中的代码。

1.1 概述
作为一个条目的列表，应该包括几个方面的内容：

l         Table的标题行

l         Table的内容

l         每一个条目允许的操作

l         分页

1.2 Table的标题行（不同的liferay版本可能有所不同，但实质是一样的）
标题行相对比较简单，核心代码如下：

List headerNames = new ArrayList();

headerNames.add("news.column");

headerNames.add("news.columndescript");

headerNames.add("news.childcolumns");

headerNames.add(StringPool.BLANK);

其中注意两点：

1、  每个标题，应该是i18n的资源，需要在资源文件language.properties中添加内容。

2、  最后一行，是用来显示可能的操作按钮的，不需要标题行。

1.3 创建SearchContainer
根据这个headerNames来创建SearchContainer。

首先需要生成一个PortletURL对象，并包括必要的参数

PortletURL portletURL = res.createRenderURL();

portletURL.setParameter("struts_action", "/ext/news/columnadmin/view");

portletURL.setParameter("columnId", columnId);

如果页面是分为多个Tab的，还需要将Tab也添加进去。

然后就可以创建SearchContainer

SearchContainer searchContainer = new SearchContainer(req, null, null,"column",

SearchContainer.DEFAULT_DELTA, portletURL,headerNames, null);

检查源代码，SearchContainer函数的定义为

SearchContainer(
RenderRequest req,         //javax.portlet.RenderRequest
DisplayTerms displayTerms,   //具体意义还不是很清楚，一般设置为null
DisplayTerms searchTerms,     //具体意义还不是很清楚，一般设置为null
String curParam,    //当前操作的列表，如果某个JSP页面中有两个列表需要分页，则此参数可以分别设置为“cur1”和“cur2”，暂时没发现有什么影响
int delta,      //设置每页显示的记录数，默认的是20，可以修改此设置
PortletURL iteratorURL,    //设置被循环的每条记录的操作URL
List headerNames,   //设置表头信息
String emptyResultsMessage   //当查询结果为空时，即数据库中无数据供列表显示时所显示的内容，如果设置为null,则列表表头也不显示出来，也可以设置为“暂无数据”等
)

这一步同创建headerNames应该是可以互换的，用searchContainer.setHeaderNames()即可。

1.4 Table的内容
主要由几个小步骤完成

1.4.1 设置总条数
searchContainer.setTotal(total);
1.4.2 直接设置查询结果
searchContainer.setResults(results)
变量是一个List，其中的每一个对象将会被用到下一个设置可执行操作的JSP中。
1.4.3 设置Table的显示条目
List resultRows = searchContainer.getResultRows();

for (int i = 0; i < results.size(); i++) {

       NewsColumn cutColumn = (NewsColumn) results.get(i);

       // 生成新的一个显示行

ResultRow row = new ResultRow(cutColumn, cutColumn.getPrimaryKey() .toString(), i);

       // 设置URL

       PortletURL rowURL = res.createRenderURL();

       rowURL.setWindowState(WindowState.MAXIMIZED);

       rowURL.setParameter("struts_action", "/ext/news/columnadmin/view");

       rowURL.setParameter("columnId", cutColumn.getColumnId());

       // 设置每一列的显示内容

       row.addText(cutColumn.getName(), rowURL);

       row.addText(cutColumn.getDescription(), rowURL);

       row.addText(childCount), rowURL);

       // 设置每一个条目的可用操作

       row.addJSP("right", SearchEntry.DEFAULT_VALIGN, "*.jsp");

resultRows.add(row);

}

1.5 每一个条目允许的操作
通过row.addJSP("right", SearchEntry.DEFAULT_VALIGN, "column_action.jsp")来调用JSP显示相应的操作。

在JSP中，通过下面的语句能够获取当前条目的 model 对象

ResultRow row = (ResultRow)request.getAttribute(WebKeys.SEARCH_CONTAINER_RESULT_ROW);

MBCategory category = (MBCategory)row.getObject();

拿到model之后，通过<c:if test="<%= MBCategoryPermission.contains 方式判断权限，如果允许操作，则首先生成相应的portletURL，然后显示icon图标。

<c:if test="<%= MBCategoryPermission.contains(permissionChecker, category, ActionKeys.UPDATE) %>">

       <portlet:renderURL windowState="<%= WindowState.MAXIMIZED.toString() %>" var="portletURL">

              <portlet:param name="struts_action" value="/message_boards/edit_category" />

              <portlet:param name="redirect" value="<%= currentURL %>" />

              <portlet:param name="categoryId" value="<%= category.getCategoryId() %>" />

       </portlet:renderURL>

       <liferay-ui:icon image="edit" url="<%= portletURL %>" />

</c:if>

这部分代码涉及到Liferay的权限机制。

1.6 显示table和分页
显示table很简单，在JSP中

<liferay-ui:search-iterator searchContainer="<%= searchContainer %>" />

SearchContainer自身支持分页。以下几步

l         创建SearchContainer时设置每页显示的条数

构造函数SearchContainer的第四个参数int delta就是每页显示的条数，缺省使用SearchContainer.DEFAULT_DELTA，表示每页显示20条。我们可以用其他任何我们喜欢的数值。

l         从逻辑层取数据时提供begin和end参数

searchContainer.getStart() 和searchContainer.getEnd()

l         显示分页信息

<liferay-ui:search-paginator searchContainer="<%= searchContainer %>" />

注意：如果因为URL缺其他参数设置而导致分页后的页面不能正常显示，则可以在   
<liferay-ui:search-iterator searchContainer="<%= searchContainer %>" />
<liferay-ui:search-paginator searchContainer="<%= searchContainer %>" />标签之间定义URL，并将需要的参数设置进去；
例如：
    <liferay-ui:search-iterator searchContainer="<%= searchContainer %>" />
    <%
        //解决分页时点击下一页或是最后一页时显示的问题
     PortletURL pUrl=renderResponse.createRenderURL();
      pUrl=searchContainer.getIteratorURL();
      pUrl.setParameter("curAction","viewMagazineEntry");
      pUrl.setParameter("magazineTitleId",String.valueOf(magazineTitle.getMagazineTitleId()));
     searchContainer.setIteratorURL(pUrl);
    %>
    <liferay-ui:search-paginator searchContainer="<%= searchContainer %>" />