<uix:shuttle>タグ
ネームスペース:  http://xmlns.oracle.com/uix/ui
派生元:  <uix:base>タグ
グループ:  UIX Components
タグの型:  UINode

このタグは、項目を2つのリスト間で移動し、いずれかのリストを並び替えるメカニズムを提供します。
このBeanは、エージェントのタイプがPDAの場合にはサポートされません。

構文
<uix:shuttle
      name="string"
      nameBinding="data binding to string"
    [ leadingDescShown="boolean" ]
    [ leadingDescShownBinding="data binding to boolean" ]
    [ leadingHeader="string" ]
    [ leadingHeaderBinding="data binding to string" ]
    [ reorderable="boolean" ]
    [ reorderableBinding="data binding to boolean" ]
    [ size="unsignedInt" ]
    [ sizeBinding="data binding to unsignedInt" ]
    [ trailingDescShown="boolean" ]
    [ trailingDescShownBinding="data binding to boolean" ]
    [ trailingHeader="string" ]
    [ trailingHeaderBinding="data binding to string" ]
>
   <uix:filter> </uix:filter>
   <uix:leading> </uix:leading>
   <uix:leadingFooter> </uix:leadingFooter>
   <uix:trailing> </uix:trailing>
   <uix:trailingFooter> </uix:trailingFooter>
</uix:shuttle>

