S_a_k_Uの日記みたいなDB

~サクゥーと呼ばないで~

MyFaces/Tobagoの表にソート機能を追加

MyFaces 4.1.3
Tobago 6.11.0

続き。
saku-jp.hatenablog.com

ソート機能を追加

tc:columnタグにsortable属性があるので、sortable="true"とするだけ。
列のヘッダ行にソート用の文字(⇅)が表示され、クリックすることで昇順/降順でソートされる。
 
 
あくまで、表示中のリスト内でのソートなので、最新のDBによるソートにならない。

複数列のソートのソート順の表示

それぞれの列のソート用の文字(⇅)をクリックすれば、クリックした列の順序でのソートとなる(表示中のリスト内でのソートであり、管理Beanに保持したリストの要素をクリックする度にソートしているため)。
tc:sheetタグのmaxSortColumns属性に表示したいソート順序の数を指定(ex. maxSortColumns="4")すればソート用の文字の横にソート順が表示される。
 

最新のDBでソートする

tc:sheetタグのsortActionListener属性に指定したメソッドが呼び出されるので、管理Beanにそのソート処理を実装する。
また、管理Beanの処理で各列のコンポーネントIDが必要となるため、tc:columnタグのid属性を指定する。

<tc:sheet value="#{trialPageBean.list}" var="detail" id="detailList"
  selectable="none" columns="0.2fr 0.5fr 0.5fr 1fr"
  customClass="spreadsheet" maxSortColumns="4"
  sortActionListener="#{trialPageBean.sort}">
…
  <!-- 各列のコンポーネントIDは、ID=id、日付=dateTime、金額=amount、テキスト=text -->
  <tc:column label="ID" id="id" sortable="true">
    <tc:out value="#{detail.id}" />
  </tc:column>
…
</tc:sheet>

ActionEvent から対象のコンポーネント(UISheet)からソート情報(ソート順(列)と昇順/降順)を取得して、対応する

/**
 * 明細の一覧をソートする.
 * 
 * @param event イベント情報
 */
public void sort(ActionEvent event) {
  FacesContext facesContext = FacesContext.getCurrentInstance();
  UISheet sheet = (UISheet) event.getComponent();
  // SheetState からソート情報のリストを取得
  SortedColumnList sortedColumns = sheet.getSheetState(facesContext).getSortedColumnList();
  if (sortedColumns == null || sortedColumns.isEmpty()) {
    return;
  }
  // 複合列のソートを組み立てるための Comparator
  Comparator<TrialDetail> multiComparator = null;
  // SortedColumnListからソート順にソート情報を取得する
  for (int i = 0; i < sortedColumns.size(); i++) {
    SortedColumn sortedColumn = sortedColumns.get(i);
    // カラムのコンポーネントID (Facelet上の id)
    String columnId = sortedColumn.getId();
    if (columnId == null) {
      continue;
    }
    // 昇順(true)/ 降順(false)
    boolean ascending = sortedColumn.isAscending();

    /*
     *  以下はリスト上でソートするだけの処理であり、本来アクションとする必要はない。
     *  (tc:columnタグのsortable="true"のみでリスト上でソート可能)
     *  SQLで最新のDBからソートしたリストを取得する場合など、アクションとして処理を行う。
     */

    // 各列のコンポーネントIDに応じた個別 Comparator の作成
    Comparator<TrialDetail> currentComparator = null;
    switch (columnId) {
    case "id":
      currentComparator = Comparator.comparing(TrialDetail::getId);
      break;
    case "dateTime":
      currentComparator = Comparator.comparing(TrialDetail::getDateTime);
      break;
    case "amount":
      currentComparator = Comparator.comparing(TrialDetail::getAmount);
      break;
      case "text":
        currentComparator = Comparator.comparing(TrialDetail::getText);
        break;
      default:
        throw new IllegalArgumentException("Unexpected value: " + columnId);
      }
    if (currentComparator != null) {
      // 降順の場合は条件を反転
      if (!ascending) {
        currentComparator = currentComparator.reversed();
      }
      // ソート順に従ってソート条件を連結していく (複合ソートの組み立て)
      if (multiComparator == null) {
        multiComparator = currentComparator;
      } else {
        multiComparator = multiComparator.thenComparing(currentComparator);
      }
    }
  }
  // 複合ソートをリストに適用
  if (multiComparator != null) {
    getList().sort(multiComparator);
  }
}