<af:document>

af:document document document

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

documentコンポーネントは、HTMLページの標準的なルート要素である<html>、<body>および<head>を作成します。ただしこれは、これらのコンポーネントから抽出することで、非HTMLページでも使用できます。1ページ当たり、1つのドキュメント・コンポーネントが許可されます。ドキュメントは、ページ・テンプレートの内部に配置しないようにする必要があります。

イベント

フェーズ 説明
org.apache.myfaces.trinidad.event.AttributeChangeEvent アプリケーションの起動、
リクエスト値の適用
属性変更を記述するために配信されるイベント。属性変更イベントは、プロパティに対するプログラム的な変更については配信されません。アプリケーションの特定のリクエストなしにレンダラによってプロパティが変更される場合にのみ配信されます。属性変更イベントの例には、クライアント側のサイズ変更をサポートしていた列の幅などがあります。

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

名前 説明
metaContainer メタ・データとしてheadセクションにレンダリングされるコンテンツ。

属性

名前 ELのサポート 説明
attributeChangeListener javax.el.MethodExpression ELのみ 属性変更リスナーへのメソッド・リファレンス。属性変更イベントは、プロパティに対するプログラム的な変更については配信されません。アプリケーションの特定のリクエストなしにレンダラによってプロパティが変更される場合にのみ配信されます。属性変更イベントの例には、クライアント側のサイズ変更をサポートしていた列の幅などがあります。
binding oracle.adf.view.rich.component.<wbr/>rich.RichDocument ELのみ コンポーネント・インスタンスをBean上に格納するELリファレンス。これは、バッキングBeanからコンポーネントへのプログラム的なアクセスを提供するため、またはコンポーネントの作成をバッキングBeanに移動するために使用できます。
clientComponent boolean あり クライアント側のコンポーネントが生成されるかどうか。このフラグを設定してもしなくてもコンポーネントは生成されますが、クライアントJavascriptがコンポーネント・オブジェクトを必要とする場合、コンポーネントの存在を保証するにはtrueに設定する必要があります。現在デフォルトで生成されるクライアント・コンポーネント・オブジェクトは、将来は存在しない可能性があります。このフラグを設定することがコンポーネントの存在を保証する唯一の方法であり、クライアントは暗黙的な動作に依存できません。ただし、このフラグの設定にはパフォーマンス・コストが伴うため、絶対に必要でないかぎり、クライアントではクライアント・コンポーネントを有効にすることを避ける必要があります。
customizationId String あり この属性は推奨されていません。永続的なカスタマイズを適用するには、id属性を使用する必要があります。この属性は、次のリリースでは削除されます。
failedConnectionText String あり XMLHttpRequestデータの転送に失敗した場合に、警告メッセージに表示されるテキスト。これが設定されていないと、エラーが発生したクライアント側のコンソールに、デフォルトのメッセージが出力されます。
次のレンダー・キットではサポートされません。 org.apache.myfaces.trinidad.core
id String なし コンポーネントの識別子。識別子は、HTMLで許可される構文のサブセットに準拠している必要があります。
  • 長さゼロの文字列は指定しないでください。
  • 最初の文字は、ASCII文字(A-Za-z)またはアンダースコア(_)にする必要があります。
  • 後続の文字は、ASCII文字または数字(A-Za-z0-9)、アンダースコア(_)またはダッシュ(-)である必要があります。
initialFocusId String あり ページ全体をレンダリングするときにフォーカスするコンポーネントのID。クライアントでレンダリングするときに通常は使用できないコンポーネントにinitialFocusIdを設定する場合は、そのコンポーネントのclientComponent属性をtrueに設定する必要もあります。また、アクセシビリティ・モードをスクリーン・リーダーに設定すると、initialFocusIdは無視されることに注意してください。これは、ページの先頭にテキスト・コンテンツやヘッダーなどの関心を引くコンテンツが表示される場合があるためです。

識別子はコンポーネントに対して相対的で、NamingContainerで構成されている必要があります。単一のコロンを使用するとルートから検索を開始でき、複数のコロンを使用するとNamingContainerを上方向に移動できます。たとえば、::の場合はコンポーネントのネーミング・コンテナから出てそこから検索が開始され、:::の場合は2つのネーミング・コンテナから出てそこから検索が開始されます。