注意: 
  • このタグは派生元タグのすべての属性と子タグを持つことができます。

  • 説明

    このタグは、項目を2つのリスト間で移動し、いずれかのリストを並び替えるメカニズムを提供します。シャトルは、1つのリストから別のリストに移すことにより項目を選択するためによく使用されます。しかし、シャトルはリストの他の操作にも使用できます。

    属性

    シャトルには、名前が必要です。これは、シャトル内の要素の名前の導出元となります。name属性をシャトルの名前に設定します。

    シャトル内の各リストにはヘッダーが必要です。これはleadingHeader属性およびtrailingHeader属性として設定されるテキストです。

    シャトル内の各コンテナには、リストの下に項目の説明を表示する領域を設けることができます。コンテナにこの領域を設けるかどうかを指定するには、leadingDescShown属性およびtrailingDescShown属性を設定します。

    デフォルトでは、シャトルの後続リストの隣に並べ替えのアイコンがあります。これらのアイコンを削除して、リストの順序を変えられないようにするには、reorderable属性をfalseに設定します。

    両方のリストの高さを項目で設定するには、size属性を設定します。サイズは10項目から20項目の間です。属性が設定されていない場合、サイズは両方のリストの長さ、最大値および最小値に基づいて決まります。

    シャトルのリスト

    シャトルには、名前の付けられた子が2つ指定されている必要があります。これは<leading>および<trailing>です。子は両方とも、リスト・コンテンツ(OptionBean)を子として持つListBeansであることが必要です。シャトルがリストから項目を選択するために使用される場合、leadingはfromリスト、trailingはtoリストとみなされます。シャトルは索引付けされた子を持ちません。

    シャトルの主な機能は、1つのリストから別のリストへの項目の移動です。ユーザーは一方のリストで1つ以上の項目を選択し、リストの間にある適切なアイコンを選択することで、項目をリスト間で移動できます。「移動」アイコンまたはリンクをクリックすることにより、先行リストで選択された項目を後続リストに移動します。「削除」アイコンまたはリンクをクリックすることにより、後続リストで選択された項目を先行リストに移動します。「すべて移動」アイコンまたはリンクをクリックすることにより、先行リストの全項目を後続リストに移動します。「すべて削除」アイコンまたはリンクをクリックすることにより、後続リストの全項目を先行リストに移動します。

    シャトルは、後続リストの並べ替えもできます。後続リストの隣にあるアイコンを使用し、選択した項目をリストの一番上へ、リスト内の1スロット上へ、リストの一番下へ、またはリストの1スロット下へ移動できます。

    表示される際に、リストにはすべての項目の下に横線が入ります。この横線は、リストの正しいサイズを維持するためのもので、リスト内の他の項目とは違い、操作できません。

    シャトルのフッター

    シャトルでは、ユーザーは各リストの下にボタン(ButtonBean)またはアイコン(ImageBean)を配置できます。これらのボタンまたはアイコンは、リストの下の1行分のみを使用し、折り返しません。シャトルのレイアウトを一定にする場合、ボタンまたはアイコンの高さは最大26ピクセルにできます。ボタンおよびアイコンはFlowLayoutBean内に置き、どのリストの下にボタンを配置するかに応じて、<leadingFooter>または<trailingFooter>として、このレイアウトBeanをシャトルに追加します。リストの下にフッターが必要ない場合は、対応する名前の付けられた子をnullとして残しておきます。これらのボタンおよびアイコンは、ShuttleProxyを後述のように使用することにより、シャトルの操作に使用できます。

    シャトルのフィルタ

    シャトルでは、leadingコンテナ内のリストの上にフィルタを配置できます。フィルタは、<filter>として追加されます。フィルタは、ShuttleProxyを後述のように使用することにより、シャトルの操作に使用できます。

    リストのコンテンツの取得

    シャトルは、リスト内で選択されている項目だけではなく、各リストのコンテンツ(オプション)が送信時に必要な場合に使用されます。各リストのコンテンツは、シャトル内に非表示要素の値として格納されます。これらは、フォームが送信される際に、"-shuttleName-:Leading:items"および"-shuttleName-:Trailing:items"の形式で転送されます。ここで"-shuttleName-"は、シャトルにname属性により指定された名前です。各オプションは、セミコロン(;)により区切られます。最後のオプションの後にもセミコロンが続きます。オプションの順序は、リスト内での順序と一致します。各オプションは、値により識別されます。値が設定されていない場合、かわりにオプションのテキストにより識別されます。

    JavaScriptのプロキシ

    場合によっては、リストのコンテンツを操作または使用するために、開発者はJavaScriptの使用が必要になります。これは、シャトルのフッターまたはシャトル外のボタンまたはアイコンのアクションとして必要になる場合があります。こうすることで、リスト上で動作する一連のJavaScriptユーティリティのメソッドが使用可能になります。これらは、シャトルを使用する場合に自動的にロードされるshuttle.js JavaScriptライブラリにあります。

    これらのメソッドは、シャトル名およびフォーム名に基づいてShuttleProxyインスタンスを作成することにより、アクセスできます。

                    // create the proxy object
                    var proxy2 = new ShuttleProxy("testShuttle2", "testForm2");
                  

    プロキシを作成すると、それを使用してリストに関する情報を取得、またはシャトル内のリストを操作できます。プロキシは次の関数を提供します。

    • move(fromLeadingList, allItems): 項目を一方のリストからもう一方のリストに移動します。fromLeadingListがtrueの場合、項目は先行リストから後続リストに移動します。fromLeadingListがfalseの場合、項目は逆方向に移動します。allItemsがtrueの場合はすべての項目が移動しますが、falseの場合は選択された項目のみが移動します。
    • reorderList(down, allTheWay, leadingList): リストを並べ替えます。downがtrueの場合、項目はリスト内を下に移動し、falseの場合は上に移動します。allTheWayがtrueの場合、downの値に応じて、項目はリストの一番上または一番下まで移動します。leadingListがtrueの場合は先行リストが並べ替えられ、falseの場合は後続リストが並べ替えられます。
    • getItems(leadingList): リストを構成するoptionオブジェクトの配列を返します。leadingListがtrueの場合、配列には先行リストのオプションが含まれ、falseの場合、項目は後続リストのものです。配列にはリストの最後の横線が含まれないことに注意してください。
    • getSelectedItems(leadingList): リスト内の選択されているoptionオブジェクトの配列を返します。leadingListがtrueの場合、配列には先行リストのオプションが含まれ、falseの場合、項目は後続リストのものです。配列にはリストの最後の横線が含まれないことに注意してください。
    • getItemCount(leadingList): リスト内の項目数を返します。leadingListがtrueの場合、返される数は先行リスト内の項目数です。falseの場合、返される数は後続リスト内の項目数です。リストの最後の横線はこの数には含まれず、実際の項目数のみが取得されることに注意してください。
    • getSelectedItemCount(leadingList): リスト内の選択されている項目数を返します。leadingListがtrueの場合、返される数は先行リスト内の選択されている項目数です。falseの場合、返される数は後続リスト内の選択されている項目数です。リストの最後の横線はこの数には含まれず、実際の項目数のみが取得されることに注意してください。
    • addItem(leadingList, index, text, value, description): 指定した索引の項目をリストに追加します。leadingListがtrueの場合、項目は先行リストに追加され、falseの場合は後続リストに追加されます。indexはゼロから始まります。したがって、項目をリストの最後に挿入するには、indexshuttleProxy.getItemCount(leadinglist)に設定します。textパラメータには、項目の表示テキストを指定し、valueパラメータには、フォーム送信時にこの項目を表す値を指定します。descriptionパラメータは、項目の説明を指定します。descriptionパラメータは省略できます。
    • deleteItemByValue(leadingList, value): リストから1つの項目を削除します。leadingListがtrueの場合、項目は先行リストから削除され、falseの場合は後続リストから削除されます。削除される項目は、valueの値(テキストではない)を持つ最初の項目です。
    • deleteSelectedItems(leadingList): リストから複数の項目を削除します。leadingListがtrueの場合、項目は先行リストから削除され、falseの場合は後続リストから削除されます。削除される項目は、該当するリスト内の選択されている項目です。


    属性

    説明
    leadingDescShown 先行リストに説明を表示する領域を設定するかどうか。
    boolean
    leadingHeader シャトルの先行リストのヘッダー。
    string
    name シャトルの識別に使用される名前。 必須。
    string
    reorderable 後続リストの隣に並べ替えアイコンを表示するかどうかを示すブール値。
    boolean
    size シャトル内の各リストの項目数による高さ。
    unsignedInt
    trailingDescShown 後続リストに説明を表示する領域を設定するかどうか。
    boolean
    trailingHeader シャトルの後続リストのヘッダー。
    string

    子タグ

    説明 必須 組込み可能な数
    <uix:filter> 先行リストの上のフィルタ。
    いいえ 1
    <uix:leading> シャトルの先行リスト。
    はい 1
    <uix:leadingFooter> 先行リストの下のボタンまたはイメージのフッター。
    いいえ 1
    <uix:trailing> シャトルの後続リスト。
    いいえ 1
    <uix:trailingFooter> 後続リストの下のボタンまたはイメージのフッター。
    いいえ 1