一、綜述

Pager，分頁(yè)組件。在介紹分頁(yè)組件前，首先了解一下SimpleFramework的數(shù)據(jù)訪問集接口IDataObjectQuery，分頁(yè)組件在接口設(shè)計(jì)上依賴于IDataObjectQuery，其目標(biāo)是提供一個(gè)編程一致、可靠并且高性能的結(jié)果集。

目前IDataObjectQuery有三個(gè)實(shí)現(xiàn)：

List

DB

Lucene

如果你不了解SimpleFramework的數(shù)據(jù)訪問機(jī)制(SimpleADO)，建議參考一下：

http://simpleframework.net/doc/d2/3.4.html

1.1 Pager組件

分頁(yè)組件的接口設(shè)計(jì)很簡(jiǎn)單，定義如下：

public interface IPagerHandle extends IComponentHandle {  
    int getCount(ComponentParameter compParameter) throws Exception;  
 
    void process(ComponentParameter compParameter, int start) throws Exception;  
 
    IDataObjectQuery<?> createDataObjectQuery(ComponentParameter compParameter)  
            throws Exception;   
}  
 

先看看標(biāo)紅的兩個(gè)函數(shù)：

getCount定義了數(shù)據(jù)集的總數(shù);

process將從某一位置(start)開始，然后獲取之后的n條數(shù)據(jù)(n在PagerBean中定義了每次處理數(shù)據(jù)的條數(shù)，PagerBean可通過compParameter獲取)

很簡(jiǎn)單的邏輯，但如果每次讓用戶來實(shí)現(xiàn)getCount和process，我想一定會(huì)頭大：(

原因如下：

count、start和n處理起來比較繁瑣

每一種數(shù)據(jù)源處理方式不一樣，比如：db、緩存、lucense，甚至nosql

如何輸出數(shù)據(jù)展示層

分頁(yè)組件為了簡(jiǎn)化實(shí)現(xiàn)的難度，又定義了一個(gè)函數(shù)：

IDataObjectQuery<?> createDataObjectQuery(ComponentParameter compParameter) throws Exception;  
 

這豈不是越來越復(fù)雜嗎?其實(shí)分頁(yè)組件同時(shí)還提供了一個(gè)抽象類AbstractPagerHandle來達(dá)到簡(jiǎn)化的目的，你只要繼承自AbstractPagerHandle，getCount和process就不需要實(shí)現(xiàn)了，只需要提供分頁(yè)的數(shù)據(jù)集IDataObjectQuery即可。

說一下如何輸出數(shù)據(jù)展示層。

Pager組件不像TablePager組件有固定的數(shù)據(jù)展示方式，數(shù)據(jù)如何展示則完全取決于使用者本身，Pager組件通過提供dataPath屬性(定義的jsp路徑)來處理數(shù)據(jù)展示。

那么在jsp文件中，又如何得到當(dāng)前分頁(yè)的數(shù)據(jù)呢?

因?yàn)锳bstractPagerHandle已經(jīng)實(shí)現(xiàn)了process函數(shù)，該函數(shù)會(huì)把當(dāng)前頁(yè)的數(shù)據(jù)以List的形式放在request中，為了方便調(diào)用，你可以在jsp定義如下代碼：

List data = PagerUtils.getPagerList(request); 

1.2 TablePager組件

TablePager組件繼承自Pager組件，因?yàn)槭腔诹泻托械恼故痉绞?，所以其dataPath屬性被設(shè)定了一個(gè)不可更改的值，可以理解為TablePager組件內(nèi)置了數(shù)據(jù)展示的jsp文件，這個(gè)jsp文件會(huì)根據(jù)定義好的列屬性來展示表格數(shù)據(jù)。

ITablePagerHandle還定義了什么呢：

AbstractTablePagerData createTablePagerData(ComponentParameter compParameter)  
         throws Exception; 

這個(gè)函數(shù)的目的是告訴內(nèi)置的jsp文件如何通過AbstractTablePagerData對(duì)象生成基于的表格數(shù)據(jù)展示(HTML)，后續(xù)將會(huì)詳細(xì)介紹這個(gè)對(duì)象。

1.3 GroupTablePager

