Documentation

フォーム項目タイプのリファレンス

Liferayフォームアプリケーションには、フォームに追加する多くの項目タイプと要素が含まれています。 利用可能な要素を発見するために

  1. プロダクトメニューProduct Menu)を開き、サイト管理メニューのコンパスアイコン(Compass)をクリックします。 フォームを作成するサイトを選択します。

  2. コンテンツ & データ] → [Form] をクリックします。

  3. 追加 ボタン(Add)をクリックします。 フォームビルダービューが表示されます。

  4. 追加 ボタン(Add)をもう一度クリックして、 [要素を追加] サイドバーを表示します(まだ開いていない場合)。

多くの便利なフォーム要素があります。

フィールド設定の概要

フォームビルダーで新しいフィールドを追加したり、既存のフィールドをクリックすると、フィールド設定エディタのサイドバーが表示されます。 使用できる設定オプションは、項目タイプによって異なります。

すべてのフォームフィールドには、ベーシックとアドバンスの少なくとも2つの設定タイプがあります。 多くのフォームが 基本的な設定で作成可能です。フォームには、ラベルや、プレースホルダーテキスト、ヘルプテキストが含まれ、フィールドが必要か、どのようなメッセージが必要かを決められます。 さらにフィールド固有の設定もあります。

[リストから選択]フィールドには、いくつかの基本設定があります。

高度な設定には、 規定値の値、検索設定、フィールドが繰り返し可能かどうか、システム/プログラムのフィールド参照、フィールドの確認、フィールドが隠されているかどうかなどがあります。 さらにフィールド固有の設定もあります。

テキストフィールドにはいくつかの詳細設定があります。

非表示のフィールド

時には、外部ソース( REST データプロバイダなど)からの情報を、 フォームルールをトリガするためにのみ使用されるフォームフィールドに渡すことが有用です。 この場合、フィールドの非表示設定(Liferay 7.4の新機能)を使用します。

フィールド確認

フィールド確認は、バージョン7.4以降のLiferayフォームでサポートされています。 確認フィールドは、フォームビルダーでフォーム本体に直接追加するフィールドではなく、1行のテキストまたは数値フィールドを [確認が必要] に設定した場合にのみフォームに表示されます(フィールドの詳細設定セクションを使用)。 このフィールドでは、重要なデータを持つフィールドが正しく入力されるようにします(例えば、メールアドレスのフィールドなど)。

確認フィールドは、ユーザーが正しい情報を入力していることを確認するのに役立ちます。

確認フィールドを有効にすると、新しい設定オプションが表示されます。

方向: 垂直(デフォルト)または水平を選択して、確認フィールドを元のフィールドの下に表示するか、横に表示するかを決定します。

ラベル: 元のフィールドラベルのプレフィックスを選択します。 デフォルト値はConfirmなので、Email Addressというフィールドの確認フィールドのラベルは、 Confirm Email Address となります。

エラーメッセージ: 確認するフィールドに応じて、より具体的なエラーメッセージを提供することができます。

確認フィールドは構成可能です。

ユーザーが有効な形式で情報を入力できるようにするための情報は、 テキストおよび数値フィールドエントリの検証 を参照してください。

フィールド名、フィールドID、およびフィールドの参照

Liferay 7.3の最初のリリースでは、編集可能な構成のフィールド名が削除され、読み取り専用のフィールド IDが各フィールドの[アドバンス]タブに含まれるようになりました。 しかし、Liferay 7.3では、編集可能な代替品であるフィールド参照が利用できるようになりました。 プログラムでフィールドを参照する場合は、7.2のフィールド名の値と7.3以降のフィールド参照を使用します。

フィールド参照の設定では、フォームビルダーがフィールドの人間が読めるシステム名を設定することができます。

フォームのフィールドと要素

パラグラフ

パラグラフフィールドは、フォーム作成者が入力した静的なテキストをフォーム上に表示します。 ユーザーは説明文フィールドにデータを入力しません。 これは、指示が長い場合に役立ちます。

段落フィールドを使用して、フォーマットされたテキストのより長いブロックを提供できます。

説明文フィールドは単なるプレーンテキストではありません。 埋め込み式のコンテンツエディターを使って、リッチコンテンツを作成します。

