Show Menu
トピック×

フォームの構造

The description of a form is a structured XML document that observes the grammar of the form schema xtk:form .
The XML document of the input form must contain the <form> root element with the name and namespace attributes to populate the form name and namespace.
<form name="form_name" namespace="name_space">
...
</form>

デフォルトでは、フォームはデータスキーマに同じ名前と名前空間で関連付けられます。 フォームに別の名前を関連付けるには、要素の entity-スキーマ 属性をスキーマキーの名前に設定し <form> ます。 入力フォームの構造を理解するために、「cus:受信者」のサンプルスキーマを使用したインターフェイスを説明します。
<srcSchema name="recipient" namespace="cus">
  <enumeration name="gender" basetype="byte">    
    <value name="unknown" label="Not specified" value="0"/>    
    <value name="male" label="Male" value="1"/>   
    <value name="female" label="Female" value="2"/>   
  </enumeration>

  <element name="recipient">
    <attribute name="email" type="string" length="80" label="Email" desc="E-mail address of recipient"/>
    <attribute name="birthDate" type="datetime" label="Date"/>
    <attribute name="gender" type="byte" label="Gender" enum="gender"/>
  </element>
</srcSchema>

サンプルスキーマに基づく入力フォーム:
<form name="recipient" namespace="cus">
  <input xpath="@gender"/>
  <input xpath="@birthDate"/>
  <input xpath="@email"/>
</form>

編集の説明は、 <form> ルート要素の開始を制御します。 編集コントロールが、スキーマ内のフィールドのパスを格納した xpath 属性を持つ <input> 要素に入力されます。
編集コントロールは、対応するデータタイプに自動的に適応し、スキーマで定義されているラベルを使用します。
データ要素に label 属性を追加すると、データスキーマに定義されたラベルをオーバーロードでき <input> ます。 <input label="E-mail address" xpath="@name" />
デフォルトでは、各フィールドは1行に表示され、データの種類に応じて使用可能なすべてのスペースを占有します。

書式設定

コントロールのレイアウトは、HTMLテーブルで使用されているレイアウトと同じように見えます。コントロールを複数の列に分割したり、要素をインターレースしたり、使用可能な領域の占有を指定したりできます。 ただし、書式設定は領域を縦横比で分割する場合にのみ使用できます。オブジェクトに固定寸法を指定することはできません。
上記の例のコントロールを2つの列に表示するには:
<form name="recipient" namespace="cus">
  <container colcount="2">
    <input xpath="@gender"/>
    <input xpath="@birthDate"/>
    <input xpath="@email"/>
  </container>
</form>

colcount <container> 属性を持つ ​要素を使用すると、2つの列に子コントロールを強制的に表示できます。
コントロールの colspan 属性は、値に入力された列数だけコントロールを拡張します。
<form name="recipient" namespace="cus">
  <container colcount="2">
    <input xpath="@gender"/>
    <input xpath="@birthDate"/>
    <input xpath="@email" colspan="2"/>
  </container>
</form> 

コンテナは、 type="frame" 属性に値を入力することで、子コントロールの周囲にフレームを追加し、 label 属性に含まれるラベルを追加します。
<form name="recipient" namespace="cus">
  <container colcount="2" type="frame" label="General">
    <input xpath="@gender"/>
    <input xpath="@birthDate"/>
    <input xpath="@email" colspan="2"/>
  </container>
</form>

要素を使用して、入力フォームの形式を設定できます。 <static>
<form name="recipient" namespace="cus">
  <static type="separator" colspan="2" label="General"/>
  <input xpath="@gender"/>
  <input xpath="@birthDate"/>
  <input xpath="@email" colspan="2"/>
  <static type="help" label="General information about recipient with date of birth, gender, and e-mail address." colspan="2"/>
</form>

区切り <static> 記号の 種類が付いたタグを使用すると 、ラベルの属性にラベルが含まれた区切り記号バーを追加できます。
ヘルプタイプの <static> タグを使用して、ヘルプテキストが追加されました。 テキストの内容が label 属性に入力されます。

コンテナ

