カスタム・フィールド・エディタのappinfo.json
このファイルは必須で、エディタに必要な構成メタデータが含まれています。 エディタが機能するために必要なプロパティの一部(オプション)。 次に、サンプルappinfo.jsonを示します:
{
"type":"fieldeditor",
"name":"Sample Text field",
"single":true,
"multiple":true,
"handlesMultiple":false,
"supportedDatatypes":["text"],
"autoresize":true,
"validation":true,
"useDefaultFormView":false
}表7-1 appinfo.jsonの構成プロパティ
| プロパティ | 値 | 必須 | タイプ |
|---|---|---|---|
| type | コンポーネント・タイプ カスタム・フィールド・エディタの場合、タイプはfieldeditorであり、すべてのエディタで同じです。 変更しないでください。
|
必須 | 文字列 |
| name | 「コンテンツ・タイプ」フィールド設定エディタのリストに表示される名前。 デフォルトでは、カスタム・フィールド・エディタの作成時に入力された名前。 | 必須 | 文字列 |
| single | フィールドが単一値のフィールドの場合、このエディタをエディタ・リストに表示するかどうかを指定します。 | singleまたはmultipleのいずれかが必須であり、trueに設定します | Boolean |
| multiple | フィールドが複数値フィールドの場合にエディタ・リストにこのエディタをリストするかどうかを指定します。 | singleまたはmultipleのいずれかが必須であり、trueに設定します | Boolean |
| handlesMultiple | このエディタが複数の値を処理できるかどうかを指定します。 | 必須 | Boolean |
| supportedDataTypes | このエディタで使用できるデータ型のリスト。 | 必須 | データ型の配列 |
| autoresize | このエディタのサイズ変更時にコンテンツ・アイテム・フォームにサイズ変更通知を送信するかどうかを指定します。 カスタム・エディタは、コンテンツ・アイテム・フォームのiframe内にレンダリングされます。 このプロパティをtrueに設定すると、エディタ・サイズが変更された場合に、SDKからiframeサイズを調整するようにフォームに通知されます。 | オプション | Boolean |
| validation | このエディタに入力した値をコンテンツ・アイテム・エディタ・フォームで検証する必要があるかどうかを指定します。 Trueに設定すると、エディタは、検証のためにコンテンツ・アイテム・フォームによってコールされるコールバック関数を登録し、提供する必要があります。 | オプション | Boolean |
| useDefaultFormView | このエディタを含むコンテンツ・アイテムを表示するときに、システムのデフォルト・フォーム・ビューを使用するかどうかを指定します。 このプロパティが存在しない場合、またはfalseに設定されている場合、view.html実装は、フィールドの表示モードをレンダリングするために使用されます。 | オプション | Boolean |
前述のプロパティ以外にも、コンテンツ・タイプの定義時にこのエディタが選択されたときに、エディタ構成ビューをレンダリングするために使用する設定を定義できます。 たとえば、フィールド内の電話番号を処理するエディタを記述し、フィールド定義時に選択する書式を設定する場合は、次のようにします:
{
"type": "fieldeditor",
"name": "Phone Number",
"single": true,
"multiple": true,
"handlesMultiple": false,
"supportedDatatypes": ["text"],
"autoresize": true,
"useDefaultFormView": false,
"settings":[
{
"id": "mask",
"type": "list",
"name": "Phone number format",
"options": [
{
"label": "+1(999)-999-9999",
"value": "+1(999)-999-9999"
},
{
"label": "+44(999)-9999-9999",
"value": "+44(999)-9999-9999"
},
{
"label": "+49 999 99999999",
"value": "+49 999 99999999"
}
]
}
]
}
配列の設定には複数のタイプを指定できることに注意してください。 現在、次の2つのタイプの設定がサポートされています:
- text
- list
テキスト
テキスト・タイプの設定には、次の3つのプロパティがあります:
- id: フィールドID
- name: フィールド名
- type: フィールド・タイプ
たとえば:
{
"id":"min",
"name":"Minimum",
"type":"text"
}
そうすると、IDがminの設定ダイアログに、「最小」という名前のテキスト・フィールドを持つエディタ構成ビューがレンダリングされます。
設定の一部としてフィールドにデフォルト値を使用する場合は、次の設定を変更できます:
{
"id":"oracle.cloud.content.defaultValue",
"type":"text"
}
ここで、デフォルト値フィールドが表示されます。
リスト
リストの場合は、Id、タイプおよび名前の他に、リストに表示するオプションのリストも指定する必要があります。 たとえば、フィールド内の電話番号を処理するエディタを記述し、フィールド定義時に選択する書式を設定する場合は、次のようにします:
{
"type": "fieldeditor",
"name": "Phone Number",
"single": true,
"multiple": true,
"handlesMultiple": false,
"supportedDatatypes": ["text"],
"autoresize": true,
"useDefaultFormView": false,
"settings":[
{
"id": "mask",
"type": "list",
"name": "Phone number format",
"options": [
{
"label": "+1(999)-999-9999",
"value": "+1(999)-999-9999"
},
{
"label": "+44(999)-9999-9999",
"value": "+44(999)-9999-9999"
},
{
"label": "+49 999 99999999",
"value": "+49 999 99999999"
}
]
}
]
}