<sortableHeader>要素は、ソートを可能にする必要のあるTableBeanで、列ヘッダーのスタンプとして使用される便利なBeanです。 SortableHeaderBeanにより、クライアントはソートを実装し、希望する状態およびメッセージ・アイコンを表示するTableBean列ヘッダーを、容易に作成できます。
SortableHeaderBeanでは、親BeanであるMessageStyledTextBeanの多数の属性を使用します。 クライアントは、このBeanのAPIを使用して、表示テキストまたはそのバインディング、あるいはメッセージまたはステータス・アイコンおよびそのバインディングを設定できます。 ただし、SortableHeaderBeanではレンダリングで1つの追加属性sortableを使用します。 TableBeanでは、SortableHeaderBeanをレンダリングする際、その列ヘッダーをソート可能としてレンダリングするかどうか、また必要な場合は、列に昇順または降順でソートされるものとしてフラグを立てるかどうかを決めるために、sortable属性の値を使用します。
sortable属性には4つの異なる値を設定できます。 デフォルトの場合、この属性に値が設定されていない場合、または値としてnoが返される場合、列ヘッダーはソート不可としてレンダリングされます。 値としてyesが返される場合、列ヘッダーはソート可能としてレンダリングされます。 ascendingが返される場合、列ヘッダーがソート可能としてレンダリングされ、しかも昇順でソートされます。 同様に、descendingが返される場合、列ヘッダーがソート可能としてレンダリングされ、降順でソートされます。
昇順でソートされるよう指定されている場合、上矢印がヘッダーにレンダリングされ、下方向に読むと値が増えることを示します。 降順でソートされるよう指定されている場合、下矢印がヘッダーにレンダリングされ、列を上方向に読むと値が増えることを示します。 yesの場合は、矢印は表示されません。
destinationプロパティがこのBeanに設定またはバインドされている場合、その値がソート可能なヘッダーでレンダリングされるリンクのリンク先として使用されます。 それ以外の場合、ソート可能なヘッダーにより生成される宛先リンクは、4つのプロパティとその既定値を利用します。
- eventプロパティと値sort。
- sourceプロパティとSortableHeaderBeanを含む表の名前として取得された値。
- valueプロパティとこのBeanのvalueプロパティにバインドされたデータ。バインド値がない場合は、ソートする列のゼロから始まる索引。
- stateプロパティとこの列が現在昇順でソートされている場合、値ascending。この列が現在降順でソートされている場合は値descending。
このSortableHeaderBeanがフォーム送信を使用するTableBeanで使用される場合、これらのプロパティと値はフォーム値として送信されます。 それ以外の場合、これらの4つの値はTableBeanのdestination属性にURL引数として付加されます。