コンテナを使用すると、一連のコントロールをグループ化できます。これらは要素で表され <container> ます。 上記の例は、複数の列のコントロールを書式設定する際に使用されています。
子コントロールの xpath 属性 <container> を使用すると、子コントロールを簡単に参照できます。 次に、コントロールの参照は、親の <container> 親に対する相対パスになります。
「xpath」を使用しないコンテナの例:
<container colcount="2">
  <input xpath="location/@zipCode"/>
  <input xpath="location/@city"/>
</container>

「location」という要素に「xpath」を追加した例を次に示します。
<container colcount="2" xpath="location">
  <input xpath="@zipCode"/>
  <input xpath="@city"/>
</container>

コンテナの種類

コンテナは、ページ形式の一連のフィールドを使用して複雑なコントロールを作成する場合に使用します。

タブコンテナ

タブコンテナは、タブからアクセス可能なページのデータの形式を設定します。
<container type="notebook">
  <container colcount="2" label="General">
    <input xpath="@gender"/>
    <input xpath="@birthDate"/>
    <input xpath="@email" colspan="2"/>
  </container>
  <container colcount="2" label="Location">
    ...
  </container>
</container>

メインコンテナは、 type="notebook" 属性で定義します。 タブは子コンテナで宣言され、タブのラベルは label 属性から入力されます。
style="down|up (デフォルト) " フィーチャは、タブラベルをコントロールの下または上に強制的に垂直位置に配置します。 この機能はオプションです。 <container style="down" type="notebook"> ... </container>

アイコンリスト

このコンテナには、表示するページを選択できる垂直のアイコンバーが表示されます。
<container type="iconbox">
  <container colcount="2" label="General" img="xtk:properties.png">
    <input xpath="@gender"/>
    <input xpath="@birthDate"/>
    <input xpath="@email" colspan="2"/>
  </container>
  <container colcount="2" label="Location" img="nms:msgfolder.png">
    ...
  </container>
</container>

メインコンテナは type="iconbox" 属性で定義します。 アイコンに関連付けられたページは、子コンテナで宣言されます。 アイコンのラベルは、 label 属性から入力されます。
ページのアイコンは、 img="<image>" 属性に基づいて設定されます。 <image> は、名前と名前空間で構成されるキーに対応する画像の名前です(「xtk:properties.png」など)。
画像は、 管理/設定/画像 ノードから使用できます。

表示コンテナ

動的条件を使用して、一連のコントロールをマスクできます。
次の例は、「性別」フィールドの値に対するコントロールの表示/非表示を示しています。
<container type="visibleGroup" visibleIf="@gender=1">
  ...
</container>
<container type="visibleGroup" visibleIf="@gender=2">
  ...
</container>

表示コンテナは、attribute type="visibleGroup"で定義され ​ます。 visibleIf ​属性には表示条件が含まれます。
条件の構文の例:
  • visibleIf="@email='peter.martinezATneolane.net'" :文字列型のデータに対して等しい値をテストします。 比較値は引用符で囲む必要があります。
  • visibleIf="@gender >= 1 and @gender != 2'' :条件を数値に設定します。
  • visibleIf="@boolean1==trueまたは@boolean2==false" :ブール値フィールドをテストします。

コンテナの有効化

このコンテナを使用すると、動的条件に基づく一連のデータを有効または無効にできます。 コントロールを無効にすると、コントロールを編集できなくなります。 次の例は、「性別」フィールドの値からコントロールを有効にする方法を示しています。
<container type="enabledGroup" enabledIf="@gender=1">
  ...
</container>
<container type="enabledGroup" enabledIf="@gender=2">
  ...
</container>

有効にするコンテナは、 type="enabledGroup" 属性で定義します。 enabledIf 属性には 、アクティベーション条件が含まれます。

メモリリストコントロール

メモリリストを使用すると、リストデータのプリロードを使用してコレクション要素を編集できます。 このリストはフィルターまたは構成できません。
これらのリストは、XMLでマッピングされたコレクション要素またはボリュームの少ないリンクで使用されます。

列リスト

このコントロールは、「追加」ボタンと「削除」ボタンを含むツールバー付きの編集可能な列リストを表示しています。
<input xpath="rcpEvent" type="list">
  <input xpath="@label"/>
  <input xpath="@date"/>