GroupTablePager組件繼承自TablePager組件，提供了按表格某一列(目前不支持多列)分組功能。

二、原理

見下圖

三、實(shí)踐

3.1 Pager組件

3.1.1 Pager組件的聲明

<pager name="testPager" containerId="idTestPager" 
       handleClass="net.simpleframework.TestPagerHandle" 
       dataPath="test_pager.jsp" pageItems="20">  
</pager> 

聲明一個(gè)名稱為testPager的分頁(yè)組件。

3.1.2 通過ID與HTML頁(yè)面元素綁定

在HTML頁(yè)面中，你需要定義一個(gè)區(qū)域，并且這個(gè)區(qū)域的ID和pager組件的containerId屬性值一樣，SimpleFramework將把Pager組件在后臺(tái)產(chǎn)生的HTML代碼放到這個(gè)指定的ID區(qū)域內(nèi)。

<div id="idTestPager"></div> 

3.1.3 定義數(shù)據(jù)源

對(duì)于一般用戶來講，實(shí)現(xiàn)getCount和process是沒有意義的，直接繼承自抽象類AbstractPagerHandle會(huì)更簡(jiǎn)單(詳見綜述部分)，如果數(shù)據(jù)來自緩存，代碼如下：

public IDataObjectQuery<?> createDataObjectQuery(  
       final ComponentParameter compParameter) throws Exception {  
    // 創(chuàng)建一些數(shù)據(jù)TestBean，并添加到List  
    List<?> data = Arrays.asList(new TestBean(), new TestBean(), new TestBean());  
    return new ListDataObjectQuery(data);  
} 

如果來自數(shù)據(jù)庫(kù)：

public IDataObjectQuery<?> createDataObjectQuery(  
       final ComponentParameter compParameter) throws Exception {  
    // 從數(shù)據(jù)庫(kù)查詢  
    return DataObjectManagerFactory.getQueryEntityManager(getApplication()).query(  
                    new SQLValue("select * from test"));  
}  
 

3.1.4 編寫數(shù)據(jù)展示層

數(shù)據(jù)源創(chuàng)建后，需要在屬性dataPath指定的文件test_pager.jsp下編寫數(shù)據(jù)展示。

如何在test_pager.jsp中獲取當(dāng)前分頁(yè)的數(shù)據(jù)呢?在綜述部分已經(jīng)講到，通過 List data = PagerUtils.getPagerList(request); 獲取當(dāng)前分頁(yè)的數(shù)據(jù)。

剩下需要做的，就是遍歷data，并輸出HTML和樣式了。

提出一個(gè)問題，data的大小是多少?(pageItems指定的個(gè)數(shù))

3.2 TablePager組件

因?yàn)槔^承自分頁(yè)組件，表格組件擁有分頁(yè)組件的所有屬性，屬性dataPath已沒有意義，因?yàn)榭偸钦{(diào)用內(nèi)置的jsp頁(yè)面。

3.2.1 TablePager組件的聲明

<tablePager name="testTablePager" containerId="idTestTablePager" 
    handleClass="net.simpleframework.TestTablePagerHandle" 
    pageItems="30"> 
</tablePager> 

聲明一個(gè)名稱為testTablePager的表格組件。

3.2.2 通過ID與HTML頁(yè)面元素綁定

和分頁(yè)組件一樣，定義一個(gè)區(qū)域，并設(shè)置containerId屬性。

<div id="idTestTablePager"></div> 

3.2.3 定義表格列

<tablePager name="testTablePager" containerId="idTestTablePager" 
    handleClass="net.simpleframework.TestTablePagerHandle" 
    pageItems="30"> 
  <columns> 
    <column columnName="n1" sort="false" /> 
    <column columnName="n2" sort="false" separator="true" 
      headerStyle="width: 180px;" style="width: 180px;" /> 
    <column columnName="n3" separator="true" 
      headerStyle="width: 120px;" style="width: 120px;" /> 
    <column columnName="n4" separator="true" 
      headerStyle="width: 120px;" style="width: 120px;" /> 
  </columns> 
</tablePager> 

如上，紅色部分。其屬性含義為：

columnName：列唯一名稱，***英文，對(duì)應(yīng)后臺(tái)bean的屬性值或Map的Key值

columnText：列的顯示名稱，即你在表格頭所看見的，如果為空則顯示columnName

columnSqlName：數(shù)據(jù)源的列名，等于columnName時(shí)可為空

sort：標(biāo)識(shí)該列是否可以排序

defaultExport：是否導(dǎo)出該列

headerStyle：列頭的樣式，等同于HTML中style的值

style：行的樣式

3.2.4 定義數(shù)據(jù)源

參考分頁(yè)組件的數(shù)據(jù)源定義：)