次のエージェントではサポートされません。 pda
inlineStyle String あり このコンポーネントに対して使用するCSSスタイル。これは、基本スタイルの変更用です。inlineStyleは、コンポーネントのルートDOM要素に適用されるCSSスタイルのセットです。inlineStyleのCSSプロパティが対象となるDOM要素に影響を与えない場合は、スキンを作成し、特定のDOM要素をターゲットにしたスキニング・キーを使用する必要があります(::label、::icon-styleなど)。
maximized boolean あり true(デフォルト)に設定すると、ページの最外端のマージンおよびパディングが0pxになります。ドキュメントが最大化されるよう設定されており、可視できる有効なコンポーネントが1つのみ存在するとき、そのコンポーネントは自動的にストレッチされ、可視できるブラウザの領域が(そのコンポーネントでサポートされている場合)使用されます。これをサポートするコンポーネントの例には、panelStretchLayoutおよびpanelSplitterが含まれます。便宜上、フォーム・コンポーネントがドキュメント・コンポーネントの直接の子であり、それがポップアップおよび非インライン・メッセージの両方を可視できるルート・コンポーネントとして含めない場合、可視できる有効なルート・コンポーネントは、フォーム・コンポーネント内で検索されます。
次のレンダー・キットはサポートされません。 org.apache.myfaces.trinidad.core
onUnload String あり onunloadのJavascriptハンドラ。
次のレンダーキットではサポートされません。oracle.adf.rich
partialTriggers String[] あり 部分更新をトリガーするコンポーネントのID。このコンポーネントは、トリガー・コンポーネント上でリスニングします。トリガー・コンポーネントの1つがなんらかの更新を発生させるイベントを受信した場合、このコンポーネントも更新されることをリクエストします。識別子はソース・コンポーネント(このコンポーネント)に対して相対的であり、NamingContainerで構成されている必要があります。コンポーネントがすでにネーミング・コンテナ内にある場合、単一のコロンを使用するとページのルートから検索を開始でき、複数のコロンを使用するとNamingContainerを上方向に移動できます。たとえば、::を前に置くと、コンポーネントのネーミング・コンテナ(または、コンポーネントがネーミング・コンテナである場合にはそのコンポーネント自体)から出てそこから検索を開始します。:::を前に置くと、2つのネーミング・コンテナ(コンポーネントがネーミング・コンテナである場合にはそのコンポーネント自体も含まれます)から出てそこから検索を開始します。
rendered boolean あり コンポーネントがレンダリングされるかどうか。falseに設定した場合、このコンポーネントについて出力は配信されません(コンポーネントはどのような方法でもレンダリングされず、クライアントで表示できません)。
shortDesc String あり コンポーネントの短い説明。このテキストは、通常、ツールチップ・ヘルプ・テキストを表示するためにユーザー・エージェントによって使用されます。この場合、ツールチップの動作はユーザー・エージェントによって制御されます。たとえば、Firefox 2では長いツールチップは切り捨てられます。フォーム・コンポーネントの場合、shortDescはノート・ウィンドウに表示されます。
styleClass String あり このコンポーネントに対して使用するCSSスタイル・クラス。スタイル・クラスは、jspxページまたはスキニングCSSファイルなどで定義できます。または、AFInstructionTextのようなパブリック・スタイル・クラスの1つを使用できます。
theme String あり このコンポーネントに適用するコンポーネント・スタイル・テーマです。テーマは、子コンポーネントすべてでカスケードされます。テーマ設定されたコンポーネント内でリッチ・コンポーネントによってレンダリングされるHTML要素ではすべて、そのテーマがスタイル・クラスのリストに追加されます。テーマと色調スタイルには互換性がないため、ページ当たりで1つのメソッド(テーマまたは色調スタイル)のみを使用できます。テーマが空白の場合には現在のテーマが削除され、テーマの値がinheritまたはNull、あるいはテーマを設定していない場合には、現在のテーマが使用されます。スキンはテーマのソースです。スキンの中には、定義にテーマが設定されていないものもあります。テーマ名には、dark、medium、lightおよびdefaultを使用することをお薦めします。
title String あり ドキュメントのタイトル(このタイトルを含まれるpanelPageのタイトルに合わせる必要はありません)。
uncommittedDataWarning String あり 有効な値: on、off

ユーザーがページまたはリージョンから移動するときに、未コミット・データに関する警告メッセージを表示するかどうかを指定します。デフォルト値は、off(警告無効)です。このプロパティをonに設定すると、警告が有効になります。
次のレンダーキットではサポートされていません。org.apache.myfaces.trinidad.core
visible boolean あり コンポーネントの可視性。falseの場合、コンポーネントはクライアント上で非表示となります。renderedとは異なり、これはサーバーでのライフサイクルには影響を与えません(コンポーネントに実行済バインディングがある、など)。コンポーネントの可視性は、クライアント上で切り替えるか、PPRを使用して切り替えることができます。renderedがfalseの場合、コンポーネントはどのような方法でもレンダリングされず、クライアントで表示できません。ほとんどの場合、visibleプロパティのかわりにrenderedプロパティを使用します。
次のレンダーキットではサポートされていません。 org.apache.myfaces.trinidad.core