</input>

リストコントロールは、 type="list" 属性を使用して設定する必要があります。リストのパスは、コレクション要素を参照する必要があります。
The columns are declared in the child <input> tags of the list. 列のラベルとサイズは、 label 属性と colSize 属性を使用して強制的に指定できます。
並べ替え順の矢印は、 ordered="true" 属性がデータスキーマのコレクション要素に追加されたときに自動的に追加されます。
ツールバーのボタンは、水平方向に並べることができます。
<input nolabel="true" toolbarCaption="List of events" type="list" xpath="rcpEvent" zoom="true">
  <input xpath="@label"/>
  <input xpath="@date"/>
</input>

The toolbarCaption attribute forces the horizontal alignment of the toolbar and enters the title above the list.

リストの詳細表示

リスト内のデータの挿入と編集は、別の編集フォームに入力できます。
<input nolabel="true" toolbarCaption="List of events" type="list" xpath="rcpEvent" zoom="true" zoomOnAdd="true">
  <input xpath="@label"/>
  <input xpath="@date"/>

  <form colcount="2" label="Event">
    <input xpath="@label"/>
    <input xpath="@date"/>
  </form>
</input>

編集フォームは、リスト定義の下の <form> 要素から入力されます。 この構造は、入力フォームと同じです。 リストの タグで zoom="true" 属性が完了すると、「 Detail <input> 」ボタンが自動的に追加されます。 この属性を使用すると、選択した行の編集フォームを起動できます。
zoomOnAdd="true" ​属性を追加すると、リスト要素の挿入時に編集フォームが強制的に呼び出されます。