3.2.5 實(shí)例化AbstractTablePagerData對(duì)象

表格組件的Handle接口ITablePagerHandle需要實(shí)例化AbstractTablePagerData對(duì)象，其目標(biāo)是在數(shù)據(jù)源和表格展示層搭建一個(gè)轉(zhuǎn)換器，這個(gè)轉(zhuǎn)化器定義了表格Render(展示)所需要的所有信息。

下面列舉AbstractTablePagerData定義的一些常用方法：

// 定義了表格列，默認(rèn)從表格組件定義（前面紅色部分）中獲取，所以可以覆蓋此方法來動(dòng)態(tài)生成表格列  
Map<String, TablePagerColumn> getTablePagerColumns();  
 
// 傳遞數(shù)據(jù)源中的對(duì)象dataObject，并轉(zhuǎn)為表格需要的數(shù)據(jù)Map。  
// 比如，dataObject中含有日期類型，可以在put到Map中轉(zhuǎn)為帶格式的字符串（仍按日期排序）  
Map<Object, Object> getRowData(Object dataObject);  
 

表格組件同樣也提供了抽象類AbstractTablePagerHandle，目的是簡(jiǎn)化實(shí)例AbstractTablePagerData的操作。

四、高級(jí)特性

4.1 數(shù)據(jù)刷新

在客戶端通過javascript來刷新分頁(yè)組件，代碼示例如下：

$Actions["testPager"]();  
或  
$Actions["testTablePager"].refresh(params);  
 

數(shù)據(jù)刷新是基于ajax的，調(diào)用時(shí)可以動(dòng)態(tài)傳遞一些參數(shù)。

4.2 定義操作事件

4.2.1 jsLoadedCallback

分頁(yè)組件裝載后，將觸發(fā)此事件，數(shù)據(jù)刷新完成后也會(huì)觸發(fā)此事件，舉個(gè)例子：

<tablePager name="testTablePager" containerId="idTestTablePager" 
    handleClass="net.simpleframework.TestTablePagerHandle" 
    pageItems="30"> 
  <jsLoadedCallback> 
    // 初始化表格行，使之具備拖放操作  
    TableRowDraggable.init("idTestTablePager", "tafelTreeselected");      
  </jsLoadedCallback> 
</tablePager> 

4.2.2 jsRowClick和jsRowDblclick

定義表格組件行的單擊和雙擊事件，其函數(shù)原型為：

function click(item) {  
 // item為行TR對(duì)象  
} 

示例如下：

<tablePager name="testTablePager" containerId="idTestTablePager" 
    handleClass="net.simpleframework.TestTablePagerHandle" 
    pageItems="30"> 
  <jsRowClick> 
    alert(item.getAttribute("id")); // 打印行id  
  </jsRowClick> 
</tablePager> 

4.3 一些不常用的屬性

解釋一些不經(jīng)常使用的屬性含義：

pagerBarLayout：分頁(yè)按鈕的布局，有四個(gè)值，top、bottom、both、none，含義為，在數(shù)據(jù)上方顯示、在數(shù)據(jù)下方顯示、上下方都顯示、都不顯示

title：組件左上方要顯示的一些文本

indexPages：分頁(yè)按鈕(數(shù)字部分)顯示個(gè)數(shù)

noResultDesc：當(dāng)沒有數(shù)據(jù)，顯示的文本提示信息

csvExportAction：導(dǎo)出的js代碼，空為系統(tǒng)提供的js代碼，false將禁止導(dǎo)出功能

jobView：定義查看數(shù)據(jù)角色，需機(jī)構(gòu)應(yīng)用模塊的支持

五、總結(jié)

還是留給讀者吧：)

下次將介紹Window組件。