Oracle® Fusion Middleware Oracle Application Development Framework Webユーザー・インタフェース開発者ガイド 11g リリース1 (11.1.1.6.0) B52029-06 |
|
![]() 前 |
![]() 次 |
この章では、データの入力、値の選択、テキストの編集およびファイルのロードに使用される入力コンポーネントについて説明します。
この章では、次の項目について説明します。
入力コンポーネントは、様々な形式のユーザー入力を受け入れます。最も一般的な形式はテキスト、数値、日付および選択リストで、フォーム内に表示され、フォームの送信時に送信されます。入力された値や選択内容は、検証および変換され、さらに処理されます。たとえば、File Explorerアプリケーションには、ユーザーによる新しいファイルの作成が可能なフォームが含まれます。図9-1に示すように、ユーザーは入力コンポーネントを使用して、名前やサイズの入力、権限の選択、キーワードおよび説明の追加を行います。
テキスト、数値、日付または色の入力に使用される標準の入力コンポーネントに加え、ADF Facesには、その他の機能を持つ入力タイプ・コンポーネントも用意されています。inputFile
コンポーネントを使用すると、ユーザーはロードするファイルを参照できます。
richTextEditor
コンポーネントには、異なるフォント、サイズ、行揃えおよびその他の編集機能を使用した書式設定可能な、多数の行にわたるリッチ・テキスト入力が用意されています。richTextEditor
コンポーネントは、コマンド・コンポーネントとともに使用でき、特定のテキストをコンポーネントに挿入することもできます。挿入テキストは事前にフォーマットできます。また、エディタのツールバーに表示されるボタンをカスタマイズできます。
選択コンポーネントを使用すると、値を入力するかわりに、または値の入力に加えて、ユーザーが項目のリストから選択できるようになります。たとえば、selectOneChoice
コンポーネントを使用すると、ユーザーはドロップダウン・リストから入力内容を選択でき、selectOneRadio
コンポーネントを使用すると、ラジオ・ボタンのグループから選択できるようになります。
リストの表示には、選択コンポーネントまたは値リスト(LOV)コンポーネントを使用できます。LOVコンポーネントは、選択リストが大きい場合に使用します。LOVコンポーネントは、ListOfValueModel
クラスを使用したモデル駆動型で、APIを使用してプログラムで構成されます。選択リストは、ポップアップ・ウィンドウ内に表示され、問合せパネルが含まれていることもあります。選択リストは単に値の静的リストを表示します。LOVコンポーネントの使用の詳細は、第11章「値リスト・コンポーネントの使用方法」を参照してください。
selectItem
コンポーネントは別の選択コンポーネント内で使用され、そのコンポーネントの選択可能な個々の項目を表します。たとえば、selectOneRadio
コンポーネントでは、各ラジオ・ボタンにselectItem
コンポーネントを使用します。ラジオ・ボタンの選択内容がコーヒー、紅茶、牛乳の場合、コーヒー、紅茶、牛乳のそれぞれにselectItem
コンポーネントを使用します。
フォーム・コンポーネントには、その他のコンポーネント用のコンテナがあります。form
コンポーネントは、埋め込まれた入力コンポーネントからの値を送信できるリージョンを表します。formコンポーネントをネストさせることはできません。ただし、subform
コンポーネントを使用して、form内で個別にコンポーネント値を送信できるサブリージョンを定義することで、さらに柔軟性を高められます。resetButton
コンポーネントを使用すると、ユーザーは、formまたはsubform内の入力値を簡単に以前の状態にリセットできるようになります。
すべての入力および選択コンポーネントは、ValueChangeEvent
およびAttributeChangeEvent
イベントを送信します。対応するイベントに応じて機能を提供するには、valueChangeListener
およびattributeChangeListener
メソッドを作成します。
すべての入力コンポーネント、選択コンポーネント(selectItem
を除く)およびリッチ・テキスト・エディタ・コンポーネントには、changed
属性があり、この属性がtrue
に設定されていると、value
フィールドの変更時に変更インジケータ・アイコンが表示されます。このインジケータを使用すると、ユーザーは、どの入力値が変更されたか、ページに複数のコンポーネントがある場合に、どのコンポーネントが便利かを簡単に確認できます。デフォルトで、変更インジケータは通常コンポーネントの左側に表示されます。市区町村が入力されて郵便番号が自動的に生成されるなど、別のフィールド値の変更によりフィールドの値が自動的に変更される場合は、郵便番号フィールドにも変更インジケータが表示されます。図9-2に、チェック・ボックスおよび入力コンポーネントに表示された変更済インジケータを示します。
入力コンポーネントの大半は、ラベルのみを表示する機能もあり、コンポーネントにマウスを置くまでは値を変更できると表示されません。ユーザーが値を変更すると、その新しい値は読取り専用として表示されます。図9-3に、アクセス時のみ編集できるように構成されているselectManyChoice
コンポーネントを示します。
入力コンポーネントにも、ツールチップ、エラーや検証のメッセージ、およびコンテキスト依存ヘルプを表示できます。詳細は、第17章「ヒント、メッセージおよびヘルプの表示」を参照してください。
すべての入力コンポーネントには、プロパティ値を設定または取得するのに使用可能なJavaScriptクライアントAPIがあります。詳細は、ADF Faces JavaScript APIのドキュメントを参照してください。
formは、その他のコンポーネントのコンテナとして機能するコンポーネントです。フォーム内で送信アクションが発生すると、変更された入力値が送信されます。たとえば、入力コンポーネントと選択コンポーネントで構成される入力フォーム、および送信コマンド・ボタンを作成し、すべてをform内に配置できます。ユーザーが複数の入力フィールドに値を入力して送信ボタンをクリックすると、それらの新しい入力値が送信されて処理されます。
JDeveloperでJSFページを作成すると、デフォルトで、ページにform
コンポーネントが自動的に挿入されます。ページにコンポーネントを追加すると、form
コンポーネント内に挿入されます。
ヒント: ページに |
例9-1に、2つの入力コンポーネント、およびクリックされると両方の入力値が送信されて処理される送信ボタンを示します。
例9-1 入力コンポーネントのコンテナとしてのADF Facesのform
<af:form> <af:panelFormLayout> <af:inputText value="#{myBean.firstName}" label="#{First Name}" </af:inputText> <af:inputText value="#{myBean.lastName}" label="#{Last Name}" </af:inputText> <f:facet name="footer"> <af:commandButton text="Submit"/> </f:facet> </af:panelFormLayout> </af:form>
ページに使用できるform
コンポーネントは1つのみであるため、入力値を送信できる個別のリージョンを作成するには、form内にsubformを使用します。リージョンにおいて、subform内の値は、subform内のコンポーネントが値の送信を行う場合にのみ検証および処理されます。また、subform内に別のsubformをネストさせて、値を送信できるネストしたリージョンを作成することもできます。subformの詳細は、4.5項「サブフォームを使用したページでの領域の作成」を参照してください。
例9-2に、それぞれに独自の入力コンポーネントと送信ボタンを含む2つのsubformがあるformを示します。送信ボタンをクリックすると、そのsubform内の入力値のみが送信されて処理されます。
例9-2 form内のADF Facesのsubform
<af:form> <af:subform> <af:panelFormLayout> <af:inputText value="#{myBean.firstName}" </af:inputText> <af:inputText value="#{myBean.lastName}" </af:inputText> <f:facet name="footer"> <af:commandButton text="Submit"/> </f:facet> </af:panelFormLayout> </af:subform> <af:subform> <af:panelFormLayout> <af:inputText value="#{myBean.primaryPhone}" </af:inputText> <af:inputText value="#{myBean.cellPhone}" </af:inputText> <f:facet name="footer"> <af:commandButton text="Submit"/> </f:facet> </af:panelFormLayout> </af:subform> </af:form>
基本的な送信ボタンの他に、form内にその他のコマンド・コンポーネントを追加して、そのform内の任意のフィールドで機能させることができます。ADF Facesには、resetButton
コンポーネントという特殊なコマンド・コンポーネントがあり、これをクリックすると、form内のすべての入力および選択コンポーネントがリセットされます。つまり、値の編集が可能なすべてのコンポーネントが、現在のモデルの値で更新されます。resetButton
コンポーネントでは、検証や変換でエラーがなく、サーバーへの部分的または完全な送信が成功している以前の状態に入力コンポーネントがリセットされ、この点でHTMLのリセットと異なります。たとえば、ユーザーが値
A
を入力して送信ボタンをクリックし、値をA
からB
に変更してresetButton
コンポーネントをクリックすると、値A
がリストアされます。
多くの場合、JDeveloperを使用してformコンポーネントを追加します。ただし、手動でのformの追加や、特定の属性値を使用したformの構成が必要な場合があります。
ページにformを追加する手順:
コンポーネント・パレットの「共通コンポーネント」パネルから、ページに「フォーム」をドラッグ・アンド・ドロップします。
プロパティ・インスペクタで、「共通」セクションを開きます。ここでは、オプションで次の内容を設定できます。
defaultCommand: [Enter]キーが押され、form内にフォーカスがある場合に、アクションを起動する必要のあるコマンド・コンポーネントのID属性を指定します。
usesUpload: formでファイルのアップロードをサポートするかどうかを指定します。ファイルのアップロードの詳細は、9.9項「ファイルのアップロード機能の使用方法」を参照してください。
targetFrame: 新しいページを表示するかどうかを指定します。使用可能な値は、HTMLのターゲット属性の有効な値です。デフォルトは、_self
です。
ページのセクションで値を個別に送信できることが必要な場合は、formコンポーネント内にsubformコンポーネントを追加する必要があります。
ページにsubformを追加する手順:
コンポーネント・パレットの「共通コンポーネント」パネルから、form
コンポーネントの子として、ページに「サブ・フォーム」をドラッグ・アンド・ドロップします。
プロパティ・インスペクタを使用して、次の設定を行います。
default: subformで値を送信済であると仮定するかどうかを指定します。デフォルト値false
に設定すると、その他のsubform
コンポーネントが送信されていない場合にのみ、そのsubform
コンポーネントは送信済とみなされます。true
に設定すると、そのsubformコンポーネントは値を送信済とみなされます。
ヒント:
|
default Command: [Enter]キーが押され、subform内にフォーカスがある場合に、アクションを起動する必要のあるコマンド・コンポーネントのID属性を指定します。
formまたはsubformに、resetButton
コンポーネントを追加できます。リセット・ボタンは、そのformまたはsubform内のコンポーネントでのみ機能します。
ページにリセット・ボタンを追加する手順:
コンポーネント・パレットの「共通コンポーネント」パネルから、ページに「Reset Button」をドラッグ・アンド・ドロップします。
プロパティ・インスペクタを使用して、次の設定を行います。
text: ボタンのテキスト・ラベルを指定します。
disabled: ボタンを無効にするかどうかを指定します。たとえば、ボタンを無効化する必要のある特定の状況を判断するEL式を入力できます。
ピッカー、スライダ、スピン・ボックスなど、入力コンポーネントには多くのバリエーションがありますが、inputText
コンポーネントは、値入力のための基本的な入力コンポーネントです。inputText
コンポーネントは、1行の入力フィールドとして定義することも、rows
属性を1より大きい値に設定してテキスト領域として定義することもできます。ただし、複数行のテキスト入力を作成する場合は、9.8項「richTextEditorコンポーネントの使用方法」で説明されているように、richTextEditor
コンポーネントの使用を検討します。
secret
属性をtrue
に設定することで、パスワードなどの入力値を非表示にできます。その他のADF Facesコンポーネントと同じように、inputText
コンポーネントではラベル、テキストおよびメッセージがサポートされています。このコンポーネントをラベルなしで表示する場合は、simple
属性をtrue
に設定します。図9-4に、1行のinputText
コンポーネントを示します。
rows
属性を使用すると、inputText
コンポーネントに複数行のテキストを表示できます。rows
属性を1より大きい数に設定し、simple
属性をtrueに設定すると、dimensionsFrom
属性を使用して、inputText
コンポーネントがそのコンテナに合うように拡大されるように構成できます。コンポーネントが拡大される方法の詳細は、8.2.1項「ジオメトリ管理およびコンポーネントの拡大」を参照してください。図9-6に、複数行のinputText
コンポーネントを示します。
複数のinputText
コンポーネントを追加して、入力フォームを作成できます。図9-5に、3つのinputText
コンポーネントと「発行」コマンド・ボタンを使用した入力フォームを示します。
コマンド・コンポーネントと連携して、inputText
コンポーネントに特定のテキストを挿入するinsertTextBehavior
タグも構成できます。入力するテキストには、簡単な文字列、またはその他のコンポーネントの値(selectOneChoice
コンポーネントで選択したリスト項目など)を指定できます。たとえば、図9-6は、ユーザーがすでにテキストを入力したinputText
コンポーネントを示しています。
この後、ユーザーがドロップダウン・リストから追加テキストを選択し、コマンド・ボタンをクリックすると、図9-7に示すように、inputText
コンポーネントにそのテキストが表示されます。
第8章「Webページ上のコンテンツの編成」で説明されている任意のレイアウト・コンポーネントに、inputText
コンポーネントを使用できます。
inputTextコンポーネントを追加する手順:
コンポーネント・パレットの「共通コンポーネント」パネルから、ページに「入力テキスト」をドラッグ・アンド・ドロップします。
プロパティ・インスペクタで、「共通」セクションを開いて次の設定を行います。
label: ラベルとして使用するテキストを指定するための値を入力します。
使用するテキストがリソース・バンドルに格納されている場合は、ドロップダウン・リストを使用して「テキスト・リソースの選択」を選択します。「テキスト・リソースの選択」ダイアログを使用して、既存のバンドル内の適切なテキストを検索するか、既存のバンドル内に新しいエントリを作成します。リソース・バンドルの使用方法の詳細は、第21章「ページの国際化およびローカライズ」を参照してください。
value: コンポーネントの値を指定します。値のELバインディングが、set
メソッドではなくget
メソッドが指定されているBeanプロパティを指していて、それが値の編集が可能なコンポーネントの場合、コンポーネントは読取り専用モードでレンダリングされます。
「外観」セクションを開き、次の設定を行います。
columns: フィールドに入力可能な最大の文字数を入力し、テキスト・コントロールのサイズを指定します。
rows: 表示される行数を入力し、テキスト・コントロールの高さを指定します。デフォルト値は1で、1行の入力フィールドを生成します。行数は、ブラウザのデフォルトのフォント・サイズに基づいて見積られます。2以上に設定する場合は、wrap
属性も設定する必要があります。
secret: 1行のテキスト・コントロールにのみ適用されるブール値を指定します。true
に設定されている場合、secret
属性により、テキストの実際の値がユーザーには非表示になります。
wrap: 複数行のテキスト・コントロールで使用されるテキストの折返しタイプを指定します。この属性は、1行のコンポーネントでは無視されます。デフォルトでは属性がsoft
に設定されており、複数行のテキストは視覚的には折り返されますが、送信される値に改行は含まれません。この属性をoff
に設定すると折返しは無効にされ、複数行のテキストは水平にスクロールして表示されます。hard
に設定すると、行の折返しに必要な改行がテキストの値に含まれます。
showRequired: フィールドが必須であることを視覚的に表示するかどうかを指定します。required
属性をtrue
に設定しても、視覚的な表示が行われることに注意してください。showRequired
属性を使用するのは、別のフィールドの値が変更された場合にのみフィールドが必須になるときです。
changed: フィールドの値が変更された場合に、青丸を表示するかどうかを指定します。これをtrue
に設定する場合は、changedDesc
属性も設定する必要があります。
changedDesc: 変更されたアイコン上にマウスが置かれた場合に、ツールチップに表示するテキストを指定します。デフォルトで、テキストは「変更済」です。このテキストは、異なる値を指定することでオーバーライドできます。
accessKey: フィールドにアクセスするために押すキーを指定します。
labelAndAccessKey: ラベルとアクセス・キーを別々に指定するかわりに、2つを結合して、アクセス・キーがラベルの一部になるようにします。アクセス・キーとして使用する文字の前にアンパサンド(&)を付けます。
たとえば、フィールドのラベルが「Description」で、Dをアクセス・キーにする場合は、&Description
と入力します。
注意: 値はXMLのページ・ソースに格納されるため、アンパサンド(&)文字をエスケープする必要があります。そのため、ソース・ページでは、アンパサンドを意味する文字 |
simple: ラベルを表示しない場合にtrue
に設定します。
「動作」セクションを開き、次の設定を行います。
required: 値が必要かどうかを指定します。true
に設定されている場合、値を入力する必要があることをユーザーに知らせるために視覚的に表示されます。値が入力されない場合、例外が発生し、コンポーネントの検証が失敗します。
readOnly: コントロールを、値の編集が可能なフィールドとして表示するか、出力スタイルのテキスト・コントロールとして表示するかを指定します。
autoSubmit: 値が変更されたらコンポーネントを自動的に送信するかどうかを指定します。autoSubmit
属性の使用の詳細は、4.3項「最適化されたライフサイクルの使用」を参照してください。
autoTab: 現在のコンポーネントの最大長に達した場合に、フォーカスを次のタブ位置に自動的に移動するかどうかを指定します。
maximumLength: テキスト・コントロールに入力できる1行当たりの最大文字数を指定します。これには、改行を表す文字も含まれます。0以下に設定されている場合、maximumLength
属性は無視されます。Internet Explorerのようなブラウザでは、改行は2文字として扱われます。
converter: コンバータ・オブジェクトを指定します。詳細は、6.3項「変換の追加」を参照してください。
validator: EL式を使用して、バリデータ・メソッドへのメソッド参照を指定します。詳細は、6.5項「検証の追加」を参照してください。
「その他」セクションを開き、次の設定を行います。
dimensionsFrom: inputText
コンポーネントでジオメトリ管理をどのように処理するかを指定します。この属性には、次のいずれかを設定します。
auto
: inputText
コンポーネントの親コンポーネントで子の拡大ができる場合は、rows
属性が1より大きい数に設定されており、simple
属性がtrue
に設定されているかぎり、親コンポーネントに合せてinputText
コンポーネントが拡大されます。親コンポーネントで拡大できない場合は、inputText
コンポーネントがコンテンツからディメンションを取得します。
content: inputText
コンポーネントがコンポーネント・コンテンツからディメンションを取得します。これはデフォルト設定です。
parent
: inputText
コンポーネントがinlineStyle
属性からディメンションを取得します。inlineStyle
に値が存在しない場合、サイズは親コンテナによって決定されます。
editable: コンポーネントを常に編集可能として表示するかどうかを指定します。そのようにする場合は、always
を選択します。ユーザーがマウスを置くまで値を読取り専用として表示する場合は、onAccess
を選択します。値を祖先コンポーネントから継承する場合は、inherit
を選択します。
注意:
|
insertTextBehavior
タグは、コマンド・コンポーネントと連携して、inputText
コンポーネントに特定のテキストを挿入します。入力するテキストには、簡単な文字列、またはその他のコンポーネントの値(selectOneChoice
コンポーネントで選択したリスト項目など)を指定できます。inputText
コンポーネントにテキストを挿入できるようにするには、テキストの挿入に使用されるコマンド・コンポーネントの子としてinsertTextBehavior
タグを追加します。
注意:
|
開始前
insertTextBehavior
タグを追加する前に、9.3.1項「inputTextコンポーネントの追加方法」の説明に従って、inputText
コンポーネントを作成する必要があります。clientComponent
属性をtrue
に設定します。
テキスト挿入動作を追加する手順:
テキストを挿入するためにユーザーがクリックするコマンド・コンポーネントを追加します。手順は、18.2.1項「コマンド・ボタンおよびコマンド・リンクの使用方法」を参照してください。
コンポーネント・パレットの「操作」パネルから、「テキストの挿入動作」をコマンド・コンポーネントの子としてドラッグ・アンド・ドロップします。
テキスト挿入動作ダイアログで、次の内容を入力します。
for: ドロップダウン矢印を使用して「編集」を選択し、テキストを挿入するinputText
コンポーネントに移動して選択します。
value: 挿入するテキストの値を入力します。静的テキストを挿入する場合は、そのテキストを入力します。ユーザーが別のコンポーネントの値(selectOneChoice
コンポーネントの値など)を挿入できるようにする場合は、その値に解決されるEL式を入力します。例9-3に、ドロップダウン・リストの値または静的テキストの値を挿入できるinputText
コンポーネントのページ・コードを示します。
例9-3 insertTextBehaviorタグの使用
<af:inputText clientComponent="true" id="idInputText" label="String value" value="#{demoInput.value}" rows="10" columns="60"/> <af:selectOneChoice id="targetChoice" autoSubmit="true" value="#{demoInput.choiceInsertText}" label="Select text to insert"> <af:selectItem label="Some Text." value="Some Text."/> <af:selectItem label="0123456789" value="0123456789"/> <af:selectItem label="~!@#$%^*" value="~!@#$%^*"/> <af:selectItem label="Two Lines" value="\\nLine 1\\nLine 2"/> </af:selectOneChoice> <af:commandButton text="Insert Selected Text" id="firstButton" partialTriggers="targetChoice"> <af:insertTextBehavior for="idInputText" value="#{demoInput.choiceInsertText}"/> </af:commandButton> <af:commandButton text="Insert Static Text"> <af:insertTextBehavior for="idInputText" value="Some Static Text."/> </commandButton>
デフォルトでは、コマンド・コンポーネントをクリックしてアクション・イベントがトリガーされるとテキストが挿入されます。ただし、プロパティ・インスペクタでinsertTextBehavior
コンポーネントのtriggerType
属性のドロップダウン・メニューからイベントを選択することで、これを別のクライアント・イベントに変更できます。
スライダ・コンポーネントを使用すると、スライダ上の位置が値に対応している1つまたは2つのマーカーがあるスライダを作成できます。スライダの値が表示され、一方にはマイナス・アイコンが、もう一方にはプラス・アイコンがあります。ユーザーはマーカーを選択し、スライダ上を移動させて値を選択します。図9-8(水平レイアウト)および図9-9(垂直レイアウト)に示すように、inputNumberSlider
コンポーネントにはマーカーが1つあり、ユーザーはスライダから値を1つ選択できます。
図9-10に示すように、inputRangeSlider
コンポーネントにはマーカーが2つあり、ユーザーは範囲のエンド・ポイントを選択できます。
図9-11に示すように、inputNumberSpinbox
は、数値用の入力フィールド、および入力フィールドの現在の値を増減させるための上矢印キーと下矢印キーのセットを作成する入力コンポーネントです。
inputNumberSlider
またはinputRangeSlider
コンポーネントを追加する際には、表示される数値の範囲と増分を決定できます。
inputNumberSliderまたはinputRangeSliderコンポーネントを追加する手順:
コンポーネント・パレットの「共通コンポーネント」パネルから、ページに入力数値スライダまたは範囲入力スライダをドラッグ・アンド・ドロップします。
プロパティ・インスペクタで、「共通」セクションを開いて、次の属性を設定します(inputRangeSlider
コンポーネントの場合は、「データ」セクションも開きます)。
label: コンポーネントのラベルを指定します。
minimum: 選択可能な最小値を指定します。この値は、スライダの開始値です。
maximum: 選択可能な最大値を指定します。この値は、スライダの終了値です。
minimumIncrement: 最小の増分値を指定します。これは、ユーザーがプラスまたはマイナスのアイコンをクリックすると適用される増分です。
majorIncrement: 大きい方の2つの目盛り間の距離を指定します。この値では、ラベル付きの値が表示されるようにします。たとえば、図9-10のinputRangeSlider
コンポーネントのmajorIncrement
値は5.0
です。0
未満の場合、大きい方の増分値は表示されません。
minorIncrement: 小さい方の2つの目盛り間の距離を指定します。0未満の場合、小さい方の増分値は表示されません。
value: コンポーネントの値を指定します。value
のELバインディングが、set
メソッドではなくget
メソッドが指定されているBeanプロパティを指している場合、コンポーネントは読取り専用モードでレンダリングされます。
「外観」セクションを開き、「向き」を設定して、コンポーネントを水平または垂直レイアウトのどちらにするかを指定します。この項のその他の属性の詳細は、9.3.1項「inputTextコンポーネントの追加方法」を参照してください。
inputNumberSpinbox
コンポーネントを使用すると、ユーザーは一連の数値をスクロールして値を選択できるようになります。
inputNumberSpinboxコンポーネントを追加する手順:
コンポーネント・パレットの「共通コンポーネント」パネルから、ページに「入力数値スピンボックス」をドラッグ・アンド・ドロップします。
プロパティ・インスペクタの「データ」セクションを開き、次の設定を行います。
value: コンポーネントの値を指定します。value
のELバインディングが、set
メソッドではなくget
メソッドが指定されているBeanプロパティを指している場合、コンポーネントは読取り専用モードでレンダリングされます。
minimum: 入力フィールドで許可される最小値を指定します。
maximum: 入力フィールドで許可される最大値を指定します。
stepSize: スピン・ボックスが入力フィールドの数値を増減する際の増分を指定します。
「外観」セクションを開き、属性を設定します。これらの属性設定の詳細は、9.3.1項「inputTextコンポーネントの追加方法」を参照してください。
ユーザーがマウスを置くまでスピンボックスの値を読取り専用として表示する場合は、「その他」セクションを開き、「編集可能」をonAccess
に設定します。コンポーネントを常に編集可能として表示する場合は、always
を選択します。値を祖先コンポーネントから継承する場合は、inherit
を選択します。
注意:
|
inputColor
コンポーネントを使用すると、色のコードを入力するためのテキスト入力フィールドと、パレットから色を選択するためのボタンを作成できます。デフォルトの色のコード形式は16進の色の形式です。ただし、ColorConverter
クラスを使用して書式設定をオーバーライドできます。
デフォルトで、inputColor
コンポーネントにより、ユーザーがパレットから色を選択できるようにするchooseColor
コンポーネントが開かれます。図9-12に、ポップアップ・ダイアログのchooseColor
コンポーネントが含まれるinputColor
コンポーネントを示します。
inputDate
コンポーネントを使用すると、図9-13に示すように、日付を入力するためのテキスト入力フィールドと、ポップアップ・カレンダから日付を選択するためのボタンを作成できます。デフォルトの日付フォーマットは、現在のロケールに適切な省略の日付フォーマットです。たとえば、米語(ENU)のデフォルトの書式はmm/dd/yy
です。ただし、この書式は日時コンバータを使用してオーバーライドできます(コンバータの使用方法の詳細は、6.3項「変換の追加」を参照してください)。
日時コンバータを追加して、日付と時間の両方を表示するように構成すると、ユーザーが時間を入力するための追加のコントロールのある日付ピッカーがモーダル・ダイアログとして表示されます。また、コンバータがタイムゾーンを表示するように構成されている場合、図9-14に示すように、ダイアログ内にタイムゾーン・ドロップダウン・リストが表示されます。
inputColor
コンポーネントを使用すると、ユーザーによる入力テキスト・フィールドへの値の入力や、カラー・チューザからの色の選択が可能になります。
inputColorコンポーネントを追加する手順:
コンポーネント・パレットの「共通コンポーネント」パネルから、ページに「入力色」をドラッグ・アンド・ドロップします。
プロパティ・インスペクタで、「共通」セクションを開いて次の設定を行います。
label: コンポーネントのラベルを指定します。
compact: 図9-15に示すように、入力テキスト・フィールドを表示しない場合はtrue
に設定します。
「データ」セクションを開き、次の属性を設定します。
value: コンポーネントの値を指定します。value
のELバインディングが、set
メソッドではなくget
メソッドが指定されているBeanプロパティを指している場合、コンポーネントは読取り専用モードでレンダリングされます。
colorData: 標準のカラー・パレットに表示される色のリストを指定します。表示される色の数は、49(7色x7色)、64(8色x8色)または121(11色x11色)です。この属性に設定される数値により、width
属性の有効な値が決定されます。たとえば、colorData
属性を49に設定した場合、幅は7にする必要があります。数が幅に合っていない場合、リストの余分な色要素は無視され、欠落している色要素は色なしとして表示されます。色のリストは、クライアント側ではタイプTrColor
の配列であることが必要です。
customColorData: カスタム定義の色のリストを指定します。色の数は7、8、11のいずれかです。色のリストは、クライアント側ではタイプTrColor
の配列であることが必要です。サーバー側では、java.awt.Color
オブジェクトのリストであるか、16進の色の文字列であることが必要です。
defaultColor: #000000
など、16進の色のコードを使用してデフォルトの色を指定します。
「外観」セクションを開き、次の属性を設定します。
width: セルにおける標準のパレットの幅を指定します。有効な値は7、8および11で、colorData
およびcustomColorData
属性の値に対応します。
customVisible: 「カスタム・カラー」ボタンおよびカスタム・カラー行を表示するかどうかを指定します。true
に設定すると、「カスタム・カラー」ボタンおよびカスタム・カラー行がレンダリングされます。
defaultVisible: 「デフォルト」ボタンを表示するかどうかを指定します。true
に設定すると、「デフォルト」ボタンがレンダリングされます。「デフォルト」ボタンを使用すると、ユーザーはdefaultColor
属性の値として、簡単に色のセットを選択できるようになります。
lastUsedVisible: 「最終使用」ボタンを表示するかどうかを指定します。true
に設定すると、「最終使用」ボタンがレンダリングされ、ユーザーは前回使用した色を選択できるようになります。
「動作」セクションを開き、次の属性を設定します。
chooseId: 色の値の選択に使用できるchooseColor
コンポーネントのID
を指定します。設定しない場合、inputColor
コンポーネントには、chooseColor
コンポーネントが使用された独自のデフォルトのポップアップ・ダイアログが使用されます。
ユーザーがマウスを置くまでコンポーネントの値を読取り専用として表示する場合は、「その他」セクションを開き、「編集可能」をonAccess
に設定します。コンポーネントを常に編集可能として表示する場合は、always
を選択します。値を祖先コンポーネントから継承する場合は、inherit
を選択します。
注意:
|
inputDate
コンポーネントを使用すると、ユーザーは日付の入力または選択を実行できます。
inputDateコンポーネントを追加する手順:
コンポーネント・パレットの「共通コンポーネント」パネルから、ページに「入力日」をドラッグ・アンド・ドロップします。
プロパティ・インスペクタの「共通」セクションで、次の設定を行います。
label: コンポーネントのラベルを指定します。
value: コンポーネントの値を指定します。value
のELバインディングが、set
メソッドではなくget
メソッドが指定されているBeanプロパティを指している場合、コンポーネントは読取り専用モードでレンダリングされます。
「データ」セクションを開き、次の属性を設定します。
minValue: 日付値に許可される最小値を指定します。タグで固定値に設定されている場合、この値はISO 8601の日付として解析されます。ISO 8601の日付は、yyyy-MM-dd(2002-02-15など)の形式です。この他すべての使用方法では、java.util.Date
オブジェクトが必要です。
maxValue: 日付値に許可される最大値を指定します。タグで固定値に設定されている場合、この値はISO 8601の日付として解析されます。ISO 8601の日付は、yyyy-MM-dd(2002-02-15など)の形式です。この他すべての使用方法では、java.util.Date
オブジェクトが必要です。
disableDays: org.apache.myfaces.trinidad.model.DateListProvider
インタフェースの実装へのバインディングを指定します。getDateList
メソッドによって、無効に指定される個々のjava.util.Date
オブジェクトのリストが生成されます。日付は、指定されたベース・カレンダのコンテキストに存在する必要があります。
パフォーマンスのヒント: このバインディングには、定期的なラウンドトリップが必要です。特定の曜日(土曜日および日曜日など)のみを無効にする場合は、 |
disableDaysOfWeek: 各週に無効の状態でレンダリングする必要のある曜日を空白で区切ったリストで指定します。リストには、sun
、mon
、tue
、wed
、thu
、fri
、sat
の1つ以上の略語を含める必要があります。デフォルトでは、すべての曜日が有効です。
disableMonths: 各年に無効の状態でレンダリングする必要のある月を空白で区切ったリストで指定します。リストには、jan、feb、mar、apr、may、jun、jul、aug、sep、oct、nov、dec
の1つ以上の略語を含める必要があります。デフォルトでは、すべての月が有効です。
「動作」セクションを開き、chooseIdを設定します。日付値の選択に使用できるchooseDate
コンポーネントのID
を指定します。設定しない場合、inputDate
コンポーネントには、chooseDate
コンポーネントが使用された独自のポップアップ・ダイアログが使用されます。
ユーザーがマウスを置くまでコンポーネントの値を読取り専用として表示する場合は、「その他」セクションを開き、「編集可能」をonAccess
に設定します。コンポーネントを常に編集可能として表示する場合は、always
を選択します。値を祖先コンポーネントから継承する場合は、inherit
を選択します。
注意:
|
タイム・ソーンのプレースホルダz
をコンバータのパターンに含めるなど、関連するコンバータがタイム・ゾーンのドロップダウン・リストを表示するように構成されている場合、inputDate
コンポーネントはデフォルトでタイム・ゾーンのドロップダウン・リストを表示します。エンド・ユーザーが変更できるのは、このリストを使用したタイム・ゾーンのみです。このリストは、一般的なタイム・ゾーンを表示するように構成されます。
ただし、inputDate
コンポーネントの外部でタイム・ゾーンのリストを表示する必要が生じる場合もあります。たとえば、「アプリケーション・プリファレンス」ページで、アプリケーションのすべてのinputDates
を表示するのに使用されるタイム・ゾーンをユーザーが選択できるselectOneChoice
コンポーネントを使用するとします。バッキングBeanでは、タイム・ゾーンのIDとjava.util.TimeZone
オブジェクト間の変換が処理されます。アプリケーションのinputDate
インスタンスのコンバータでは、タイム・ゾーンをそのタイム・ゾーンのオブジェクトにバインドします。
このリストには、DateTimeUtils
クラスのAPIまたはコンポーネントのEL式のいずれかを使用してアクセスできます。
DateTimeUtils
クラスのメソッドは次のとおりです。
getCommonTimeZoneSelectItems ()
: 一般的に使用されるタイム・ゾーンのリストを返します。
getCommonTimeZoneSelectItems (String timeZoneId)
: 一般的に使用されるタイム・ゾーンのリストを返します(リストの一部の場合は、指定のタイム・ゾーンを含む)。
ELを使用してリストにアクセスするには、次の式のいずれかを使用します。
af:getCommonTimeZoneSelectItems
次に例を示します。
<f:selectItems value="#{af:getCommonTimeZoneSelectItems()}" id="tzones2" />
af:getMergedTimeZoneSelectItems (id)
次に例を示します。
<f:selectItems value="#{af:getMergedTimeZoneSelectItems(demoInput.preferredTimeZoneId)}" id="tzones" />
inputDate
コンポーネントとそのタイム・ゾーンの選択リストを同じページで使用している場合は、inputDate
のタイム・ゾーンのローカル値をクリアし、その選択の値バインディングが優先されるようにします。それ以外の場合は、NULL意外のローカル値が優先され、inputDate
コンポーネントは更新されない場合があります。例9-4では、inputDate
コンポーネントへのバインディング属性を使用してバッキングBeanに参照が含まれます。ユーザーが新しいタイム・ゾーンを選択すると、IDが設定され、inputDate
のコンバータがコードで取得されてタイム・ゾーンがクリアされます。ページがレンダリングされると、コンバータのタイム・ゾーンのローカル値がNULLになるため、#{demoInput.preferredTimeZone}
が評価され、更新されたタイム・ゾーンが取得されます。
例9-4 inputDateとタイム・ゾーンの選択リストの併用
<af:selectOneChoice label="Select a new timezone" value="#{demoInput.preferredTimeZoneId}" autoSubmit="true"> <f:selectItems value="#{af:getMergedTimeZoneSelectItems(demoInput.preferredTimeZoneId)}" id="tzones" /> </af:selectOneChoice> <af:inputDate label="First inputDate with timezone bound" id="bound1" partialTriggers="tzpick" binding="#{demoInput.boundDate1}"> <af:convertDateTime type="both" timeStyle="full" timeZone="#{demoInput.preferredTimeZone}"/> </af:inputDate> DemoInputBean.java public void setPreferredTimeZoneId(String _preferredTimeZoneId) { TimeZone tz = TimeZone.getTimeZone(_preferredTimeZoneId); setPreferredTimeZone (tz); this._preferredTimeZoneId = _preferredTimeZoneId; } public void setPreferredTimeZone(TimeZone _preferredTimeZone) { this._preferredTimeZone = _preferredTimeZone; DateTimeConverter conv1 = (DateTimeConverter) _boundDate1.getConverter(); conv1.setTimeZone(null); }
選択コンポーネントを使用すると、ユーザーは項目のリストやグループから、単一または複数の値を選択できるようになります。ADF Facesには、単純なブール・ラジオ・ボタンから、ユーザーが複数の項目を選択できるリスト・ボックスまで、様々な選択コンポーネントがあります。選択コンポーネント内の項目のリストは、複数のselectItem
コンポーネントで構成されています。
selectItem
コンポーネントを除くすべての選択コンポーネントは、ValueChangeEvent
およびAttributeChangeEvent
イベントを送信します。selectItem
コンポーネントは、AttributeChangeEvent
イベントのみを送信します。これらのイベント用に、valueChangeListener
ハンドラまたはattributeChangeListener
ハンドラ(あるいはその両方)を作成する必要があります。
selectBooleanCheckbox
コンポーネント値は、オブジェクトではなく常にブールに設定する必要があります。図9-16に示すように、選択された状態と未選択の状態が切り替えられます。
selectBooleanRadio
コンポーネントではブール選択が表示され、常にブールに設定する必要があります。selectBooleanCheckbox
コンポーネントとは異なり、selectBooleanRadio
コンポーネントでは、同じgroup
属性を使用して、selectBooleanRadio
コンポーネントをグループ化できます。
たとえば、ユーザーの年齢が10~18才かどうかを決定するブールと、19~100才かどうかを決定するブールがあるとします。図9-17に示すように、2つのselectBooleanRadio
コンポーネントはページの任意の場所に配置できるため、横に並べて配置する必要はありません。同じgroup
値を共有しているかぎり、ページ内での物理的な配置にかかわらず、選択は相互に排他的になります。
ヒント: 各 |
ユーザーが1つの値を選択できるラジオ・ボタンのリストを作成するには、図9-18に示すように、selectOneRadio
コンポーネントを使用します。
ユーザーが1つ以上の値を選択できるチェック・ボックスのリストを作成するには、図9-19に示すように、selectManyCheckbox
コンポーネントを使用します。
selectOneListbox
コンポーネントを使用すると、図9-20に示すように、ユーザーは影付きのボックスに表示された項目のリストから値を1つ選択できるコンポーネントを作成できます。
selectManyListbox
コンポーネントは、ユーザーが項目リストから多くの値を選択できるコンポーネントを作成するものです。図9-21に示すように、このコンポーネントには、チェック・ボックスのリストの先頭に表示される「すべて」チェック・ボックスが含まれます。
selectOneChoice
コンポーネントを使用すると、ユーザーが項目のドロップダウン・リストから値を1つ選択できるメニュー形式のコンポーネントを作成できます。selectOneChoice
コンポーネントは、ドロップダウン・リストの項目が比較的少ない場合に使用します。
ベスト・プラクティス: 多数の項目が必要な場合は、かわりに |
図9-22に、selectOneChoice
コンポーネントを示します。
図9-23に示すように、selectOneChoice
コンポーネントは、コンパクト・モードで表示されるように構成できます。コンパクト・モードでは、入力フィールドが小さなアイコンに置き換えられます。
ユーザーがアイコンをクリックすると、図9-24に示されているようにドロップダウン・リストが表示されます。
selectManyChoice
コンポーネントを使用すると、ユーザーが項目のドロップダウン・リストから複数の値を選択できるメニュー形式のドロップダウン・コンポーネントを作成できます。このコンポーネントは、選択項目のリストの先頭に表示される「すべて」選択項目を含めるように構成できます。図9-25に示すように、選択肢の数が15より多い場合は、スクロールバーが表示されます。
デフォルトでは、ページがレンダリングされる際にselectManyChoice
コンポーネントが構築されると、すべてのselectItem
子コンポーネントが構築されます。ただし、リスト項目のアクセス方法が遅いと、パフォーマンスが妨害される場合があります。このような遅延は、ユーザーが項目を選択して、後でアクセスした際に変更しない可能性がある場合に特に問題になります。たとえば、ページに表示する内容をフィルタするのにselectManyChoice
コンポーネントを使用し、selectItem
子コンポーネントの値にWebサービスからアクセスするとします。また、ページにアクセスするたびに、ユーザーがその選択を変更しない可能性があるとします。デフォルトでは、ページがレンダリングされるたびに、ユーザーが実際にそれらを表示する必要があるかに関係なく、すべてのselectItems
を構築する必要があります。かわりに、selectManyChoice
コンポーネントのcontentDelivery
属性をimmediate
(デフォルト)からlazy
に変更できます。lazy
設定では、ユーザーがドロップダウンをクリックした場合にのみselectItem
コンポーネントが構築されます。
immediate
およびlazy
の両方で、ユーザーが選択した際に、選択したselectItem
コンポーネントの値がフィールドに表示されます。ただし、コンテンツの遅延配信が使用されると、後にアクセスした際に、選択した値がselectItem
コンポーネント(これらのコンポーネントの構築が必要)ではなく、lazySelectedLabel
属性から取得されます。通常、この属性は、選択した項目を表すStrings
の配列を返すメソッドにバインドされます。selectItem
コンポーネントは、ユーザーがドロップダウンを使用してそれらを表示または変更するまで構築されません。
selectManyChoice
コンポーネントのlazy
配信メソッドの使用には制限があります。selectManyChoice
コンポーネントのコンテンツ配信および制限の詳細は、9.6.2項「SelectManyChoiceコンポーネントのcontentDelivery属性について」を参照してください。
次のコンポーネントの場合、コントロールの上にラベルを表示させるには、これらをpanelFormLayout
コンポーネント内に配置します。
selectOneChoice
selectOneRadio
selectOneListbox
selectManyChoice
selectManyCheckbox
selectManyListbox
次のコンポーネントでは、セキュリティ上の理由から、属性disabled
、immediate
、readOnly
、required
、requireMessageDetail
およびvalue
をクライアント上のJavaScriptから設定することはできません(詳細は、3.7.1項「クライアントでのプロパティ値の設定方法」を参照してください)。
selectOneChoice
selectOneRadio
selectOneListbox
selectBooleanRadio
selectBooleanCheckbox
selectManyChoice
selectManyCheckbox
selectManyListbox
選択コンポーネントの追加手順は、どのコンポーネントでも同じです。まず、選択コンポーネントを追加して属性を構成します。次に、リスト内の個々の項目用に任意の数のselectItem
コンポーネントを追加して構成します。
選択コンポーネントを使用する手順:
コンポーネント・パレットの「共通コンポーネント」パネルから、ページに選択コンポーネントをドラッグ・アンド・ドロップします。
selectBooleanCheckbox
およびselectBooleanRadio
コンポーネント以外のすべての選択コンポーネントで、マネージドBeanの値にバインドするか、静的リストを作成するかを選択するダイアログが開きます。ダイアログの2番目のページで、次のプロパティを設定できます。
label: リストのラベルを入力します。
requiredMessageDetail: ユーザーが選択を行わない場合に表示するメッセージを入力します。メッセージの詳細は、17.3項「検証および変換用のヒントとエラー・メッセージの表示」を参照してください。
validator: マネージドBeanの検証メソッドに解決されるEL式を入力します(詳細は、第6章「入力の検証および変換」を参照してください)。
value: コンポーネントの値を指定します。value
のELバインディングが、set
メソッドではなくget
メソッドが指定されているBeanプロパティを指している場合、コンポーネントは読取り専用モードでレンダリングされます。
注意:
|
valueChangeListener: 値変更イベントを処理するマネージドBeanのリスナーに解決されるEL式を入力します。
プロパティ・インスペクタの「外観」セクションを開き、表9-1に説明されている属性を設定します。ここで説明するのは、選択コンポーネントに固有の属性のみであることに注意してください。多くの属性は、テキスト入力コンポーネントと同じです。詳細は、9.3.1項「inputTextコンポーネントの追加方法」を参照してください。
表9-1 選択コンポーネントの外観属性
コンポーネント | 属性 |
---|---|
|
layout: |
|
size: リストに表示する項目の数に設定します。リスト内の項目数が |
|
selectAllVisible: |
|
mode: |
|
unselectedLabel: |
プロパティ・インスペクタの「動作」セクションを開き、表9-2に説明されている属性を設定します。ここで説明するのは、選択コンポーネントに固有の属性のみであることに注意してください。多くの属性は、テキスト入力コンポーネントと同じです。詳細は、9.3.1項「inputTextコンポーネントの追加方法」を参照してください。
表9-2 選択コンポーネントの動作属性
コンポーネント | 属性 |
---|---|
ブール選択コンポーネントを除くすべて |
valuePassThru: クライアントに値をパススルーするかどうかを指定します。 選択コンポーネントがADFモデル・バインディングを使用している場合、この値は無視されます。 |
|
group: 同じ |
ユーザーがマウスを置くまでselectOneChoice
またはselectManyChoice
コンポーネントの値を読取り専用として表示する場合は、「その他」セクションを開き、「編集可能」をonAccess
に設定します。コンポーネントを常に編集可能として表示する場合は、always
を選択します。値を祖先コンポーネントから継承する場合は、inherit
を選択します。
注意:
|
ページがレンダリングされるたびにselectManyChoice
のselectItem
子コンポーネントを構築しない場合は、次のようにします。
選択した項目のラベルを格納し、これらのラベルを文字列の配列としても返すことができるロジックを作成します。
「その他」セクションを開き、contentDeliveryをlazyに設定します。
選択した項目の配列を返すメソッドにLazySelectedLabelをバインドします。
コンテンツの遅延配信の使用には制限があることに注意してください。selectManyChoice
コンポーネントのコンテンツ配信の詳細は、9.6.2項「SelectManyChoiceコンポーネントのcontentDelivery属性について」を参照してください。
ブール・コンポーネントの場合は、ブール・コンポーネントの子として、任意の数のselectItem
コンポーネントをドラッグ・アンド・ドロップします。これらはリストの項目を表します(その他の選択コンポーネントの場合は、手順2のダイアログにより自動的に追加されます)。
selectItem
コンポーネントが選択された状態で、プロパティ・インスペクタの「共通」セクションを開き、設定されていない場合はvalue
属性に値を入力します。これが送信される値です。
「外観」セクションを開き、設定されていない場合はlabel属性の値を入力します。これがリストに表示されるテキストです。
項目が無効化された状態でリストに表示されるようにする場合は、「動作」セクションを開いて、「無効」をtrue
に設定します。
selectManyChoice
コンポーネントのcontentDelivery
属性がimmediate
(デフォルト)に設定されている場合は、次のようになります。
ページへの最初のアクセス:
ページがレンダリングされると、selectManyChoice
およびすべてのselectItem
コンポーネントが構築されます。項目が多い場合や、selectItem
コンポーネントの値にWebサービスなどからアクセスすると、これによりパフォーマンスの問題が発生する場合があります。
selectManyChoice
コンポーネントによってレンダリングされると、まだ選択されていないため、フィールドには何も表示されません。
ユーザーがドロップダウンをクリックすると、すべての項目が表示されます。
ユーザーが項目を選択すると、選択したselectItem
コンポーネントの対応するラベルがフィールドに表示されます。
ページが送信されると、値がモデルにポストバックされます。
以降のアクセス: ページがレンダリングされると、selectManyChoice
およびすべてのselectItem
コンポーネントが構築されます。選択したselectItem
コンポーネントのラベルがフィールドに表示されます。これにより、ページに最初にアクセスした場合と同じパフォーマンスの問題が発生します。
selectManyChoice
コンポーネントのcontentDelivery
属性がlazy
に設定されている場合は、次のようになります。
ページへの最初のアクセス:
ページがレンダリングされると、selectManyChoice
が構築されますが、selectItem
コンポーネントは構築されません。
selectManyChoice
コンポーネントによってレンダリングされると、まだ選択されていないため、フィールドには何も表示されません。
ユーザーがドロップダウンをクリックすると、selectItem
コンポーネントが構築されます。これが発生している間、ユーザーにはビジー・スピナーが表示されます。コンポーネントが構築されると、すべての項目が表示されます。
ユーザーが項目を選択すると、選択したselectItem
コンポーネントの対応するラベルがフィールドに表示されます。
ページが送信されると、値がモデルにポストバックされます。
以降のアクセス:
ページが最初にレンダリングされるときは、selectManyChoice
コンポーネントのみが構築されます。この時点では、選択した項目の表示にlazySelectedLabel
属性の値が使用されます。
ユーザーがドロップダウンをクリックすると、selectItem
コンポーネントが構築されます。これが発生している間、ユーザーにはビジー・スピナーが表示されます。コンポーネントが構築されると、すべての項目が表示されます。
selectItem
コンポーネントが構築されると、selectManyChoice
コンポーネントの動作は、contentDelivery
属性がimmediate
に設定された場合のようになり、selectItem
コンポーネントの実際の値を使用して、選択した項目を表示します。
selectManyChoice
コンポーネントでコンテンツの遅延配信を使用する場合の制限事項は、次のとおりです。
selectManyChoice
の値をリクエスト・スコープに格納することはできません。ポストバック時に、値属性は、クライアントから返されるものをデコードするのではなく。モデルからアクセスされます。値がリクエスト・スコープに保存されている場合、値は空になります。値はリクエスト・スコープに保存しないでください。
ポストバック時に、コンバータはコールされません。ポストバックにコンバータを利用している場合は、コンテンツの遅延配信を使用しないでください。
画面がレンダリング・モードの場合、contentDelivery
属性は無視されます。selectItem
コンポーネントは、ページがレンダリングされると常に構築されます。
selectManyShuttle
およびselectOrderShuttle
コンポーネントを使用すると、ユーザーが一方のリスト・ボックスからもう一方のリスト・ボックスに項目を移動するための2つのリスト・ボックスおよびボタンを作成できます。ユーザーは、先行(Available values)リスト・ボックスと後続(Selected values)リスト・ボックスの間を移動させる単一の項目または複数の項目を選択できます。どちらのコンポーネントでも、コントロールの上にラベルを表示する場合には、それらをpanelFormLayout
コンポーネント内に配置します。
図9-26に、selectManyShuttle
コンポーネントを示します。
図9-27に示すように、selectOrdershuttle
コンポーネントには、ユーザーが「選択した値」リスト・ボックスの値を並べ替えるために使用する上矢印および下矢印ボタンを追加で含めることができます。リストを並べ替えると、ValueChangeEvent
イベントが送信されます。readOnly
属性をtrue
に設定した場合は、並べ替える値が、後続リスト(「選択した値」)に表示される選択済の値であることを確認します。
その他のselectMany
コンポーネント同様、これらのコンポーネントのvalue
属性は、含まれているselectItem
コンポーネントのうちの1つの値に対応する値のリストまたは配列であることが必要です。selectItems
の1つの値がリストまたは配列にある場合、その項目は後続リストに表示されます。selectManyListbox
コンポーネントはselectManyShuttle
に直接変換できるため、value
によってリスト・ボックスに選択される項目が決まるのではなく、selectOrderShuttle
コンポーネントの後続リストにどの項目が表示されるかが影響を受けます。
その他の選択コンポーネント同様、項目のリストまたは配列は、selectManyShuttle
またはselectOrderShuttle
コンポーネントにネストしているselectItem
コンポーネントで構成されています。例9-5に、ユーザーがファイル・タイプのリストから上位5つのファイル・タイプを選択できるselectOrderShuttle
コンポーネントのサンプルを示します。
例9-5 selectOrderShuttleのJSFページ・コード
<af:selectOrderShuttle value="#{helpBean.topFive}" leadingHeader="#{explorerBundle['help.availableFileTypes']}" trailingHeader="#{explorerBundle['help.top5']}" simple="true"> <af:selectItem label="XLS"/> <af:selectItem label="DOC"/> <af:selectItem label="PPT"/> <af:selectItem label="PDF"/> <af:selectItem label="Java"/> <af:selectItem label="JWS"/> <af:selectItem label="TXT"/> <af:selectItem label="HTML"/> <af:selectItem label="XML"/> <af:selectItem label="JS"/> <af:selectItem label="PNG"/> <af:selectItem label="BMP"/> <af:selectItem label="GIF"/> <af:selectItem label="CSS"/> <af:selectItem label="JPR"/> <af:selectItem label="JSPX"/> <f:validator validatorId="shuttle-validator"/> </af:selectOrderShuttle>
selectOrdershuttle
コンポーネントのreorderOnly
属性をtrue
に設定すると、移動機能が無効にされ、「選択した値」リスト・ボックスのみが表示されます。図9-28に示すように、ユーザーは、リスト・ボックス内の項目の並替えのみを実行できます。
シャトル・コンポーネントの追加手順は、どちらのコンポーネントも同じです。まず、選択コンポーネントを追加して属性を構成します。次に、リスト内の個々の項目用に任意の数のselectItem
コンポーネントを追加して構成します。
selectManyShuttleまたはselectOrderShuttleコンポーネントを追加する手順:
コンポーネント・パレットの「共通コンポーネント」パネルから、ページにシャトルを複数選択またはオーダー・シャトルを選択をドラッグ・アンド・ドロップします。
マネージドBeanの値にバインドするか、静的リストを作成するかを選択するダイアログが表示されます。ダイアログの2番目のページでは、次の設定が可能です。
label: リストのラベルを入力します。
requiredMessageDetail: ユーザーが選択を行わない場合に表示するメッセージを入力します。メッセージの詳細は、17.3項「検証および変換用のヒントとエラー・メッセージの表示」を参照してください。
size: リストの表示サイズ(項目の数)を指定します。指定するサイズは、10から20項目の範囲である必要があります。属性が設定されていない場合、または10より小さい値の場合、サイズはデフォルトまたは最小値の10になります。指定された属性値が20項目より多い場合、サイズは最大値の20になります。
validator: マネージドBeanの検証メソッドに解決されるEL式を入力します。
value: コンポーネントの値を指定します。value
のELバインディングが、set
メソッドではなくget
メソッドが指定されているBeanプロパティを指している場合、コンポーネントは読取り専用モードでレンダリングされます。
valueChangeListener: 値変更イベントを処理するマネージドBeanのリスナーに解決されるEL式を入力します。
プロパティ・インスペクタで「外観」セクションを開き、次の設定を行います。
layout: コンポーネントを水平または垂直レイアウトのどちらにするかを指定します。デフォルトはhorizontal
で、先行および後続のリスト・ボックスは相互に隣り合って表示されます。vertical
に設定すると、先行のリスト・ボックスは後続のリスト・ボックスの上に表示されます。
leadingHeader: シャトル・コンポーネントの先行リストのヘッダー・テキストを指定します。
leadingDescShown: true
に設定すると、先行のリスト・ボックスの下部に選択された項目の説明が表示されます。
trailingHeader: シャトル・コンポーネントの後続リストのヘッダーを指定します。
trailingDescShown: true
に設定すると、後続のリスト・ボックスの下部に選択された項目の説明が表示されます。
「動作」セクションを開き、オプションで次の属性を設定します。
valuePassThru: クライアントに値をパススルーするかどうかを指定します。valuePassThru
がfalse
の場合、この値およびオプションの値は、索引に変換されてからクライアントに送信されます。そのため、valuePassThru
がfalse
の場合、値またはオプション、あるいはその両方としてカスタム・オブジェクトを使用するときに、独自のコンバータを記述する必要はありません。クライアント側での実際の値を知る必要がある場合は、valuePassThru
をtrue
に設定できます。これにより、カスタム・コンバータが使用可能な場合は、カスタム・コンバータを使用して、クライアントに値が渡されます。カスタム・コンバータは、カスタム・オブジェクトを使用する場合に必要です。デフォルトはfalse
です。
reorderOnly(selectOrderShuttle
コンポーネントのみ): シャトル・コンポーネントを並替え専用モードにするかどうかを指定します(ユーザーは値リストの順序を変更できますが、追加や削除はできません)。
構造ウィンドウでselectItem
コンポーネントの1つを選択し、プロパティ・インスペクタで必要な属性を設定します。
ヒント: 先行または後続のリスト・ボックスに説明を表示することを選択した場合は、各 |
項目選択のイベントに対応して処理を実行するJavaScriptコードを作成することで、ユーザーが一方のリストからもう一方のリストに項目を移動する前に、選択されたそれぞれの項目に関する情報をユーザーに提供できます。たとえば、コードで項目に関する追加の情報を取得し、ユーザーが項目を移動するかどうかの選択を支援するポップアップとして表示できます。図9-29に、selectManyShuttle
コンポーネントを示します(ユーザーはMeyersを選択しており、ポップアップでこの選択に関する追加の情報が提供されています)。
この機能は、selectManyShuttle
またはselectOrderShuttle
コンポーネントにクライアント・リスナーを追加し、このイベントを処理するJavaScriptメソッドを作成して実装します。JavaScriptコードは、ユーザーがリストから項目を選択すると実行されます。イベントのクライアント・リスナーの使用方法の詳細は、3.2項「クライアント・イベントのリスニング」を参照してください。
選択イベントを処理するシャトル・コンポーネントにクライアント・リスナーを追加する方法:
コンポーネント・パレットの「操作」パネルから、「クライアント・リスナー」をシャトル・コンポーネントの子としてドラッグ・アンド・ドロップします。
「クライアント・リスナーの挿入」ダイアログで、「メソッド」フィールドに関数名(次の手順でこの関数を実装します)を入力し、タイプ・ドロップダウンから「propertyChange
」を選択します。
たとえば、関数としてshowDetailsを入力した場合、JDeveloperにより、例9-6に太字で示されたコードが入力されます。
例9-6 選択を登録するためのclientListenerの使用
<af:selectManyShuttle value="#{demoInput.manyListValue1}"
valuePassThru="true" ...>
<af:clientListener type="propertyChange" method="showDetails"/>
<af:selectItem label="coffee" value="bean" />
...
</af:selectManyShuttle>
このコードにより、showDetails
関数は、プロパティ値が変更されるたびにコールされます。
JavaScriptで、前の手順で入力された関数を実装します。この関数により、次の操作が実行されます。
イベントのソースを取得して、シャトル・コンポーネントを取得します。
クライアントJavaScript APIコールを使用して、選択した項目の情報を取得します。
例9-7では、AdfShuttleUtils.getLastSelectionChange
をコールして、最後に選択された項目の値が取得されています。
例9-7 選択の処理に使用されるJavaScriptメソッドshowDetailsのサンプル
function showDetails(event)
{
if(AdfRichSelectManyShuttle.SELECTION == event.getPropertyName())
{
var shuttleComponent = event.getSource();
var lastChangedValue = AdfShuttleUtils.getLastSelectionChange(shuttleComponent, event.getOldValue());
var side = AdfShuttleUtils.getSide(shuttleComponent, lastChangedValue);
if(AdfShuttleUtils.isSelected(shuttleComponent, lastChangedValue))
{
//do something...
}
else
{
//do something else
}
if(AdfShuttleUtils.isLeading(shuttleComponent, lastChangedValue))
{
//queue a custom event (see serverListener) to call a java method on the server
}
}
}
richTextEditor
コンポーネントは、書式設定されたテキストを使用できる入力フィールドを提供します。ラベル、テキストおよびメッセージもサポートされています。ユーザーは、フォント名、サイズ、スタイルの変更、順序付けられたリストの作成、およびテキストの両端の調整を実行でき、その他の様々な機能も使用できます。richTextEditor
コンポーネントは、HTMLソース・ファイルの編集にも使用できます。2つのコマンド・ボタンを使用して、標準の書式設定されたテキストの編集とHTMLソース・ファイルの編集を相互に切り替えられます。図9-30に、標準のリッチ・テキスト編集モードのリッチ・テキスト・エディタ・コンポーネントを示します。
図9-31に、ソース・コード編集モードのエディタを示します。
次にサポートされているその他の機能を示します。
フォント・タイプ
フォント・サイズ
リンク付け/リンク解除
スタイルのクリア
元に戻す/やり直し
太字/イタリック/下線
下付き/上付き
調整(左、中央、右、均等)
順序付けられたリスト/順序付けられていないリスト
インデント
文字色/背景色
リッチ・テキスト編集モード/ソース・コード編集モード
リッチ・テキスト・エディタの値(入力されたテキスト)は、整形式XHTMLフラグメントです。値の書式設定を可能にするために、ブラウザ固有の要件で値の一部が変更される場合があります。また、セキュリティ上の理由から、スクリプト関連タグや属性などの一部の機能が削除されます。このコンポーネントにより、ユーザーによる最小限の変更のみが記録されるという保証はありません。エディタでXHTMLドキュメントを編集しているため、次の要素が変更される可能性があります。
意味のない空白
要素の最小化
要素タイプ
属性の順序
文字エンティティの使用
エディタでサポートされているのは、次の例外を除いて4つのHTMLタグのみです。
script、noscript
frame、frameset、noframes
フォーム関連要素(input、select、optgroup、option、textarea、form、button、label、isindex)
ドキュメント関連要素(html、head、body、meta、title、base、link)
richTextEditor
コンポーネントでは、コンテンツを取得するタグ(applet
、iframe
、object
、img
およびa
など)もサポートされています。ブラウザで許可されているのは同じドメインのコンテンツとの対話のみであるため、iframe
タグの場合は、コンテンツがページのその他の部分と対話できないようにする必要があります。ただし、ページのこの部分はアプリケーションの管理外です。
richTextEditor
コンポーネントではpx
やem
などのフォント単位はサポートされていませんが、HTML仕様に説明されているように1から7のフォント・サイズはサポートされています。埋込みタグや未知のタグ(<foo>
など)はサポートされていません。
クライアント側では、richTextEditor
コンポーネントで、getValue
およびsetValue
メソッドがサポートされていません。クライアント上のコンポーネントの値が、サーバー上の値と同一であるという保証はありません。そのため、richTextEditor
では、クライアント側のコンバータおよびバリデータがサポートされていません。それでも、サーバー側のコンバータおよびバリデータは機能します。
リッチ・テキスト・エディタでは、ValueChangeEvent
およびAttributeChangeEvent
イベントが送信されます。必要に応じて、これらのイベント用にvalueChangeListener
およびattributeChangeListener
ハンドラを作成します。
コマンド・コンポーネントと連携して、richTextEditor
コンポーネントに特定のテキストを挿入するrichTextEditorInsertBehavior
タグも構成できます。入力するテキストには、簡単な文字列、またはマネージドBeanなどに保持されている事前フォーマット済テキストを指定できます。
デフォルトでは、図9-32に示すように、フォントのサイズや太さ、テキストの文字位置、表示モードなどのテキストの多くの要素をrichTextEditor
コンポーネントのツールバーで変更できます。
図9-33に、カスタマイズされているツールバーを示します。ツールバー・ボタンのほとんどが削除されており、カスタム・ツールバー・ボタンのあるツールバーとメニューが追加されています。
richTextEditor
コンポーネントを追加すると、テキストを特定の場所に挿入し、ツールバーもカスタマイズできるように構成できます。詳細は、9.8.2項「richTextEditorコンポーネントへのテキストの挿入機能の追加方法」および9.8.3項「ツールバーのカスタマイズ方法」を参照してください。
richTextEditorコンポーネントを追加する手順:
コンポーネント・パレットの「共通コンポーネント」パネルから、ページに「リッチ・テキスト・エディタ」をドラッグ・アンド・ドロップします。
プロパティ・インスペクタの「共通」セクションを開き、value
属性を設定します。
「外観」セクションを開き、次の設定を行います。
rows: 表示される文字の概数で編集ウィンドウの高さを指定します。
columns: 表示される文字の概数で編集ウィンドウの幅を指定します。
label: コンポーネントのラベルを指定します。
「動作」セクションを開き、次の設定を行います。
editMode: WYSIWYGまたはソース・モードを使用してエディタを表示するかどうかを選択します。
contentDelivery: コンポーネントが最初にレンダリングされる際に、エディタ内のデータをフェッチするかどうかを指定します。contentDelivery
属性の値がimmediate
の場合、レンダリングされる際に、データがフェッチされてコンポーネントに表示されます。値がlazy
に設定されている場合は、データがフェッチされて後続のリクエスト中にクライアントに送信されます。詳細は、10.1.1項「コンテンツの配信」を参照してください。
ヒント:
|
richTextEditor
コンポーネントにテキストを挿入できるようにするには、テキストの挿入に使用されるコマンド・コンポーネントの子としてrichTextEditorInsertBehavior
タグを追加します。
開始前に
9.3.1項「inputTextコンポーネントの追加方法」の説明に従って、richTextEditor
コンポーネントを作成する必要があります。clientComponent
属性をtrue
に設定します。
テキスト挿入動作を追加する手順:
テキストを挿入するためにユーザーがクリックするコマンド・コンポーネントを追加します。手順は、18.2.1項「コマンド・ボタンおよびコマンド・リンクの使用方法」を参照してください。
コンポーネント・パレットの「操作」パネルから、「リッチ・テキスト・エディタの挿入動作」をコマンド・コンポーネントの子としてドラッグ・アンド・ドロップします。
リッチ・テキスト・エディタの挿入動作ダイアログで、次の内容を入力します。
for: ドロップダウン矢印を使用して「編集」を選択し、テキストを挿入するrichTextEditor
コンポーネントに移動して選択します。
value: 挿入するテキストの値を入力します。静的テキストを挿入する場合は、そのテキストを入力します。ユーザーが別のコンポーネントの値(selectOneChoice
コンポーネントの値など)を挿入できるようにする場合は、その値に解決されるEL式を入力します。ユーザーに事前フォーマット済テキストを入力させる場合は、そのテキストに解決されるEL式を入力します。たとえば、例9-8は、demoInput
マネージドBeanの属性の値としての事前フォーマット済テキストを示しています。
例9-8 マネージドBeanの事前フォーマット済テキスト
private static final String _RICH_INSERT_VALUE = "<p align=\"center\" style=\"border: 1px solid gray; margin: 5px; padding: 5px;\">" + "<font size=\"4\"><span style=\"font-family: Comic Sans MS, Comic Sans,cursive;\">Store Hours</span></font><br/>\n" + "<font size=\"1\">Monday through Friday 'til 8:00 pm</font><br/>\n" + "<font size=\"1\">Saturday & Sunday 'til 5:00 pm</font>" + "</p>";
例9-9に、テキストがrichTextEditorInsertBehavior
タグからどのように参照されるかを示します。
例9-9 richTextEditorInsertBehaviorタグの使用
<af:richTextEditor id="idRichTextEditor" label="Rich text value" value="#{demoInput.richValue2}"/> . . . </af:richTextEditor> <af:commandButton text="Insert Template Text"> <af:richTextEditorInsertBehavior for="idRichTextEditor" value="#{demoInput.richInsertValue}"/> </af:commandButton>
デフォルトでは、コマンド・コンポーネントをクリックしてアクション・イベントがトリガーされるとテキストが挿入されます。ただし、triggerType
属性のドロップダウン・メニューからイベントを選択することで、これを別のクライアント・イベントに変更できます。
作成するカスタム・ファセットに、追加するツールバーおよびツールバー・ボタンを配置します。次に、含まれている項目の表示方法および表示場所を決定するキーワードとともに、ツールバーの属性からファセットを参照します。
ツールバーをカスタマイズする手順:
コンポーネント・パレットのJSFページで、「コア」パネルから、追加するツールバーの各セクションのファセットをドラッグ・アンド・ドロップします。たとえば、図9-33に示されているカスタム・ボタンを追加するには、2つの<f:facet>
タグを追加します。各ファセットには、ページに対する一意な名前を付けてください。
ヒント: ADF Facesの今後のリリースと競合が生じないようにするには、すべてのファセット名を |
コンポーネント・パレットの「ADF Faces」ページの「共通コンポーネント」パネルから、「ツールバー」を各ファセットにドラッグ・アンド・ドロップして、ツールバー・ボタンおよびその他のコンポーネントを追加し、必要に応じて構成します。ツールバーとツールバー・ボタンの詳細は、ツールバーの使用方法に関する項を参照してください。
richTextEditor
コンポーネントを選択し、プロパティ・インスペクタの「その他」セクションで、toolboxLayout
属性のドロップダウン・アイコンをクリックし、「編集」を選択して「プロパティの編集: ToolboxLayout」ダイアログを開きます。この属性の値は、カスタム・ファセット名のリストに、カスタム・ファセット内のコンテンツを表示する順序で設定する必要があります。これらのファセットのみでなく、次のキーワードを使用して、デフォルトのツールバーのすべてまたは一部を含めることもできます。
all
: デフォルトのツールバーのすべてのツールバー・ボタンおよびテキストです。all
を入力すると、カスタム意外のボタンのキーボードは無視されます。
font
: フォント選択およびフォント・サイズのボタンです。
history
: 元に戻すおよび繰り返しのボタンです。
mode
: リッチ・テキスト・モードおよびソース・コード・モードのボタンです。
color
: 前景および背景色のボタンです。
formatAll
: 太字、イタリック、下線、上付き文字、下付き文字および取消し線のボタンです。formatAll
を指定すると、formatCommon
およびformatUncommon
は無視されます。
formatCommon
: 太字、イタリックおよび下線のボタンです。
formatUncommon
: 上付き文字、下付き文字および取消し線のボタンです。
justify
: 左端揃え、中央端揃え、右端揃えおよび両端揃えのボタンです。
list
: 箇条書きおよび番号付きリストのボタンです。
indent
: インデント解除およびインデントのボタンです。
link
: リンクの追加および削除のボタンです。
たとえば、customToolbar1
およびcustomToolbar2
という名前の2つのファセットを作成し、デフォルトのツールバー全体をカスタム・ツールバーの間に表示させる場合は、次のリストを入力します。
customToolbar1
all
customToolbar2
ツールバーのレイアウトは、次のキーワードを使用して決定することもできます。
newline
: 新しい行の次の名前付きファセット(またはtoolboxLayout
属性のリストの次のキーワード)にツールバーを配置します。たとえば、customToolbar2
ファセットのツールバーを新しい行に表示させる場合、次のリストを入力します。
customToolbar1
all
newline
customToolbar2
かわりに、フォント、色および共通の書式設定のボタン以外のデフォルトのツールバーを使用せずに、これらのボタンを新しい行に表示させたい場合は、次のリストを入力します。
customToolbar1
customToolbar2
newline
font
color
formatCommon
stretch
: 使用可能なすべての領域を埋めるために拡大されるspacerコンポーネントを追加して、次の名前付きファセット(またはデフォルトのツールバーの次のキーワード)がツールバーに右揃えで表示されるようにします。
inputFile
コンポーネントを使用すると、ユーザーにファイルのアップロード機能および更新機能を提供できます。このコンポーネントを使用すると、ユーザーはローカル・ファイルを選択して、サーバーの選択可能な場所にアップロードできます。サーバーからユーザーにファイルをダウンロードするには、18.4.1項「ファイルをダウンロードするためのコマンド・コンポーネントの使用方法」を参照してください。
inputFile
コンポーネントにより、ファイルのアップロード時に標準のValueChangeEvent
イベントが送信され、ロード・プロセスが透過的に管理されます。inputFile
コンポーネントのvalue
プロパティは、ファイルのアップロード時に、org.apache.myfaces.trinidad.model.UploadedFile
クラスのインスタンスに設定されます。
アップロード・プロセスを開始するには、図9-34に示すように、コマンド・ボタンなどのアクション・コンポーネントを作成します。
ファイルがアップロードされ、inputFile
の値がnull以外の場合は、最初のロードが成功した後またはその値が初期値として指定された後に、「更新」ボタンを作成できます(図9-35に示されているように、このボタンは「参照」ボタンのかわりに表示されます)。これにより、inputFile
コンポーネントの値を変更できます。
readOnly
プロパティをtrue
に設定すると、特定のファイルのみをロードできるようにコンポーネントを指定することもできます。図9-36に示すように、このモードでは、指定されたファイルのみをロードできます。
セキュリティ上の理由から、次の属性をクライアントから設定することはできません。
disabled
(unsecure
プロパティが設定されている場合)。詳細は、3.7.2項「無効なプロパティを保護しない方法」を参照してください。
immediate
readOnly
requiredMessageDetail
value
inputFile
コンポーネントは、h:form
タグまたはaf:form
タグのいずれかに配置できますが、いずれの場合も、ファイルのアップロードをサポートできるようにformタグを設定する必要があります。JSFの基本的なHTML h:form
を使用する場合は、enctype
をmultipart/form-data
に設定します。これにより、リクエストがマルチパート・リクエストになり、サーバーへのファイルのアップロードがサポートされます。ADF Facesのaf:form
タグを使用している場合は、usesUpload
をtrue
に設定することにより、enctypeをmultipart/form-data
に設定するのと同じ機能が実行され、ファイルのアップロードがサポートされます。
リッチ・クライアント・フレームワークでは、ファイルの一般的なアップロードが実行されます。アップロード後にファイルを処理(たとえば、xml
ファイル、pdf
ファイルなどの処理)するには、actionListener
またはアクション・メソッドを作成する必要があります。
inputFile
コンポーネントのvalue
は、org.apache.myfaces.trinidad.model.UploadedFile
インタフェースのインスタンスです。このAPIを使用すると、ファイル名、MIMEタイプ、サイズだけでなく、ファイルの実際のバイト・ストリームを取得できます。
注意: APIを使用して、ファイルのアップロード元に関するパス情報をクライアントから取得することはできません。 |
アップロードされたファイルは、ファイルとしてファイル・システムだけでなく、メモリーにも格納できますが、この違いがAPIよって表面化されることはありません。フィルタを使用すると、リクエストの完了後、確実にUploadedFile
コンテンツがクリーン・アップされます。このため、通常はリクエスト全体でUploadedFile
オブジェクトをキャッシュすることはできません。ファイルを保持する必要がある場合は、リクエストが完了する前にファイルを永続記憶域にコピーする必要があります。
たとえば、例9-10に示すように、ファイルを保存するかわりに、マネージドBeanをValueChangeEvent
イベントへのレスポンスとして使用し、ファイルのアップロードが成功したという内容のメッセージを追加します。
例9-10 アップロード・メッセージを表示するためのvalueChangeListenerの使用
JSF Page Code -----> <af:form usesUpload="true"> <af:inputFile label="Upload:" valueChangeListener="#{managedBean.fileUploaded}"/> <af:commandButton text="Begin"/> </af:form> Managed Bean Code ----> import javax.faces.application.FacesMessage; import javax.faces.context.FacesContext; import javax.faces.event.ValueChangeEvent; import org.apache.myfaces.trinidad.model.UploadedFile; public class ABackingBean { ... public void fileUploaded(ValueChangeEvent event) { UploadedFile file = (UploadedFile) event.getNewValue(); if (file != null) { FacesContext context = FacesContext.getCurrentInstance(); FacesMessage message = new FacesMessage( "Successfully uploaded file " + file.getFilename() + " (" + file.getLength() + " bytes)"); context.addMessage(event.getComponent().getClientId(context), message); // Here's where we could call file.getInputStream() } } }
また、例9-11に示すように、値をマネージドBeanに直接バインドすることでアップロードを処理できます。
例9-11 マネージドBeanへの値のバインド
JSF Page Code ----> <af:form usesUpload="true"> <af:inputFile label="Upload:" value="#{managedBean.file}"/> <af:commandButton text="Begin" action="#{managedBean.doUpload}"/> </af:form> Managed Bean Code ----> import org.apache.myfaces.trinidad.model.UploadedFile;public class AManagedBean { public UploadedFile getFile() { return _file; } public void setFile(UploadedFile file) { _file = file; } public String doUpload() { UploadedFile file = getFile(); // ... and process it in some way } private UploadedFile _file; }
Javaクラスは、inputFile
コンポーネントにバインドする必要があります。このクラスにより、アップロードしたファイルの値が含まれます。
inputFileコンポーネントを追加する手順:
入力ファイルの値を保持するJavaクラスを作成します。org.apache.myfaces.trinidad.model.UploadedFile
インタフェースのインスタンスであることが必要です。
コンポーネント・パレットの「共通コンポーネント」パネルから、ページに「入力ファイル」をドラッグ・アンド・ドロップします。
valueを手順1で作成したクラスに設定します。
ユーザーがマウスを置くまでコンポーネントの値を読取り専用として表示する場合は、「その他」セクションを開き、「編集可能」をonAccess
に設定します。コンポーネントを常に編集可能として表示する場合は、always
を選択します。値を祖先コンポーネントから継承する場合は、inherit
を選択します。
注意:
|
コンポーネント・パレットから、ページにコマンド・コンポーネントをドラッグ・アンド・ドロップします。これは、アップロード・プロセスの開始に使用されます。
コマンド・コンポーネントが選択された状態で、actionListener
属性を、アップロード後にファイルを処理するリスナーに設定します。
ADF Facesではアップロードされるファイルが(ディスクまたはメモリーに)一時的に格納されるため、アップロード・ファイルでハード・ドライブやメモリーを一杯にしようとするDoS攻撃を未然に防ぐため、デフォルトでは、許容される着信アップロード・リクエストのサイズが制限されています。デフォルトでは、1つのリクエストで最初の100KBがメモリーに格納されます。これが一杯になると、ディスク領域が使用されます。この場合も、デフォルトでは、すべてのファイルに対し、1つのリクエストで2,000KBのディスク領域に制限されます。これらの制限を超えると、フィルタによりEOFException
がスローされます。
デフォルトで、ファイルはjava.io.File.createTempFile()
が使用する一時ディレクトリに格納され、通常はシステム・プロパティjava.io.tmpdir
によって定義されます。一部のアプリケーションには明らかに不十分であるため、例9-12に示すように、3つのサーブレット・コンテキスト初期化パラメータを使用して、これらの値を構成できます。
例9-12 ファイルのアップロード・サイズおよびディレクトリを定義するパラメータ
<context-param> <!-- Maximum memory per request (in bytes) --> <param-name>org.apache.myfaces.trinidad.UPLOAD_MAX_MEMORY</param-name> <!-- Use 500K --> <param-value>512000</param-value> </context-param> <context-param> <!-- Maximum disk space per request (in bytes) --> <param-name>org.apache.myfaces.trinidad.UPLOAD_MAX_DISK_SPACE</param-name> <!-- Use 5,000K --> <param-value>5120000</param-value> </context-param> <context-param> <!-- directory to store temporary files --> <param-name>org.apache.myfaces.trinidad.UPLOAD_TEMP_DIR</param-name> <!-- Use a TrinidadUploads subdirectory of /tmp --> <param-value>/tmp/TrinidadUploads/</param-value> </context-param> <!-- This filter is always required; one of its functions is file upload. --> <filter> <filter-name>trinidad</filter-name> <filter-class>org.apache.myfaces.trinidad.webapp.TrinidadFilter</filter-class> </filter>
org.apache.myfaces.trinidad.webapp.UploadedFileProcessor
クラス全体をtrinidad-config.xml
構成ファイルの<uploaded-file-processor>
要素に置き換えることで、ファイルのアップロード・プロセスをカスタマイズできます。UploadedFileProcessor
クラスを置き換えると、例9-12にリストされているパラメータは無関係になり、デフォルトのUploadedFileProcessor
クラスによってのみ処理されます。
<uploaded-file-processor>
要素は、oracle.adf.view.rich.webapp.UploadedFileProcessor
インタフェースを実装するクラスの名前である必要があります。このAPIにより、個々のアップロード・ファイルが着信リクエストから取得される際に処理され、そのコンテンツを残りのリクエストで使用できるようになります。大部分のアプリケーションは、デフォルトのUploadedFileProcessor
クラスで十分ですが、大規模ファイルのアップロードをサポートする必要のあるアプリケーションでは、リクエスト中にADF Facesで一時記憶域を処理するかわりに、ファイルをただちに最終的な宛先に格納することでパフォーマンスを向上させます。