<af:query>

af:query query query

UIComponentクラス: oracle.adf.view.rich.component.rich.RichQuery
コンポーネントのタイプ: oracle.adf.RichQuery

ネーミング・コンテナ: 該当。このコンポーネントの子(partialTriggers、findComponent()など)を参照するときには、子のIDの先頭に、このコンポーネントのIDとコロン(:)を付ける必要があります。

queryコンポーネントを使用すると、保存済の検索に基づく問合せの実行や保存済の検索のパーソナライズが可能です。コンポーネントは、様々な要素を持つ検索パネルを表示します。これらの要素は様々なタスクの実行に役立ちます。

queryコンポーネントでレンダリングされる要素

queryコンポーネントを使用して実行されるタスク

次のアクションは、現在選択されている保存済の検索で実行されます。

次のアクションは保存済の検索で実行されます。

イベント

保存済の検索で実行された操作に対し、QueryOperationEventが起動します。操作にはモード変更、作成、削除、リセット、選択および更新が含まれます。このイベントをトリガーする特定のイベントは、QueryOperationEventオブジェクトの一部として格納されます。queryコンポーネントは、デフォルトで内部のQueryOperationListenerを登録し、QueryModelで特定のメソッドを呼び出します。詳細は、QueryModelを参照してください。

QueryEventは、ユーザーの問合せ実行のアクションに応じて起動します。たとえばユーザーが「検索」ボタンをクリックすると起動します。また、現在選択されている「保存済の検索」選択リストで、保存済の検索が「自動的に実行」するように構成されている場合にも、起動します。

イベント

フェーズ 説明
oracle.adf.view.rich.event.QueryEvent アプリケーションの起動、
リクエスト値の適用
問合せイベントは、問合せアクションがトリガーされると配信されます。
oracle.adf.view.rich.event.QueryOperationEvent アプリケーションの起動、
リクエスト値の適用
QueryOperationEventは、保存済の検索に対して実行されたすべての操作に関して生成されます。このような操作には、保存済の検索の削除、リセット、選択などが含まれます。
org.apache.myfaces.trinidad.event.AttributeChangeEvent アプリケーションの起動、
リクエスト値の適用
属性変更を記述するために配信されるイベント。属性変更イベントは、プロパティに対するプログラム的な変更については配信されません。アプリケーションの特定のリクエストなしにレンダラによってプロパティが変更される場合にのみ配信されます。属性変更イベントの例には、クライアント側のサイズ変更をサポートしていた列の幅などがあります。

サポートされるファセット

名前 説明
footer 問合せフッターに表示するコンテンツの指定で使用します。フッターの指定がない場合は、自動的にファセットに「フィールドの追加」ドロップダウンが追加されます。footerファセットが指定されている場合は、(カスタム・ボタンなどを含む)デフォルトの「フィールドの追加」ドロップダウンは表示されません。この機能を必要とするユーザーは、footerファセットでその他のコンテンツとともに、これを明示的に指定する必要があります。また、このファセットのコンテンツは、「詳細」モードのみで表示されます。
help 非推奨のファセットであり、ヘルプを提供するには、属性helpTopicIdをかわりに使用する必要があります。(インラインでレンダリングされるときの)helpファセットと指示テキストがあるhelpTopicIdの両方が同じスポットにレンダリングされるため、helpTopicIdが指定され、かつ指示テキストがある場合、インラインで指定されたhelpファセットはレンダリングされません。
ユーザーにはヘルプ・コンテンツが表示されます。ヘルプのコンテンツは、ヘッダー・コンテンツ内にインラインで表示されるか、またはリンクによるポップアップとして表示されます。
info ユーザーに追加情報を提供するコンテンツを指定するために使用します。このコンテンツは通常、検索パネル・ヘッダーの下に表示され、ヘッダーの終端に位置合せされます。
toolbar 問合せヘッダーに表示するコンテンツを指定するために使用します。このファセットのコンテンツは、「基本」モードと「詳細」モードの両方で表示されます。たとえば、「基本」モードと「詳細」モードの両方でカスタムのコマンド・ボタンを表示するには、ボタンをtoolbarファセットに追加します。

属性

