APL Pager（キャラクターディスプレイ）

Pager（キャラクターディスプレイ）

Pagerは、一連のコンポーネントを1つずつ表示します。通常、Pagerは、スライドショーのような時系列で並べられたデータ項目を表示するために使用します。

Pagerの例

{
  "type": "Pager",
  "items": [
    {
      "type": "Text",
      "text": "ページ#1で表示されるテキストコンテンツ"
    },
    {
      "type": "Text",
      "text": "ページ#2で表示されるテキストコンテンツ"
    }
  ]
}

キャラクターディスプレイでのPagerのナビゲーション

キャラクターディスプレイではタッチ入力がサポートされないので、ユーザーはPager間をスワイプでナビゲートすることができません。ページ間の移動にはAutoPageコマンドやSetPageコマンドを使用してください。

プロパティ

Pagerには、Componentの標準プロパティに加えて、次のプロパティがあります。

プロパティ 型 デフォルト 動的 説明
data データ <none> ✕ このContainerにバインドするデータです。
firstItem コンポーネントとレイアウトの配列 <none> ✕ 他のどの項目よりも先に含めるコンポーネントです。
initialPage 整数 0 ✕ 開始ページのインデックスです。
item/items コンポーネントとレイアウトの配列 [] ✕ データセットのインフレートに使用するコンポーネントです。
lastItem コンポーネントとレイアウトの配列 <none> ✕ 他のすべての項目の後に含めるコンポーネントです。
onPageChanged コマンド配列 [] ✕ ページを切り替える場合に実行するコマンドです。

Pagerは、一連のページとしてユーザーに表示されます。

Pagerのheightは、指定がない場合はデフォルトの1文字です。Pagerのwidthは、指定がない場合はデフォルトの100%です。

firstItem

このプロパティが割り当てられた場合、1つの子のみのインフレート方法（1つの子のみのインフレート）を使用して、1つのコンポーネント／レイアウトがPagerの先頭に追加されます。

item/items

Pagerに表示するコンポーネントとレイアウトの配列です。データプロパティが割り当てられている場合、Pagerはデータ配列のインフレート方法（データ配列のインフレート）を使用します。データプロパティが割り当てられていない場合、Pagerは子コンポーネントの単純な配列のインフレート方法（子コンポーネントの単純な配列のインフレート）を使用します。

lastItem

このプロパティが割り当てられた場合、1つの子のみのインフレート方法（1つの子のみのインフレート）を使用して、1つのコンポーネント／レイアウトがPagerの末尾に追加されます。

initialPage

表示する最初のページのインデックスです。インデックスは0から始まり、デフォルトは0です。firstItemが指定されている場合のインデックスは0になります。

onPageChanged

onPageChangedハンドラーは、ページが新しいページに完全に切り替わったときに実行されます。生成されるイベントの形式は次のようになります。

"event": {
  "source": {
    "source": "Pager",
    "handler": "Page",
    "id": ID,          // PagerのID
    "uid": UID,        // ランタイムで生成されたコンポーネントの固有ID
    "value": NUMBER    // 新しいページのインデックス
  }
}

event.source.valueは、新しいページのインデックス（0から始まるインデックス）に設定されます。