リストプロパティ

  • noToolbar :ツールバーを非表示(値「true」)
  • toolbarCaption :ツールバーのラベルをオーバーロードします
  • toolbarAlign :ツールバーの位置を変更します(可能な値:"垂直"|"水平"
  • img :リストに関連付けられた画像を表示します
  • form :ターゲット要素の編集フォームをオーバーロードします。
  • zoom :ターゲットの要素を編集する ズーム ボタンを追加します。
  • zoomOnAdd :追加時に編集フォームを起動
  • xpathChoiceTarget :さらに、入力したリンクの選択フォームを起動します。

編集不可のフィールド

フィールドを表示し、編集されないようにするには、タグを使用するか、タグの <value> readOnly="true" 属性を設定し <input> ます。
「性別」フィールドの例:
<value value="@gender"/>
<input xpath="@gender" readOnly="true"/>

ラジオボタン

ラジオボタンを使用すると、複数のオプションから選択できます。 タグを使用して選択可能なオプションをリストし、 <input> checkedValue ​属性で選択肢に関連付けられた値を指定します。
「性別」フィールドの例:
<input type="RadioButton" xpath="@gender" checkedValue="0" label="Choice 1"/>
<input type="RadioButton" xpath="@gender" checkedValue="1" label="Choice 2"/>
<input type="RadioButton" xpath="@gender" checkedValue="2" label="Choice 3"/>

チェックボックス

チェックボックスはブール値の状態を反映します(選択されているかどうか)。 デフォルトでは、このコントロールは「ブール値」(true/false)フィールドで使用されます。 デフォルト値の0または1を持つ変数をこのボタンに関連付けることができます。 この値は、 checkValue 属性を使用してオーバーロードできます。
<input xpath="@boolean1"/>
<input xpath="@field1" type="checkbox" checkedValue="Y"/>

式場

式フィールドは、式から動的にフィールドを更新します。この <input> タグは、 xpath 属性と共に使用し、更新するフィールドのパスと、更新式を含む expr 属性を入力します。
<!-- Example: updating the boolean1 field from the value contained in the field with path /tmp/@flag -->
<input expr="Iif([/tmp/@flag]=='On', true, false)" type="expr" xpath="@boolean1"/>
<input expr="[/ignored/@action] == 'FCP'" type="expr" xpath="@launchFCP"/>

フォームのコンテキスト

入力フォームを実行すると、編集するエンティティのデータを含むXMLドキュメントが初期化されます。 このドキュメントはフォームのコンテキストを表し、ワークスペースとして使用できます。

コンテキストの更新

フォームのコンテキストを変更するには、 <set expr="<value>" xpath="<field>"/> タグを使用します。 <field> ここで、は更新式または更新値 <value> です。
タグの使用例を次に示し <set> ます。
  • <set expr="'Test'" xpath="/tmp/@test" /> :を指定すると、一時的な場所/tmp/@test1に「Test」値が配置されます。
  • <set expr="'Test'" xpath="@lastName" /> :「lastName」属性のエンティティを「Test」値で更新します
  • <set expr="true" xpath="@boolean1" /> :「boolean1」フィールドの値を「true」に設定します。
  • <set expr="@lastName" xpath="/tmp/@test" /> :「lastName」属性の内容に合わせて更新
タグとタグを使用してフォームを初期化したり閉じたりする場合は、フォームのコンテキストを更新でき <enter> <leave> ます。
<form name="recipient" namespace="cus">
  <enter>
    <set...
  </enter>
  ...
  <leave>
    <set...
  </leave>
</form>

タグ <enter> <leave> タグは、ページ <container> の上で使用できます(「notebook」タイプと「iconbox」タイプ)。

式言語

マクロ言語をフォーム定義で使用して、条件付きテストを実行できます。
式が検証される場合、 <if expr="<expression>" /> タグは、タグの下で指定された命令を実行します。
<if expr="([/tmp/@test] == 'Test' or @lastName != 'Doe') and @boolean2 == true">
  <set xpath="@boolean1" expr="true"/>
</if>

タグと組み合わせた <check expr="<condition>" /> <error> タグは、フォームの検証を妨げ、条件が満たされない場合はエラーメッセージを表示します。
<leave>
  <check expr="/tmp/@test != ''">
    <error>You must populate the 'Test' field!</error> 
  </check>
</leave>

ウィザード

ウィザードに従って、一連のデータ入力手順をページ形式で進めます。 入力したデータは、フォームを検証するときに保存されます。
ウィザードの構造は次のとおりです。
<form type="wizard" name="example" namespace="cus" img="nms:rcpgroup32.png" label="Wizard example" entity-schema="nms:recipient">
  <container title="Title of page 1" desc="Long description of page 1">
    <input xpath="@lastName"/>
    <input xpath="comment"/>
  </container>
  <container title="Title of page 2" desc="Long description of page 2">
    ...
  </container>
  ...
</form>

要素に type="wizard" <form> 属性が存在する場合、フォームの構築時にウィザードモードを定義できます。 ページは、要素の子である <container> 要素から完成し <form> ます。 ページの <container> 要素に、titleとdescのtitle属性が設定され、ページタイトルの下に説明が表示されます。 「 前へ 」ボタンと「 次へ 」ボタンが自動的に追加され、ページ間を移動できます。
完了 」ボタンをクリックすると、入力したデータが保存され、フォームが閉じます。

SOAP メソッド

SOAPメソッドの実行は、ページの最後に挿入された <leave> タグから開始できます。
この <soapcall> タグには、次の入力パラメーターを持つメソッドの呼び出しが含まれます。
<soapCall name="<name>" service="<schema>">
  <param type="<type>" exprIn="<xpath>"/>  
  ...
</soapCall>

サービスの名前とその導入スキーマは、 タグの 名前 <soapcall> サービス属性を使用して入力されます。
入力パラメーターは、タグの下の <param> 要素で説明され <soapcall> ます。
パラメータータイプは、 type 属性で指定する必要があります。 使用できるタイプは次のとおりです。
  • string :文字列
  • boolean :ブール値
  • byte :8ビット整数
  • short :16ビット整数
  • long :32ビット整数
  • short :16ビット整数
  • 重複 :重複精度浮動小数点数
  • DOMElement :要素型ノード
exprIn 属性には 、パラメーターとして渡すデータの場所が含まれます。
<leave>
  <soapCall name="RegisterGroup" service="nms:recipient">         
    <param type="DOMElement" exprIn="/tmp/entityList"/>         
    <param type="DOMElement" exprIn="/tmp/choiceList"/>         
    <param type="boolean"    exprIn="true"/>       
  </soapCall>
</leave>