名前 ELのサポート 説明
attributeChangeListener javax.el.MethodExpression ELのみ 属性変更リスナーへのメソッド・リファレンス。属性変更イベントは、プロパティに対するプログラム的な変更については配信されません。アプリケーションの特定のリクエストなしにレンダラによってプロパティが変更される場合にのみ配信されます。属性変更イベントの例には、クライアント側のサイズ変更をサポートしていた列の幅などがあります。
binding oracle.adf.view.rich.component.<wbr/>rich.RichQuery ELのみ コンポーネント・インスタンスをBean上に格納するELリファレンス。これは、バッキングBeanからコンポーネントへのプログラム的なアクセスを提供するため、またはコンポーネントの作成をバッキングBeanに移動するために使用できます。
clientComponent boolean あり クライアント側のコンポーネントが生成されるかどうか。このフラグを設定してもしなくてもコンポーネントは生成されますが、クライアントJavascriptがコンポーネント・オブジェクトを必要とする場合、コンポーネントの存在を保証するにはtrueに設定する必要があります。現在デフォルトで生成されるクライアント・コンポーネント・オブジェクトは、将来は存在しない可能性があります。このフラグを設定することがコンポーネントの存在を保証する唯一の方法であり、クライアントは暗黙的な動作に依存できません。ただし、このフラグの設定にはパフォーマンス・コストが伴うため、絶対に必要でないかぎり、クライアントではクライアント・コンポーネントを有効にすることを避ける必要があります。
conjunctionReadOnly boolean あり 論理積がreadOnlyであるかどうかを示します。
customizationId String あり この属性は推奨されていません。永続的なカスタマイズを適用するには、id属性を使用する必要があります。この属性は、次のリリースでは削除されます。
disclosed boolean あり queryコンポーネントの公開が必要かどうかを決定するブール値。
displayMode String あり 有効な値: default、compact、simple

queryコンポーネントの表示モード。
  • default: queryコンポーネントのすべての部分を表示します。
  • compact: defaultに似ていますが、このモードでは次の点が異なります。
    • ヘッダーのテキストはレンダリングされず、headerTextのプロパティが常に無視されます。
    • 公開プロパティを明示的にtrueに設定していない場合、コンポーネントは非公開でレンダリングされます。
    • modeButtonPositionのプロパティをtoolbarに設定していない場合、モード・ボタンはフッターにレンダリングされます。modeChangeVisibleのプロパティがfalseに設定されている場合は、レンダリングされません。
    • 保存済の検索のドロップダウンのレイアウトは、ヘッダーの左に位置合せされます。
    • ヘッダーまたはツールバーの周囲にコンテナまたは境界線は表示されません。
  • simple: このモードでは、ヘッダーおよびフッターはレンダリングされず、disclosed、headerText、modeButtonPosition、modeChangeVisibleのプロパティが無視されます。
fieldWidth String あり 検索フィールドの値部分の幅の推奨値。通常はパーセンテージですが、パーセンテージまたはピクセルの絶対値のいずれかで指定します。幅の指定がないときは、適切にデフォルト設定されます。パーセンテージで指定されているとき、labelWidthおよびfieldWidthの合計は列の数にかかわらず100%になります。fieldWidthがパーセンテージで指定され、labelWidthの指定がないとき、labelWidthには適切な値が導出されます。
headerText String あり 問合せヘッダーのラベル。
helpTopicId String あり helpProviderでトピックを参照するために使用するIDです。
id String なし コンポーネントの識別子。識別子は、HTMLで許可される構文のサブセットに準拠している必要があります。
  • 長さゼロの文字列は指定しないでください。
  • 最初の文字は、ASCII文字(A-Za-z)またはアンダースコア(_)にする必要があります。
  • 後続の文字は、ASCII文字または数字(A-Za-z0-9)、アンダースコア(_)またはダッシュ(-)にする必要があります。
inlineStyle String あり このコンポーネントに対して使用するCSSスタイル。これは、基本スタイルの変更用です。inlineStyleは、コンポーネントのルートDOM要素に適用されるCSSスタイルのセットです。inlineStyleのCSSプロパティが対象となるDOM要素に影響を与えない場合は、スキンを作成し、特定のDOM要素をターゲットにしたスキニング・キーを使用する必要があります(::label、::icon-styleなど)。
labelAlignment String あり 有効な値: start、top

検索フィールド(基準)に対するラベルの位置合せのプロンプト。startはラベルを演算子および値フィールドの前に置きます。topはラベルを演算子および値フィールドの上にレンダリングします。
labelWidth String あり ラベルの幅の推奨値。通常はパーセンテージですが、パーセンテージまたはピクセルの絶対値のいずれかで指定します。幅の指定がないときは、適切にデフォルト設定されます。パーセンテージで指定されているとき、labelWidthおよびfieldWidthの合計は列の数にかかわらず100%になります。fieldWidthがパーセンテージで指定され、labelWidthの指定がないとき、labelWidthには適切な値が導出されます。
maxColumns int あり 表示する列の最大値。このプロパティはデフォルトで3に設定されています。(検索フィールドを含む)panelFormが別のpanelForm内にある場合は、常に1になります。
modeButtonPosition String あり 有効な値: footer、toolbar

