カスタムコントロールのプロパティ定義プロパティの設定

カスタムコントロールのユーザー独自のプロパティを定義します。 XPages 内のカスタムコントロールのプロパティを設定するときに使用する、デフォルトのエディタと値を指定できます。 また、いつプロパティを表示し、XPages 内で有効と見なすかを決定するスクリプトも作成できます。

始める前に

プロパティを定義した後は、容易にアクセスできるようにそれらをグループに編成し、ツリー表示に再配列できます。 カスタムコントロールを XPage に挿入した後は、[プロパティ] ビューの [すべてのプロパティ] タブをクリックすることで、プロパティの値を設定できます。

このタスクについて

例えば、以下の 2 つのシナリオでは、開発者が独自のプロパティと値を定義する場合を説明します。

シナリオ 1

ラベルを含むカスタムコントロールを処理します。 ラベルに値をバインドし、XPage またはカスタムコントロールで使用されるごとにラベルが変わるようにします。 それには、次の手順に従います。
  1. XPages エディタ内でカスタムコントロールを選択します。
  2. [プロパティ] ビューで、[プロパティ定義] タブをクリックします。
  3. [新規プロパティ] をクリックします。
  4. [名前] フィールドに name と入力し、プロパティタイプとして string を指定します。
  5. カスタムコントロールにラベルを追加します。
  6. [ファイル] > [保存] をクリックして、変更を保存します。
  7. XPage を作成し、そこにカスタムコントロールを追加します。
  8. その XPage でカスタムコントロールを選択します。
  9. [プロパティ] ビューで、[すべてのプロパティ] タブをクリックします。
  10. [その他] カテゴリで、name というプロパティを探します。
  11. [値] フィールドに、country と入力します。
  12. [ファイル] > [保存] をクリックして、変更を保存します。

シナリオ 2

曜日を表示するカスタムコントロールを処理します。 コンボボックスまたはリストボックスに平日を表示するかどうかを決定するプロパティを定義します。 それには、次の手順に従います。
  1. XPages エディタ内でカスタムコントロールを選択します。
  2. [プロパティ] ビューで、[プロパティ定義] タブをクリックします。
  3. [新規プロパティ] をクリックします。
  4. [名前] フィールドに display と入力し、プロパティタイプとして string を指定します。
  5. コンボボックスとラジオボタンの両方をカスタムコントロールに追加します。
  6. XPages エディタで、コンボボックスを選択します。
  7. [プロパティ] ビューで、[コンボボックス] タブをクリックします。
  8. [表示] が選択された状態 (デフォルト) で、計算されたプロパティメニューボタンをクリックします。
  9. [値の計算] を選択します。
  10. スクリプトエディタで、スクリプト記述言語として [EL] を選択します。
  11. [ページロードで計算する] を選択します。
  12. フィールドに、次の式を入力します。return "combo" == compositeData.get("display");
  13. [OK] をクリックして、スクリプトエディタを閉じます。
  14. XPages エディタで、リストボックスを選択します。
  15. [プロパティ] ビューで、[リストボックス] タブをクリックします。
  16. [表示] が選択された状態 (デフォルト) で、計算されたプロパティメニューボタンをクリックします。
  17. [値の計算] を選択します。
  18. スクリプトエディタで、スクリプト記述言語として [EL] を選択します。
  19. [ページロードで計算する] を選択します。
  20. フィールドに、次の式を入力します。return "list" == compositeData.get("display");
  21. [OK] をクリックして、スクリプトエディタを閉じます。
  22. [ファイル] > [保存] をクリックして、変更を保存します。
  23. XPage を作成し、そこにカスタムコントロールを追加します。
  24. その XPage でカスタムコントロールを選択します。
  25. [プロパティ] ビューで、[すべてのプロパティ] タブをクリックします。
  26. [カスタム] カテゴリで、display というプロパティを探します。
  27. [値] フィールドに、list と入力します。
  28. [ファイル] > [保存] をクリックして、変更を保存します。

プロパティ定義プロパティを設定するには、以下のステップを実行します。

