Configuration Framework
ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、 こちら までご連絡ください。

DDMフォーム注釈

自動生成された 設定インターフェース UI は、一部の設定には単純すぎる場合があります。動的データマッピング(DDM)フォームのアノテーションを使用して、レイアウトのUIをカスタマイズできます。

サンプル設定UIをご覧ください

Liferay の新しいインスタンスを起動するには、次のコマンドを実行します。

docker run -it -m 8g -p 8080:8080 liferay/portal:7.4.3.132-ga132

http://localhost:8080 で Liferay にサインインしてください。メールアドレス test@liferay.com とパスワード test を使用してください。プロンプトが表示されたら、パスワードを learn に変更してください。

次に、以下の手順に従ってください。

  1. DDMフォーム注釈をダウンロードして解凍します。

    curl https://resources.learn.liferay.com/examples/liferay-v1d9.zip -O
    
    unzip liferay-v1d9.zip
    
  2. モジュールのルートディレクトリから、ビルドとデプロイを実行します。

    ./gradlew deploy -Ddeploy.docker.container.id=$(docker ps -lq)
    
    注記

    このコマンドは、デプロイされたjarファイルをDockerコンテナの/opt/liferay/osgi/modulesにコピーするのと同じです。

  3. Liferay Dockerコンテナコンソールでデプロイメントを確認してください。

    STARTED com.acme.v1d9.impl_1.0.0 [1650]
    
  4. ブラウザで https://localhost:8080 を開き、 グローバル メニュー (Global Menu) → コントロール パネル → システム設定 に移動します。サードパーティ をクリックしてください。左側の V1D9 設定 をクリックします。

    UIレイアウトは、DDMフォームの注釈によってカスタマイズされます。

DDMフォームの注釈の仕組みは以下のとおりです。

設定フォームを作成する

設定UI内のすべてのフォームフィールドを含む設定フォームインターフェースを作成します。各フィールドには、 @DDMFormField アノテーションを使用します。各フィールドに対して、 ラベル、 プロパティ、および タイプ などの属性を定義します。

@DDMFormField(label = "%checkbox", properties = "showAsSwitcher=true")
public boolean checkbox();

@DDMFormField(label = "%date", type = "date")
public String date();

@DDMFormField(
	label = "%numeric", properties = "placeholder=%seconds",
	type = "numeric",
	validationErrorMessage = "%please-enter-an-integer-between-0-and-60-seconds",
	validationExpression = "(numeric >= 0) && (numeric <= 60)"
)
public String numeric();

@DDMFormField(
	label = "%select", optionLabels = {"%foo", "%bar"},
	optionValues = {"foo", "bar"}, type = "select"
)
public String select();

@DDMFormField(label = "%text")
public String[] text();

利用可能なすべてのフィールドタイプについて詳しくは、 フォームフィールドタイプのリファレンス をご覧ください。各フィールド型の型変数名については、「フィールド型定数」を参照してください。

各フォームフィールドに注釈を付けた後、クラス宣言のすぐ上に DDMFormLayout 注釈を使用してフォームのレイアウトを定義します。

@DDMForm
@DDMFormLayout(
	paginationMode = com.liferay.dynamic.data.mapping.model.DDMFormLayout.SINGLE_PAGE_MODE,
	value = {
		@DDMFormLayoutPage(
			{
				@DDMFormLayoutRow(
					{
						@DDMFormLayoutColumn(size = 6, value = "text"),
						@DDMFormLayoutColumn(size = 6, value = "checkbox")
					}
				),
				@DDMFormLayoutRow(
					{
						@DDMFormLayoutColumn(size = 6, value = "select"),
						@DDMFormLayoutColumn(size = 6, value = "numeric")
					}
				),
				@DDMFormLayoutRow(
					{@DDMFormLayoutColumn(size = 12, value = "date")}
				)
			}
		)
	}
)

DDMFormLayoutRow アノテーションと DDMFormLayoutColumn を使用して、UI に必要な行と列にフォーム フィールドを配置します。

フォーム宣言を記入してください

新しい構成フォーム クラスを登録するには、 ConfigurationDDMFormDeclaration の新しい実装を作成します。

@Component(
	property = "configurationPid=com.acme.v1d9.internal.configuration.V1D9Configuration",
	service = ConfigurationDDMFormDeclaration.class
)
public class V1D9ConfigurationDDMFormDeclaration
	implements ConfigurationDDMFormDeclaration {

	@Override
	public Class<?> getDDMFormClass() {
		return V1D9ConfigurationForm.class;
	}

}

Component アノテーションの configurationPid は、構成インターフェイスの完全修飾クラス名と一致する必要があることに注意してください。