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

<messageBox>要素は、アプリケーションのページの最上部に使用され、ユーザーに重要なメッセージ情報を提供します。

構文
<messageBox
    [ automatic="boolean" ]
    [ dataName="string" ]
    [ dataNamespace="string" ]
    [ message="string" ]
    [ messageType="ui:messageType" ]
    [ text="string" ]
>
   <contents> <!-- indexed children --> </contents>
</messageBox>

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

  • 説明

    <messageBox>要素は、アプリケーションのページの最上部に使用され、ユーザーに重要なメッセージ情報を提供します。メッセージの種類は次のとおりです。

    携帯情報端末の場合、messageBoxは、該当するアイコンを使用して上のメッセージのいずれかを表示するだけです。ページ・コンテンツまたはインライン・メッセージ(あるいはその両方)は、詳細の表示に使用します。

    MessageBoxの使用には、明示的属性の使用および自動構成の使用の2つの方法があります。

    MessageBoxの属性の使用

    この方法でMessageBoxを使用すると、クライアントで完全に制御できますが、構成に必要な処理が増えます。どのように表示するかを完全に指定するために、MessageBoxの属性を直接設定する必要があります。表示するメッセージ・ボックスの種類は、messageTypeプロパティを使用して設定します。error、info、warningまたはconfirmationに対応するUIConstantのいずれかを設定します。メッセージのタイトル・テキストは自動的に生成されますが、textプロパティを使用してオーバーライドできます。ボックスの最上部に表示されるメッセージ・テキストは、messageプロパティにより設定されます。個々のメッセージは、索引付けされた子で指定します。ここではLinkBeanを使用し、リンクに続く説明テキストをlongDescプロパティで表現する必要があります。

    MessageBoxの自動構成の使用

    MessageBoxを使用するもう1つの方法は、すべての情報をMessageDataインスタンスから収集できるようにすることです。これは、MessageBoxのautomaticプロパティをtrueに設定することにより行われます。こうすることで、レンダリング時に、MessageBoxは、データを収集するMessageDataを見つけようとします。デフォルトでは、UIX Componentsネームスペース(http://xmlns.oracle.com/uix/ui)下のRenderingContextで、MessageData.MESSAGE_DATA_OBJECT_NAMEキーをDataObjectセレクタとして使用して、このMessageDataを探します。クライアントで別のセレクタまたはネームスペースを使用する必要がある場合は、該当するプロパティであるdataNameおよびdataNamespaceにより指定できます。

    クライアントでは、MessageDataクラスのドキュメントを参照して、そのデータ・オブジェクトの構成方法を確認する必要があります。自動的にレンダリングされるように設定されたMessageBoxでMessageDataが見つからなかった場合、またはMessageDataにエラー、情報または警告がまったく登録されていない場合、MessageBoxはレンダリングされません。これにより、クライアントは常にMessageBoxをノード・ツリーに配置できます。メッセージ・ボックスは、メッセージを表示する必要のある場合にのみレンダリングされます。ただし、エラー・ボックス内で最上部に表示するメッセージを制御する場合には、クライアントで手動で設定する必要があることに注意してください。

    自動構成は、確認メッセージの表示に使用されるMessageBoxには使用できません。その場合には、直接属性を使用して処理する必要があります。


    次の例は、データ・バインドされた警告メッセージ・ボックスで、1つのメッセージとリンクされた子がいくつかあります。
      <messageBox message="This is the Message"
                  messageType="warning">
        <contents data:childData="warnings@MyMessageData">
          <link data:text="label"
                data:longDesc="message"
                data:destination="destination" />
        </contents>
      </messageBox>

    属性

    説明
    automatic MessageBoxが、プロパティおよび子のかわりに、MessageDataから情報を収集するかどうか。
    boolean
    dataName メッセージ・データを収集するデータ・オブジェクトの名前。自動的に構成されたMessageBoxeでのみ使用されます。
    string
    dataNamespace メッセージ・データを収集するデータ・オブジェクトのネームスペース。自動的に構成されたMessageBoxでのみ使用されます。
    string
    message ボックスのメイン・テキスト・メッセージ。
    string
    messageType メッセージ・ボックスの種類。
    ui:messageType
    text タイトル・テキストをオーバーライドするテキスト。
    string

    子要素

    説明 必須 組込み可能な数
    <contents> Beanの索引付けされた子。 いいえ 1