コンテンツエディタを使用して、段落フィールドにリッチコンテンツを作成します。

テキスト項目

ユーザーはこれらのフィールドに自由形式のテキストを入力します。 たとえば、氏名フィールドはテキストフィールドです。 デフォルトでは、テキストフィールドはすべての入力を1行のテキストに保持します。 より長い応答に対応するには、この例のようにテキストフィールドを構成するときに複数行設定を選択します。 テキストフィールドの検証オプションを使用して、ユーザーが入力できるテキスト(1〜10の数字、電子メールアドレスなど)を制限できます。

複数行のテキストフィールドでは、ユーザーが複数の行を入力することができます。

プルダウン

ユーザーは、選択肢のリストから1つ(または許可されている場合は複数)のオプションを選択します。 選択肢は手動で入力するか、データプロバイダーによって自動的に入力されます。 たとえば、居住国フィールドは、Countries of the Worldデータプロバイダーによって入力されたリストフィールドから選択できます。

フォームの選択リストフィールドには、選択するオプションのドロップダウンリストがユーザーに表示されます。

ラジオボタン

ユーザーは、ラジオボタンを使用して、フォームに表示されたオプションのリストから1つのオプションを選択します。

単一選択フィールドは、ユーザーに複数の選択肢を表示し、その中から1つだけを選択できるようになっています。

ブール値

ユーザーは、チェックボックスやスイッチを有効にしたり無効にしたりして、表示されたテキストに対する true または false の応答を記録します。

ブールフィールドはユーザーに単一のオプションを表示し、ユーザーが応答でtrueまたはfalseを選択できるようにします。

日付

ユーザーは日付ピッカーを使用して日付を選択します。

日付ピッカーは、日付を選択するための便利な方法を提供します。

Liferay 7.4では、日付フィールドの詳細設定に入力値の検証が含まれています。 フィールドの詳細設定の検証オプションを使用して、ユーザーが入力できる日付(1〜10の数字、電子メールアドレスなど)を制限できます。

日付フィールドの検証ルールを入力します。

日時

Liferay 7.4で追加された、ユーザーが日付と時刻の両方を1つのフィールドに入力する機能です。

日時フィールドは、有効な日付と時間帯を組み合わせたものです。

日時フィールドは、 DD/MM/YYYY HH:MM [AM/PM]のフォーマットで入力します。 例えば、 01/06/1981 12:15 PM は1981年1月6日、午後12時15分です。 日時のピッカーを使用するか、ユーザーがフィールドに直接日付を入力することができます。

複数選択

ユーザーは、チェックボックス(または設定されている場合はトグル)から1つ以上のオプションを選択します。

複数選択フィールドでは、ユーザーが表示された選択肢の中から複数選択することができます。

グリッド

ユーザーは、ラジオボタンを使用して、行と列に配置されたオプションから選択します。 行ごとに1つの選択を行うことができます。 これは、複数の質問に同じ回答メトリックが必要な場合に役立ちます。

グリッドフィールドでは、ユーザーが同じ回答オプションのリストから複数の問い合わせに回答できます。

数値

ユーザーは数値データ(整数または小数)を数値フィールドに入力します。 数字以外の入力は受け付けません。

数値フィールドは、ユーザーの入力を数字(整数または小数)に限定します。

数値フィールドには、興味深い詳細なフィールド設定があります。

  • 確認要求 ユーザがデータを正しく入る性を保証します。

  • **入力値の検証 ユーザーの入力を事前に設定された要件に制限します。 数値入力を検証します。

  • **入力マスク では、ユーザーが数値データを入力する際に、正しいフォーマットを表示することができます。

アップロード

アップロードフィールドを使用すると、ユーザーはローカルファイルシステムからファイルをアップロードできます。 ログインしているユーザーは、以前にアップロードしたファイルから選択するか、新しいファイルをアップロードできます。

注釈

7.2でログインすると、ユーザーはドキュメントとメディアライブラリから既存のファイルを選択するか、ローカルファイルシステムからファイルをアップロードすることを選択できます。

アップロードフィールドでは、ユーザーがファイルをアップロードしたり、既存のドキュメントとメディアのエントリーから選択することができます。