モード・ボタンの場所が表示されます。有効な値はfooterおよびtoolbar(デフォルト)です。
modeChangeVisible boolean あり モード変更ボタンのレンダリング。このボタンは、基本モードと詳細モードを切り替えるために使用します。また、queryコンポーネントおよびquickQueryコンポーネント間での切り替えの選択は、toolbarファセットにcommandButtonを追加することで可能になります。commandButtonのactionListenerは、セッション・スコープのマネージドBeanに関連付けることができます。
model oracle.adf.view.rich.model.QueryModel あり queryコンポーネントのモデル全体をまとめて表すQueryModelオブジェクト。QueryModelはQueryDescriptorを管理します。つまり、QueryDescriptorを作成、クローニング(既存のものから)、削除、リセットおよび更新する各種メソッドをサポートします。QueryModelの詳細は、oracle.adf.view.rich.model.QueryModelのJavadocを参照してください。
partialTriggers String[] あり 部分更新をトリガーするコンポーネントのID。このコンポーネントは、トリガー・コンポーネント上でリスニングします。トリガー・コンポーネントの1つがなんらかの更新を発生させるイベントを受信した場合、このコンポーネントも更新されることをリクエストします。識別子はソース・コンポーネント(このコンポーネント)に対して相対的であり、NamingContainerで構成されている必要があります。コンポーネントがすでにネーミング・コンテナ内にある場合、単一のコロンを使用するとページのルートから検索を開始でき、複数のコロンを使用するとNamingContainerを上方向に移動できます。たとえば、::を前に置くと、コンポーネントのネーミング・コンテナ(または、コンポーネントがネーミング・コンテナである場合にはそのコンポーネント自体)から出てそこから検索を開始します。:::を前に置くと、2つのネーミング・コンテナ(コンポーネントがネーミング・コンテナである場合にはそのコンポーネント自体も含まれます)から出てそこから検索を開始します。
queryListener javax.el.MethodExpression ELのみ Querylistenerへのメソッド・リファレンス
queryOperationListener javax.el.MethodExpression ELのみ QueryOperationlistenerへのメソッド・リファレンス
rendered boolean あり コンポーネントがレンダリングされるかどうか。falseに設定した場合、このコンポーネントについて出力は配信されません(コンポーネントはどのような方法でもレンダリングされず、クライアントで表示できません)。
resultComponentId String あり 結果コンポーネント(通常、tableまたはtreeTable)を識別する検索式。これは問合せ結果を表示します。式はこのソース・コンポーネントに対して相対的であり、NamingContainerで構成されている必要があります。結果コンポーネントがすでに名前コンテナ内にある場合、単一のコロンを付加するとルートから検索を開始でき、複数のコロンを付加するとNamingContainerを上方向に移動できます。たとえば、::を前に置くと、コンポーネントのネーミング・コンテナ(または、コンポーネントがネーミング・コンテナである場合にはそのコンポーネント自体)から出てそこから検索を開始します。:::を前に置くと、2つのネーミング・コンテナ(コンポーネントがネーミング・コンテナである場合にはそのコンポーネント自体も含まれます)から出てそこから検索を開始します。検索操作がコンポーネントの部分ページのリフレッシュをトリガーするように、製品チームはこの値が正しく設定されていることを確認する必要があります。また、「結果レイアウトの保存」機能(現在の保存済検索に適用されます)は、この値をモデルのUIHintとして使用します。
rows int あり 行の数。この後から新規の列を開始します。この属性はデフォルトでInteger.MAX_VALUEに設定されます。実際にレンダリングされる行の数も、maxColumnsプロパティに依存します。子が指定の行および列の数に合わないとき、行の数は子と一致するまで増加します。
saveQueryMode String あり 有効な値: default、readOnly、hidden

保存済の検索の表示モードおよび使用方法
  • default: 保存済の検索がすべて表示されます。また、保存済の検索は作成できますが、削除/更新できるのは、ユーザーが保存した検索のみです。
  • readOnly: 保存済の検索を表示および選択できますが、編集はできません。
  • hidden: 保存済の検索はすべて非表示になります。
shortDesc String あり コンポーネントの短い説明。このテキストは、通常、ツールチップ・ヘルプ・テキストを表示するためにユーザー・エージェントによって使用されます。この場合、ツールチップの動作はユーザー・エージェントによって制御されます。たとえば、Firefox 2では長いツールチップは切り捨てられます。フォーム・コンポーネントの場合、shortDescはノート・ウィンドウに表示されます。
simple boolean あり ヘッダーおよびフッターをレンダリングするかどうかを決定するブール。この属性は推奨されません。かわりにdisplayMode=simpleを使用してください。
styleClass String あり このコンポーネントに対して使用するCSSスタイル・クラス。スタイル・クラスは、jspxページまたはスキニングCSSファイルなどで定義できます。または、AFInstructionTextのようなパブリック・スタイル・クラスの1つを使用できます。
value oracle.adf.view.rich.model.QueryDescriptor あり QueryDescriptorオブジェクト。現在選択されている保存済の検索に関する情報を提供します。QueryDescriptorの詳細は、oracle.adf.view.rich.model.QueryDescriptorを参照してください。
visible boolean あり コンポーネントの可視性。falseの場合、コンポーネントはクライアント上で非表示となります。renderedとは異なり、これはサーバーでのライフサイクルには影響を与えません(コンポーネントに実行済バインディングがある、など)。コンポーネントの可視性は、クライアント上で切り替えるか、PPRを使用して切り替えることができます。renderedがfalseの場合、コンポーネントはどのような方法でもレンダリングされず、クライアントで表示できません。ほとんどの場合、visibleプロパティのかわりにrenderedプロパティを使用します。
次のレンダーキットではサポートされていません。 org.apache.myfaces.trinidad.core