---
schema_version: "1"
id: 2cc085b81736c535d06838d68774409f7635c3a4ae84772611ea9ffbe15f8922
title: パラメーター UI のカスタマイズ
collection: mulesoft
version: current
locale: ja-jp
portal_url: https://docs.salesforce.com/mulesoft/current/ja-jp/mule-sdk/1.1/parameter-layout.md
canonical_url: https://docs.mulesoft.com/jp/mule-sdk/1.1/parameter-layout
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 69e8a7553d523773d3a3f10df0912f859c3ea71cb03c40143da065b50eb11077
description: MuleSoft Documentation Site
release: "1.1"
latest: false
---
# パラメーター UI のカスタマイズ

SDK は、UI と UX の多くの側面をカスタマイズするためのアノテーションのセットを提供しています。

## [](#displayname)@DisplayName

UI で使用する要素や項目のカスタム表示ラベルを指定します。

## [](#example)@Example

パラメーターで使用できる値の簡単な例を添えておくと便利な場合があります。

```java
@Parameter
@Example("0.0.0.0")
private String port;
```

このパラメーターは次のように表示されます。

![例](/mulesoft/current/ja-jp/mule-sdk/1.1/_images/example.png)

## [](#summary)@Summary

`@Summary`​ は、パラメーターの目的の短い説明です。

たとえば、この説明は Design Center でパラメーターにカーソルを置くと表示される説明などに使用できます。

```java
@Parameter
@Optional(defaultValue = "SECONDS")
@Summary("Time unit to be used in the Connection Timeout")
private TimeUnit connectionTimeoutUnit;
```

このパラメーターは次のように表示されます。

![Summary のツールチップ](/mulesoft/current/ja-jp/mule-sdk/1.1/_images/summary.png)

## [](#placement)@Placement

このアノテーションは、以下の設定を可能にします。

- グループ内でパラメーターが定義される相対的な順序。値は相対的に扱われ、順序 ​`10`​ の要素は順序 ​`25`​ の要素より上になります。
- パラメーターを視覚的にグループ化するタブ。この属性は、パラメーターを表示するタブの名前を指定します。デフォルトは「General」で、名前は指定されません。同じタブに複数のパラメーターや項目を表示するには、同じタブの値を指定してください。

次の例では、​`foo`​ と ​`bar`​ が ​`Advanced`​ という名前の同じタブにグループ化され、​`foobar`​ はデフォルトタブの唯一のパラメーターとなります。

```java
@Parameter
@Placement(order = 1, tab="Advanced")
private String foo;

@Parameter
@Placement(order = 2, tab="Advanced")
private String bar;

@Parameter
private String foobar;
```

`foo`​ パラメーターと ​`bar`​ パラメーターは新しい ​`"Advanced"`​ タブに次のように表示されます。

![タブ](/mulesoft/current/ja-jp/mule-sdk/1.1/_images/placement-tab.png)

## [](#text)@Text

パラメーターが UI で複数行の入力をサポートするように指示します。このアノテーションは DSL にも影響し、アノテーション付きのパラメーターを、テキストを要素のコンテンツとした子要素とします。

このアノテーションは、​`String`​ 型のパラメーターでのみ使用できます。

例

```java
@Parameter
@Optional
@Text
@DisplayName("SQL Query Text")
private String sql;
```

Design Center では ​`@Text`​ は次のように表示されます。

![テキストの複数行入力](/mulesoft/current/ja-jp/mule-sdk/1.1/_images/text.png)

`@Text`​ は、パラメーターを含む要素の DSL にも影響します。このアノテーションを使用すると、​`CDATA`​ コンテンツを受け入れる子要素が作成されます。たとえば、次のような操作があるとします。

```java
public void execute(String message) { ... }
```

この操作の DSL は次のようになります。

```xml
<example:execute message="This is a pretty inline message!"/>
```

次の例では、​`message`​ 操作に ​`@Text`​ アノテーションを付加しています。

```java
public void execute(@Text String message) { ... }
```

対応する DSL は次のようになります。

```xml
<example:execute>
    <example:message>
       <![CDATA[ This is a pretty CDATA message! ]]>
    </example:message>
</example:execute>
```

## [](#path)@Path

パラメーターをファイルまたはディレクトリへのパスとしてマークします。このパラメーターは、UI ではファイルピッカー項目として表示されます。

このアノテーションは、​`String`​ 型のパラメーターでのみ使用できます。

このアノテーションは以下の情報を提供します。

- `type`​: パスの対象がディレクトリ、ファイル、またはその両方のいずれであるか。
- `acceptsUrls`​: @Path パラメーターで URL をサポートするかどうか。
- `acceptedFileExtensions`​: パラメーターが処理できる拡張子のリスト。

次の例では、リモートリソースを含む、拡張子が ​`.txt`​ のファイルを受け入れます。

```java
@Parameter
@Path(type = FILE, acceptedFileExtensions = "txt", acceptsUrls = true)
private String resourcePath;
```

## [](#password)@Password

UI から入力されたパラメーター値をマスクするように指示します。

このアノテーションは、​`String`​ 型のパラメーターでのみ使用できます。

![パスワード入力](/mulesoft/current/ja-jp/mule-sdk/1.1/_images/password.png)

Figure 1. UI での例

## [](#すべての統合)すべての統合

上記のアノテーションを組み合わせた例を示します。

```java
@Parameter
@Placement(order = 3, tab="Additional information")
@Example("My name is Max the Mule and I love MuleSoft!")
@DisplayName("User biography")
@Summary("Information related to the user\'s life")
@Text
private String biography;
```

## [](#classvalue)@ClassValue

​**バージョン 1.1 以降で使用可能**​

パラメーターがクラス名への参照であることを指示します。

このアノテーションは、​`String`​ 型のパラメーターでのみ使用できます。

パラメーターがクラスであることをツールに示すだけでなく、参照可能なクラスの制約も指定できます。割り当てられた値が特定のクラスまたはインターフェースを拡張または実装 (​`extendsOrImplements`​) する必要があることを示すことができます。

使用する JDBC ドライバーのクラス名をエンドユーザーが指定する必要のあるデータベースコネクタの例を次に示します。

```java
@Parameter
@ClassValue(extendsOrImplements = "java.sql.Driver")
private String driverClassName;
```