Liferay 7.3 (DXP FP1およびCE GA7 )以降、認証されていないゲストユーザーにファイルのアップロードを許可することができます。 フォームフィールドの設定でゲストのアップロードを有効にします。

ゲストにファイルのアップロードを許可するかどうかを選択できます。

アップロードされたドキュメントは、 ドキュメントとメディアリポジトリ非表示フォルダに保存されます。 ドキュメントとメディアアプリケーションで表示するには、以下のポータルプロパティportal-ext.properties ファイルに設定します。

dl.show.hidden.mount.folders=true

コントロールパネル:[システム設定]→ [フォーム(コンテンツとデータ)] → [フォーム]で、または、com.liferay.dynamic.data.mapping.form.web.internal.configuration.DDMFormWebConfiguration.configという名前の設定ファイルを作成して、ゲストのアップロード動作を設定します。

ちなみに

インスタンススコープ でフォームアプリケーションを設定するには、Instance Settingsのフォームエントリーを使用します。

Guest Upload File Extensions(guestUploadFileExtensions): 受け入れられるファイル拡張子のコンマ区切りリストを入力します。 デフォルトでは以下のリストがサポートされています:docdocxjpegjpgpdfpngpptpptxtifftxtxls、およびxlsx

Guest Upload Maximum file Size(guestUploadMaximumFileSize): ゲストユーザがアップロードフィールドからアップロードできるファイルの最大サイズを設定します。 これは、ドキュメントとメディアアプリケーションの設定で、認証されたユーザーに対して設定され、システム全体の制限は、アップロードサーブレットリクエストシステム設定エントリーの「合計最大アップロードリクエストサイズ」というフィールドで定義されます。 デフォルトでは25MBに設定されています。

Maximum Repetitions for Upload Fields(maximumRepetitionsForUploadFields): フィールドが繰り返し可能に設定されている場合、ユーザーがフィールドをフォームに追加できる最大回数を設定します (ゲスト ユーザーとログインしたユーザーに同じように適用されます)。 デフォルトでは5に設定されています。

Maximum Submissions for Guest Upload Fields(maximumSubmissionsForGuestUploadFields): ゲストが使用可能なアップロード フィールドを含むフォームを、ゲスト ユーザーが送信できる最大回数を設定します。 ゲストユーザーのIPアドレスは、送信数の記録のために使用されます。 デフォルトでは5に設定されています。

画像

ユーザーは、[Web Content Images]、[Documents and Media]ライブラリから画像ファイル(.gif.jpeg.jpg.png)を選択したり、ローカルファイルシステムから画像ファイルをアップロードしたりすることができます。

画像フィールドでは、ユーザーが画像をアップロードしたり、ドキュメントとメディア内にある画像やWebコンテンツ画像から選択することができます。

重要

ゲストユーザーは、画像へのアクセスやアップロードができません。 認証されたユーザーのみがフォームにアクセスできる場合を除き、このフィールドは使用しないでください。

画像を追加した後、ユーザーは画像の追加フィールドである 説明 を記入することができます。 画像フィールドがオプションの場合、使い方は簡単で、画像もその説明も必要ありません。 ただし、他のフォームフィールドと同様に、画像フィールドは必須とマークすることができます。 Liferay 7.4では、画像フィールドが必須の場合、フォームビルダーは説明を必須とするか任意とするかを選択することができます。

必須画像フィールドの説明フィールドは、必須または任意とすることができます。

Liferay 7.2 と 7.3 では、画像フィールドが必須である場合、説明は必須です。

ユーザーは、カラーピッカーから色を選択するか、コードを直接入力することで、色の16進コードを入力することができます。

色フィールドでは、カラーピッカーで色フォームを選択すると、その色の16進数を入力することができます。

リッチテキスト

ユーザーは、リッチテキストコンテンツ(フォーマットされたテキスト、埋め込まれた画像、添付ファイルなど)をフォームフィールドに入力することができます。

リッチテキストフィールドでは、ユーザーは画像を埋め込んだフォーマット済みのテキストをフォームに書き込むことができます。

位置を検索

Liferay 7.4以降の[ロケーションの検索]フィールドを使用して、フォームユーザーから有効なアドレスを簡単に収集します。

[ロケーションの検索]フィールドには、Google PlacesAPIキーが必要です。

詳細については、 検索場所フィールドを使うを参照してください。