手順

  1. エディタで独立した設計要素としてカスタムコントロールを開きます。
  2. [プロパティ] ビューで、[プロパティ定義] タブをクリックします。
    注: デフォルトでは、Domino® Designer はユーザーがプロパティツリーを作成できるルートノードを提供します。 ルートノードにはプロパティがありません。
  3. [新規プロパティ] をクリックして、ルートノードの直下に新規プロパティを挿入します。 デフォルトでは、最初のプロパティは property_1 です。次のプロパティは property_2、その次は property_3 というようになります。
    注: プロパティのグループを作成するためのステップは、後で説明します。
  4. [プロパティ] ビューの右側で [プロパティ] タブをクリックして、以下のステップを実行します。
    1. [名前] フィールドに、プロパティの名前を入力します。 左にあるツリー表示が、新規名で自動的に更新されます。
    2. [タイプ] フィールドで、プロパティのタイプを入力するか、リストからプロパティのタイプを選択します。 リストには、以下のオプションがあります。
      • boolean (ブール値)
      • byte (バイト)
      • char
      • double (二重)
      • float (浮動)
      • int (整数)
      • long
      • ローカライズ可能なストリング
      • リソースパス
      • short
      • string (ストリング)
      デフォルトのタイプはstring (ストリング)です。
    3. [エディタ] フィールドで、プロパティの値を定義するときにデフォルトで開くエディタを選択します。 リストにないエディタを選択するには、アイコンをクリックして [エディタの選択] ダイアログボックスを開き、以下のステップを実行します。
      1. 特定のエディタを検索するには、上部のフィールドにエディタの名前を入力します。 Domino Designer が一致するエディタを検出すると、下にある [一致するエディタ] フィールドに表示されます。
      2. 検索せずにエディタを見つけるには、[一致するエディタ] フィールドのカテゴリを展開し、エディタを選択します。
      3. 特定のエディタについての情報を得るには、[エディタの詳細] セクションを参照してください。 このセクションには、エディタの簡単な説明が表示されます。
      4. エディタを選択したら、[OK] をクリックして [エディタの選択] ダイアログボックスを閉じます。 エディタ名は [エディタ] フィールドに表示されます。
    4. [パラメータ] フィールドに、デフォルトのエディタを初期化するのに必要なパラメータを入力します。 このフィールドが使用可能になるのは、デフォルトのエディタにパラメータが必要な場合のみです。 例えば、コンボボックスエディタには、区切り文字で区切られた値のリストである String パラメータが必要です。
    5. [デフォルト値] フィールドに、プロパティのデフォルト値を入力します。
    6. プロパティに複数の値を許可する場合、[複数インスタンスを許可する] チェックボックスを選択します。 これを選択すると、XPage 内のカスタムコントロールのプロパティを設定するときに、プロパティの複数のインスタンスを作成できます。
  5. 検証プロパティを設定するには、[検証] タブをクリックし、以下のステップを実行します。
    1. XPage 内にカスタムコントロールがあるときに、プロパティの値を入力する必要がある場合、[必須フィールド] チェックボックスを選択します。
    2. スクリプトエディタで、ブール値を生成する JavaScript 式を入力します。 true の場合、プロパティ値は有効と見なされます。
  6. XPage 内にカスタムコントロールがあるときに、プロパティが表示されるようにプロパティを設定するには、[表示] タブをクリックし、ブール値を生成する JavaScript 式を入力します。 true の場合、プロパティ値は表示されます。
  7. カスタムコントロールに対して定義する新規プロパティについて、上記のステップを繰り返してください。
  8. プロパティをグループに編成するには、[新規グループ] をクリックします。 デフォルトでは、最初のグループプロパティは group_1 です。 次のグループプロパティは group_2、その次は group_3 というようになります。 Domino Designer は、デフォルトで新規プロパティをグループに自動的に追加します。
  9. [プロパティ] ビューの右側で [グループ] タブをクリックして、以下のステップを実行します。
    1. [名前] フィールドに、グループの名前を入力します。 左にあるツリー表示が、新規名で自動的に更新されます。
    2. グループに複数の値を許可する場合、[複数インスタンスを許可する] チェックボックスを選択します。 これを選択すると、XPage 内のカスタムコントロールのプロパティを設定するときに、グループの複数のインスタンスを作成できます。
  10. XPage 内にカスタムコントロールがあるときに、グループが表示されるようにプロパティを設定するには、[表示] タブをクリックし、ブール値を生成する JavaScript 式を入力します。 true の場合、グループは表示されます。
  11. プロパティとグループを削除するには、ツリー表示でプロパティまたはグループを選択し、[削除] をクリックします。
  12. ツリー表示でプロパティとグループを再配置するには、プロパティまたはグループを選択し、[上へ移動] または [下へ移動] をクリックします。
  13. [ファイル] > [保存] をクリックして、変更を保存します。
親トピック: カスタムコントロールのプロパティを独立した設計要素として設定する