1. はじめに
2. changeSelection命令
3. changeTabStatus命令
4. closeContext命令
5. doAction命令
6. doCommand命令
7. doTransition命令
8. execute命令
9. if命令
10. logging命令
11. notify命令
12. openFile命令
13. operateDynamicForm命令
14. readFile命令
15. refresh命令
16. return命令
17. requestFocus命令
18. setTitle命令
19. setValue命令
20. showConfirmDialog命令
21. showDialog命令
22. showFileChooserDialog命令
23. showMessageDialog命令
24. showMailClient命令
25. showWebBrowser命令
26. switch命令
27. toFront命令

このドキュメントは、Commandのリファレンスです。

Commandとは、Area定義で記述される画面の実行処理命令です。
画面起動時、画面終了時、ボタンクリック時などを契機として呼び出されます。
ContentのActionの実行や画面遷移、メッセージダイアログ表示など、MVCモデルにおけるV(ビュー)に関する実行処理を行うことが出来ます。 また、条件判定による分岐も行うことが出来るので、簡単なスクリプト言語的な使い方が出来ます。

Area定義については、こちらを参照してください。
また、文中にでてくる参照記法については、こちらを参照してください。

このリファレンスでは、Command内で使用できる各種実行命令の記述例やフォーマットなどを解説します。

記述例 :　画面遷移を実行する

<doTransition transit="実行したい画面遷移のID"/>

説明 :
画面遷移を行う実行命令です。
具体的な画面遷移の内容はPage定義中のtransition-listセクションに定義されていて、その画面遷移IDをdoTransition命令のtransit属性値で指定します。

属性値 :
doTransitionタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
transit	実行したい画面遷移のID。 Page定義に記述されている画面遷移IDをここで指定します。	文字列	必須	不可
content	条件判定付きの画面遷移を利用する場合に判定対象とするContentのID指定。 transit属性で指定したPage定義のtransitionがref属性でTransition定義を指している場合は必須となる。	文字列	非必須	不可

直接指定による画面遷移

画面上でのある操作時に発生する画面遷移が静的に決まっているような場合は、 Page定義のtransitionタグで具体的な画面遷移の内容を記述して、 doTransition命令のtransit属性でそのidを指定するという形式で画面遷移を行います。 ほとんどのケースでこの方法で対応できますので、画面遷移の基本はこちらの方法となります。 例：Area定義での指定 <doTransition transit="見積詳細ポップアップ"/> 例：Page定義での指定 <transition id="見積詳細ポップアップ"> <popup-page next="CP_000001"/> </transition>

条件判定付きの画面遷移

画面上でのある操作時に発生する画面遷移が動的に決まるような場合、例えば一覧画面上で行選択して 詳細ボタンを押した際にポップアップする詳細画面が選択データの種類ごとに異なるというようなケースでは、 上記の直接指定による画面遷移の方法ではArea定義のCommand内で判定を行う必要がでてきますので扱いにくくなります。 このようなケースでは、Transition定義による条件判定付きの画面遷移を利用することができます。 この仕組みを利用すると、条件判定と対応する画面遷移をTransition定義内でまとめて管理できるので、画面遷移の増減などがあった場合にも対応しやすくなります。 この方法をとる場合、Transition定義での条件判定で判定する対象を渡す必要がありますので、判定対象となる情報を含んだContentのIDをdoTransition命令のcontent属性で指定してください。 指定されていないと実行時エラーとなります。 例：Area定義での指定 <doTransition transit="承認対象詳細ポップアップ" content="CC_000001_EditList"/> 例：Page定義での指定 <transition id="承認対象詳細ポップアップ" ref="CT_000001"/> 例：Transition定義(CT_000001)での指定 <transition condition="filter:[item:選択データモデルEntityName = 見積]"> <transit-page next="CP_000001"/> </transition> <transition condition="filter:[item:選択データモデルEntityName = 出荷依頼]"> <transit-page next="CP_000002"/> </transition> <transition condition="filter:[item:選択データモデルEntityName = 発注依頼]"> <transit-page next="CP_000003"/> </transition>

記述例 :　ContentのActionを実行する

<doAction content="CC_XXX_001_Edit" action="更新"/>

説明 :
ContetnのActionを実行する命令です。
この命令を使用することで、Content定義で定義さているActionが実行されて、 コンテント項目の操作やサービス呼び出しなどが行われます。

属性値 :
doActionタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
content	実行したいActionが含まれるContetnのID	文字列	必須	不可
action	実行したいActionのID。	文字列	必須	不可

記述例 :　同じArea内に定義されている別のCommandを実行する

<doCommand command="一括確定実行開始"/>

説明 :
同じArea内に定義されている別のCommandを実行する命令です。
何度も出てくるような処理を一つのCommandにまとめておいて、この命令を使って関数を使うように呼び出すような使い方ができます。
もし、この命令によって呼び出された側のCommandでreturn命令にnextState属性が指定されている場合は無視されます。

属性値 :
doCommandタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
command	実行したいCommandのID。	文字列	必須	不可

記述例 :　OS上でテキストエディタを起動

<execute exe="C:\Program Files\sakura\sakura.exe" arg="content:CC_TEST_EDIT/編集テキストファイル"/>

説明 :
任意の実行ファイルやOSコマンドを実行する命令です。
実行対象のファイル、実行時引数、実行ワーキングディレクトリが指定できます。

属性値 :
executeタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
exe	実行したいファイル、プログラム、コマンドなどの指定。 文字列もしくはjava.io.Fileで指定します。	文字列	必須	可
arg	実行対象に与えるコマンドライン引数の指定。	文字列	必須	可
dir	実行時のワーキングディレクトリの指定。 文字列もしくはjava.io.Fileで指定します。	文字列	必須	可

記述例 : 画面を閉じる

<closeContext />

記述例 : 子画面を閉じる

<closeContext target="children"/>

記述例 : 親画面を閉じる

<closeContext target="parent"/>

記述例 : 親画面に特定のイベントを送信して画面を閉じる

<closeContext event="ワークフロー状態変更"/>

説明 :
画面の実行コンテキストを終了する命令です。
実行コンテキストとは、WindowもしくはAreaの単位で割り振られる実行状態を表すオブジェクトで、 Page,Area,Contentのインスタンスはこの実行コンテキストにぶら下がっています。

この命令を呼び出したAreaが所属する実行コンテキストの終了処理がおこなわれることで、 ぶら下がっている各インスタンスの終了処理が行われて、その結果画面が閉じられます。

この命令の実行時の動作としては、

• Page(ウィンドウ)ごと終了
• 対象Areaのみ(１タブなど)終了

という２パターンがあります。
対象のAreaがPage直下で且つ実行コンテキストが同一の場合は、この命令が呼ばれるとウィンドウごと終了します。 もしタブエリアなどを親に持つ子エリアの場合は、そのエリアのみが終了します。

また、画面が閉じたタイミングで、親画面に対してイベントを送信できます。
event属性で指定された任意のイベントが親画面に対して送信されるので、例えば特定のイベントを伴って 子画面が終了した事を契機にして、親画面側で再検索処理を実行すると言ったことが可能です。 なお、event属性を指定していない場合、デフォルトで"CHILD_CLOSED"というイベントが常に親画面に送信されます。

注意！！！
Dialogタグを使用してポップアップした画面でcloseContext命令を使用した場合、 以下のような処理順となります。

1. まず、呼び出し元画面に子画面終了イベント(CHILD_CLOSED、もしくはevent属性で指定されたイベント)が送信される。
2. 次に、DialogContentのoutputItemタグで指定された値が呼び出し元画面に受け渡される。

このため、Dialogタグによってポップアップした画面から値を受け取って、そのまま続けて呼び出し元画面で何らかの処理を行う場合は、 子画面終了イベントではなくDialogタグのonChange属性もしくはContentItemのtriggerによって行って下さい。 そうしないと、値を受け取る前に呼び出し元画面で処理が動くことになるので意図した通りの動作となりません。

属性値 :
closeContextタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
target	終了させたいコンテキストの指定。 現コンテキスト、親コンテキスト、子コンテキストが指定できます。 親コンテキストを終了させた場合は、結果として自身とその子も終了します。 省略された場合はcurrentが適用される。	current, parent, children	非必須	不可
event	画面終了時に、親画面に対して送信したいイベント名を指定する。 省略時はデフォルトで"CHILD_CLOSED"となる。	文字列	非必須	不可

記述例 :

<showMessageDialog message="実行します" />

説明 :
メッセージダイアログを表示する命令です。

属性値 :
showMessageDialogタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
message	表示させたいメッセージの指定。 固定の文字列を直接書くか、参照記法で外部定義のメッセージを指定します。	文字列	必須	可
level	表示メッセージレベルの指定です。以下が指定できます。 info : 情報メッセージ warning : 警告メッセージ error : エラーメッセージ 指定されたレベルに応じて、メッセージダイアログに表示されるタイトルおよびアイコンが変わります。 省略時はデフォルトでinfoになります。	info, warning, error	非必須	不可

記述例１ : 確認DialogでOKならアクション実行、キャンセルならメッセージ表示

<showConfirmDialog message="更新してもよろしいですか？" >
    <ok>
        <doAction content="CC_XXX_001_Edit" action="更新"/>
    </ok>
    <cancel>
        <showMessageDialog message="更新をキャンセルしました"/>
    </cancel>
</showConfirmDialog>

記述例２ : 確認DialogでYes, No, Cancelの３択をユーザに提示する

<showConfirmDialog message="更新してもよろしいですか？" >
    <yes>
        <doAction content="CC_XXX_001_Edit" action="更新する"/>
    </yes>
    <no>
        <doAction content="CC_XXX_001_Edit" action="更新しない"/>
    </no>
    <cancel>
        <showMessageDialog message="更新をキャンセルしました"/>
    </cancel>
</showConfirmDialog>

説明 :
確認ダイアログを表示する命令です。
確認ダイアログでは、以下の選択肢をユーザーに提示することができます。

• OK, Cancel
• Yes, No, Cancel

ダイアログ上でユーザーが選んだ選択肢毎に処理を分岐できます。 それぞれの実行内容を、showConfirmDialogタグの子タグのokタグ、yesタグ、noタグ、cancelタグの 下に記述してください。どちらか一方のみ(ok時のみ処理を行うなど)でも可です。

なお、ダイアログポップアップ時の初期選択ボタンは、initial属性で指定することができます。
特に指定がない場合はデフォルトでOKもしくはYesになりますが、NoやCancelを選択済みの状態でダイアログをポップアップさせることもできます。

属性値 :
showConfirmDialogタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
message	表示させたいメッセージの指定。 固定の文字列を直接書くか、参照記法で外部定義のメッセージを指定します。	文字列	必須	可
initial	ダイアログポップアップ時の初期選択済みボタンを指定します。 指定がない場合はYesもしくはOKが選択された状態でダイアログがポップアップします。	OK, Yes, No, Cancel	非必須	不可

オプション設定 :
showConfirmDialog命令の必須オプションとして、以下のタグがあります。

okタグ

確認ダイアログ上でOKをユーザが選択した場合に実行したい処理を、このタグの子タグとして記述します。 全てのCommand命令を記述することが出来ます。 選択肢をOK/Cancelで提示する場合はokタグは必須です。

yesタグ

確認ダイアログ上でYesをユーザが選択した場合に実行したい処理を、このタグの子タグとして記述します。 全てのCommand命令を記述することが出来ます。 選択肢をYes/No/Cancelで提示する場合はyesタグは必須です。

noタグ

確認ダイアログ上でNoをユーザが選択した場合に実行したい処理を、このタグの子タグとして記述します。 全てのCommand命令を記述することが出来ます。 noタグは省略可能です。省略時は、No選択時に何も実行されません。

cancelタグ

確認ダイアログ上でキャンセルをユーザが選択した場合に実行したい処理を、このタグの子タグとして記述します。 全てのCommand命令を記述することが出来ます。 cancelタグは省略可能です。省略時は、キャンセル選択時に何も実行されません。

記述例 : ファイル選択を行う

<showFileChooserDialog type="open" selectMode="file" ext="csv"　openfile="content:CC_XXXX_YYYY/選択ファイル"/>

記述例 : ディレクトリ選択を行う

<showFileChooserDialog type="open" selectMode="dir" opendir="content:CC_XXXX_YYYY/選択フォルダ"/>

記述例 : ファイルから読み込んだ内容をContent項目に読み込む

<showFileChooserDialog type="open" ext="txt,csv" read="content:CC_XXXX_YYYY/ファイル読込内容"/>

記述例 : Content項目の内容をファイルに書き出す

<showFileChooserDialog type="save" ext="txt,csv" write="content:CC_XXXX_YYYY/ファイル出力内容"/>

記述例 : ファイルを選択したかどうかで処理を分岐する

<showFileChooserDialog type="open" ext="txt,csv" read="content:CC_XXXX_YYYY/選択ファイル">
    <ok>
        <doAction content="CC_XXXX_YYYY" action="ファイル取込"/>
    </ok>
    <cancel>
        <showMessageDialog message="選択されていません"/>
    </cancel>
</showFileChooserDialog>

説明 :
ファイル選択ダイアログを表示する命令です。
ファイル選択ダイアログ表示直後のカレントディレクトリはcurrentdir属性で指定することが出来ます。
この命令で表示したファイル選択ダイアログから以下の処理を行うことが出来ます。

• ダイアログで選択されたファイル／ディレクトリを表すjava.io.Fileオブジェクトを取得する。
• ダイアログで選択されたファイル／ディレクトリのパス文字列を取得する。
• ダイアログで選択されたファイルの内容を読み込んで取得する。(読込結果はjava.lang.Stringかpexa.share.util.cont.Binary)
• ダイアログで指定されたファイルにデータを書き出す。(出力内容はjava.lang.Stringかpexa.share.util.cont.Binary)

ダイアログ上でファイル選択の操作を行って実行ボタンを押下したら、type属性,selectMode属性で指定したモードに応じた処理を実行します。

type="open"の場合
読込のためのファイル／ディレクトリ選択処理を行います。選択対象はselectMode属性でfile/dirを指定します。
selectMode="dir"とした場合はshowFile属性も合わせて指定できます。これはフォルダだけでなくファイルもダイアログ中に表示するかの指定です。
選択したファイルの内容を直接読み込むならread属性をペアで指定します。
read属性で指定する読込先はjava.lang.Stringもしくはpexa.share.util.cont.Binaryのどちらかになります。
選択ファイルのjava.io.Fileオブジェクトやパス文字列を取得する場合は以下の属性を指定します。

1. openfile属性　:　選択ファイルのjava.io.Fileオブジェクトを格納する先を指定する。
2. opendir属性　:　選択ファイル／ディレクトリのjava.io.Fileオブジェクトを格納する先を指定する。
3. readfile属性　:　選択ファイルの名前を格納する先を指定する。
4. readdir属性　:　選択ファイル／ディレクトリのディレクトリパス文字列を格納する先を指定する。
5. readpath属性　:　選択ファイル／ディレクトリのフルパス文字列を格納する先を指定する。(readdir + readfileと等価)

選択ファイル／ディレクトリのjava.io.Fileやパス文字列を取得するのみであれば、ファイルの種類には特に制限はありません。

なお、multiSelection属性でtrueを指定することで、複数ファイルを一度に選択することができるようになります。
複数ファイル選択可能にした場合は、read属性は無効となり、その他の各属性で指定された格納先にはStringやFileのListが格納されるようになります。 その場合にContent項目を格納先に指定した場合はContent項目の種別をvaluesにして下さい。


type="save"の場合"
出力のためのファイル選択処理を行います。write属性をペアで指定します。
write属性で指定するファイル出力内容は、java.lang.Stringもしくはpexa.share.util.cont.Binaryのどちらかになります。
同名ファイルへの上書きについてはoverwrite属性でポリシーを指定できます。省略時は上書きとなります。
保存ファイルのjava.io.Fileオブジェクトやパス文字列を取得する場合は以下の属性を指定します。

1. savefile属性　:　保存ファイルのjava.io.Fileオブジェクトを格納する先を指定する。
2. savedir属性　:　保存ファイルのjava.io.Fileオブジェクトを格納する先を指定する。
3. writefile属性　:　保存ファイルの名前を格納する先を指定する。
4. writedir属性　:　保存ファイルのディレクトリパス文字列を格納する先を指定する。
5. writepath属性　:　保存ファイルのフルパス文字列を格納する先を指定する。(writedir + writefileと等価)

ファイル選択ダイアログ上でＯＫボタンを押されたかキャンセルボタンを押されたかで処理を分けたい場合は、
showConfirmDialog命令と同じようにokタグやcancelタグを指定することが出来ます。

approvedtext属性でダイアログのタイトル及びOKボタンに表示する文字列を自由に指定することが出来ます。
指定が無い場合はtype属性に合わせた標準的な表示になります。

読み書きするファイルがテキストファイルの場合は、encoding属性で文字コード指定ができます。
指定が無い場合は実行時プラットフォームのデフォルトエンコーディングになります。

属性値 :
showFileChooserDialogタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
type	ファイル選択ダイアログで行う処理の種別を指定する。 ファイル読み込みなら"open"、ファイル出力なら"save"を指定する。	open, save	必須	不可
multiSelection	type=openの場合に、複数ファイルの同時選択を許すかを指定します。 trueを指定した場合、read属性は無効となり、その他の格納先にはStringやFileのListが格納されます。 省略時はfalse扱いとなります。	true, false	非必須	可
selectMode	type="open"の場合に、選択対象をファイルにするのかディレクトリにするのかを指定する。 ファイル選択なら"file"、ディレクトリ選択なら"dir"を指定する。	file, dir	非必須(省略時はfileになる)	不可
showFile	selectMode="dir"の場合に、ファイル選択ダイアログ中にフォルダだけでなくファイルも表示するかを指定する。 "on"と指定すればファイルも表示されるようになるが、もしフォルダではなくファイルが選択された場合はその親フォルダが選択された物として処理する	on, off	非必須(省略時はoffになる)	不可
ext	ファイル選択ダイアログで取り扱いたいファイルの拡張子を指定する。 カンマ区切りで複数個指定することが可能。	文字列	非必須	不可
approvedtext	ファイル選択ダイアログのOKボタン及びタイトルに表示する文字列を指定する。 省略された場合は、type属性に合わせたデフォルト設定が適用される。	文字列	非必須	可
overwrite	type="save"の場合に、同名ファイルが存在していた場合の上書きポリシーを指定できます。 alwaysの場合は常に上書きします。confirmと指定すると、上書き確認ダイアログが表示されます。 省略された場合は、デフォルトで"always"の扱いになります。	always, confirm	非必須(省略時はalwaysになる)	不可
encoding	読み書きするファイルがテキストファイルの場合に、文字コードを指定できます。 type="open"の場合は読込時のエンコーディングとなり、type="save"の場合は出力時のエンコーディングになります。 指定が無い場合は実行時プラットフォームのデフォルトエンコーディングになります。	文字列	非必須	可
currentdir	ファイル選択ダイアログを開いた直後のカレントディレクトリを表すjava.io.Fileオブジェクトを指定する。 基本的には参照記法でContentの項目にリンクさせる。指定できる項目はtype="value"。	文字列	非必須	可(基本はContent参照)
defaultfile	ファイル選択ダイアログ表示時のファイル名指定フィールドにデフォルト表示されるファイル名を指定する。 Area定義での固定値直接指定か、もしくは参照記法でContentの項目にリンクさせる。指定できる項目はtype="value"。	文字列	非必須	可
write	type属性が"save"の場合に、ファイルに出力する内容を指定する。 基本的には参照記法でContentの項目にリンクさせる。指定できる項目はtype="value"もしくは"binary"。	文字列(基本はContent参照)	非必須	可(基本はContent参照)
writedir	type="save"の場合で、保存したファイルのディレクトリフルパス文字列の格納先を指定する。 基本的には参照記法でContentの項目にリンクさせる。指定できる項目はtype="value"。	文字列	非必須	可(基本はContent参照)
writefile	type="save"の場合で、保存したファイルの名前の格納先を指定する。 基本的には参照記法でContentの項目にリンクさせる。指定できる項目はtype="value"。	文字列	非必須	可(基本はContent参照)
writepath	type="save"の場合で、保存したファイルのフルパス文字列の格納先を指定する。 writedir + writefile = writepathとなります。 基本的には参照記法でContentの項目にリンクさせる。指定できる項目はtype="value"。	文字列	非必須	可(基本はContent参照)
savedir	type="save"の場合で、保存したファイルのディレクトリのjava.io.Fileオブジェクト格納先を指定する。 基本的には参照記法でContentの項目にリンクさせる。指定できる項目はtype="value"。	文字列	非必須	可(基本はContent参照)
savefile	type="save"の場合で、保存したファイルのjava.io.Fileオブジェクトの格納先を指定する。 基本的には参照記法でContentの項目にリンクさせる。指定できる項目はtype="value"。	文字列	非必須	可(基本はContent参照)
read	type属性が"open"の場合に、ファイルから読み込んだ内容を設定する先を指定する。 基本的には参照記法でContentの項目にリンクさせる。指定できる項目はtype="value"。	文字列(基本はContent参照)	非必須	可(基本はContent参照)
readdir	type="open"の場合で、読み込んだファイル／ディレクトリのディレクトリフルパス文字列の格納先を指定する。 selectMode="file"の場合は選択ファイルの配置ディレクトリ、selectMode="dir"の場合は選択ディレクトリそのもの。 基本的には参照記法でContentの項目にリンクさせる。指定できる項目はtype="value"。	文字列	非必須	可(基本はContent参照)
readfile	type="open", selectMode="file"の場合で、読み込んだファイルの名前の格納先を指定する。 基本的には参照記法でContentの項目にリンクさせる。指定できる項目はtype="value"。	文字列	非必須	可(基本はContent参照)
readpath	type="open"の場合で、読み込んだファイルのフルパス文字列の格納先を指定する。 readdir + readfile = readpathとなります。 基本的には参照記法でContentの項目にリンクさせる。指定できる項目はtype="value"。	文字列	非必須	可(基本はContent参照)
opendir	type="open"の場合で、読み込んだファイル／ディレクトリのディレクトリのjava.io.Fileオブジェクト格納先を指定する。 selectMode="file"の場合は選択ファイルの配置ディレクトリ、selectMode="dir"の場合は選択ディレクトリそのもの。 基本的には参照記法でContentの項目にリンクさせる。指定できる項目はtype="value"。	文字列	非必須	可(基本はContent参照)
openfile	type="open", selectMode="file"の場合で、読み込んだファイルのjava.io.Fileオブジェクトの格納先を指定する。 基本的には参照記法でContentの項目にリンクさせる。指定できる項目はtype="value"。	文字列	非必須	可(基本はContent参照)
initdisp	FileChooser初期表示での表示形式を設定する。 表示形式はリスト表示・明細表示の2種類で、明細表示時はソート条件も設定できる。 リスト表示なら”L"、明細表示なら"D"を指定する。 明細表示時"D"の次にソート項目として、ファイル名なら"N"、サイズなら"S"、拡張子なら"E"、更新日付なら"O"を指定する。 さらに、ソート順を指定する文字列が続き、昇順なら"U"、降順なら"D"を指定する。 例：明細表示・更新日付・新しい順なら、"DOD"になる。	文字列 L (Default) DNU DOD,....	非必須	不可

オプション設定 :
showFileChooserDialog命令の任意オプションとして、以下のタグがあります。
どちらも省略可能です。

okタグ

ファイル選択ダイアログ上でOKをユーザが選択した場合に実行したい処理を、このタグの子タグとして記述します。 全てのCommand命令を記述することが出来ます。

cancelタグ

ファイル選択ダイアログ上でキャンセルをユーザが選択した場合に実行したい処理を、このタグの子タグとして記述します。 全てのCommand命令を記述することが出来ます。

上書き確認ダイアログの動作

type="save"かつoverwrite="confirm"を指定した場合、ファイル選択ダイアログで既に存在しているファイルを選択した場合はファイル上書き確認ダイアログが表示されます。 この確認ダイアログのキャンセルボタンを押した場合は以下のような動作となりますので注意してください。 [選択ファイルの各種情報] type="save"の場合に指定できる、ファイル選択ダイアログでの選択ファイルについての各種情報(savefile属性など)は上書き確認ダイアログでOK/キャンセルどちらを選択しても保存されます。 そのため、いったんキャンセルしたとしても次にファイル選択ダイアログを表示する際の初期値にこれらを利用することも可能です。 [okタグとcancelタグの分岐] okタグやcancelタグの記述がある場合は、上書き確認ダイアログでのOK/キャンセルにしたがって処理が分岐します。 そのため、ファイル選択ダイアログで「OK」を選択したとしても、上書き確認ダイアログで「キャンセル」を選んだ場合は処理はcancelタグ側に分岐します。

記述例 :

<showMailClient uri="content:CC_XXXX_YYYY/メール宛先ののURI"/>

説明 :
デフォルトメールクライアントを起動する命令です。
url属性で指定されたURIの宛先としてメールクライアントが起動されます。
業務項目内のメールアドレスを宛先とする送信用のメールクライアントを表示し、送信情報を追加して送信処理を行うために使用します。
Windowsでのみ動作確認されています。

属性値 :
showMailClientタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
uri	宛先メールアドレスのURIを指定する。 固定文字列による指定でも、参照記法でContentからURIを取得しても可。 Content項目の場合、指定できる項目はtype="value"のみです。 スキーマとして"mailto:"がないときは自動的に追加します。	文字列	必須	可
wait	メールクライアント起動処理の後にwaitを入れるかどうかを指定します。 Windowsの場合、showMailClient命令をwait無しで連続で複数回実行するとShellがコマンドを取りこぼすことがあり、 表示が失敗することがあります。そこで、もしshowMailClient命令を連続実行したい場合はこの属性をonにしてください。 省略された場合はoffが指定された物と見なします。	on, off	非必須	不可

記述例 :

<showWebBrowser url="content:CC_XXXX_YYYY/印刷結果PDFのURL"/>

説明 :
Webブラウザを起動する命令です。
url属性で指定されたURLの内容を表示するWebブラウザが起動されます。
帳票の印刷結果であるPDFファイルを表示したり、特定のWeb上のドキュメントを参照するのに使用します。

属性値 :
showWebBrowserタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
url	ブラウザで表示する内容のURLを指定する。 固定文字列による指定でも、参照記法でContentからURLを取得しても可。 Content項目の場合、指定できる項目はtype="value"のみです。	文字列	必須	可
wait	ブラウザ起動処理の後にwaitを入れるかどうかを指定します。 Windowsの場合、showWebBrowser命令をwait無しで連続で複数回実行するとShellがコマンドを取りこぼすことがあり、 表示が失敗することがあります。そこで、もしshowWebBrowser命令を連続実行したい場合はこの属性をonにしてください。 省略された場合はoffが指定された物と見なします。	on, off	非必須	不可

記述例 :

<setTitle title="content:CC_XXX_Edit/ウィンドウタイトル"/>

説明 :
実行時にエリアが所属しているページのウィンドウタイトルの設定を行う命令です。
Page定義で指定できるウィンドウタイトルは、画面初期化時のみ適用されるため、実行時に状況に応じてウィンドウタイトルを変化させたい場合などにはこの命令を使用してください。

属性値 :
setTitleタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
title	ウィンドウタイトルとして表示したい値の指定。 通常は参照記法で指定します。	文字列	必須	可

記述例 :

<setValue to="content:CC_XXX_001_Login/ログイン日時" value="calendar:TODAY"/>

説明 :
値の設定を行う命令です。
画面の制御の都合でパラメーター設定が必要となった場合に、Contentに設定する等の使い方があります。
設定先、設定する値のどちらも参照記法を使用できます。

※なお、なるべくこの命令は使用しないで下さい。特にContentに対する値の設定やクリア処理はContentのAction内で行うべきです。 この命令を使用するのは、画面の制御を行う上でやむを得ずフラグやパラメータを設定したいような場合に限ります。

属性値 :
setValueタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
to	値の設定先の指定。 通常は参照記法で指定します。	文字列	必須	可
value	設定する値の指定。 固定の文字列を直接書くか、参照記法で指定します。	文字列	必須	可

記述例 : 判定結果がtrueならアクション実行、falseならメッセージ表示

<if condition="filter:[page:context = 更新]" >
    <true>
        <doAction content="CC_XXX_001_Edit" action="更新"/>
    </true>
    <false>
        <showMessageDialog message="更新をキャンセルしました"/>
    </false>
</if>

説明 :
条件判定による処理分岐を行う命令です。
condition属性で指定された条件の判定結果がtrueの場合、falseの場合で処理を分岐できます。 それぞれの実行内容を、ifタグの子タグのtrueタグ、falseタグの下に記述してください。 どちらか一方のみ(true時のみ、false時のみ処理を行う)でも可です。

属性値 :
ifタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
condition	判定条件の指定。 参照記法でfilterを指定するか、true/falseを返すContent項目などを指定します。	true, false	必須	可

オプション設定 :
if命令のオプションとして、以下のタグがあります。
trueタグ、falseタグのどちらか一方は必ず記述します。

trueタグ

condition属性で指定された内容がtrueの場合に実行したい処理を、このタグの子タグとして記述します。 全てのCommand命令を記述することが出来ます。

falseタグ

condition属性で指定された内容がfalseの場合に実行したい処理を、このタグの子タグとして記述します。 全てのCommand命令を記述することが出来ます。

記述例 : 値に応じて画面遷移先を変える

<switch condition="content:CC_XXX_001_Condig/申請種別">
    <case value="ptype:申請種別/申請その１">
        <doTransition transit="遷移先その１"/>
    </case>
    <case value="ptype:申請種別/申請その２">
        <doTransition transit="遷移先その２"/>
    </case>
    <case value="ptype:申請種別/申請その３">
        <doTransition transit="遷移先その３"/>
    </case>
    <default>
        <doTransition transit="デフォルト遷移先"/>
    </default>
</switch>

説明 :
値による処理分岐を行う命令です。
condition属性で指定された値が、caseタグのvalue属性で指定された値に一致した場合に、 該当のcaseタグの下にかかれた命令が実行されます。どれにも当てはまらない場合の実行内容は defaultタグの子タグとして記述できます。defaultタグは無くてもかまいません。

属性値 :
switchタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
condition	判定する値の指定 参照記法で、判定条件となる値を指定してください。	文字列	必須	可

オプション設定 :
switch命令のオプションとして、以下のタグがあります。
caseタグは必須、defaultタグは省略可です。

caseタグ

condition属性で指定された値と、このタグのvalue属性で指定された値が一致する場合に、 このタグの下に記述されている命令が実行されます。 全てのCommand命令を記述することが出来ます。 必要なだけ複数個列挙することが出来ます。 属性値名 説明 形式 必須／非必須 参照記法可／不可 value 分岐条件となる値の指定。 この値と、switchタグのcondition属性で指定された値が一致した場合に caseタグの下に記述された命令が実行されます。 文字列 必須 可

defaultタグ

どのcaseタグの条件にも当てはまらなかった場合の、デフォルトの処理内容を記述します。 全てのCommand命令を記述することが出来ます。 省略可能です。

記述例 :

<return nextstate="明細行編集状態"/>

説明 :
commandの実行を終了する命令です。
if命令やswitch命令による判定でcommandを終了する必要がある場合や、 command終了後にArea定義のstatechartセクションで定義した状態遷移表に従って別状態へ遷移したい場合に使用します。
状態遷移する必要がなければnextstate属性を省略してください。

属性値 :
returnタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
nextstate	遷移先状態の指定。 Area定義のstatechartセクションで定義された状態を指定します。	文字列	非必須	不可

記述例 :

<logging message="デバッグメッセージ"/>

説明 :
任意の内容をログ出力する命令です。
デバッグ時に、意図した処理ルートを通っているかやContent項目に正しい値が設定されているかなどを確認したい場合に使用して下さい。

なお、ここで指定されたログメッセージはCommons Logging APIに対してDEBUGレベルで送出されます。 ログ出力設定はログ実装によって異なりますが、JDK標準ロガーの場合は以下の設定をlogging.propertiesに追加してください。

pexa.client.std.interpreter.level = ALL

属性値 :
loggingタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
message	ログ出力したい内容を指定します。 文字列の直接指定や参照記法が使用できます。	文字列	必須	可

記述例 :

<requestFocus component="ユーザーIDテキストフィールド"/>

説明 :
任意のコンポーネントに対してフォーカスを移動させる命令です。
特定の処理を実行時にフォーカスを強制的に特定の箇所に移動させたい場合に使用します。

属性値 :
requestFocusタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
component	フォーカスをあてたいGUIコンポーネントのname属性値を指定します。	文字列	必須	不可

記述例 : パラメータ無しの場合

<notify notification="操作完了"/>

記述例 : パラメータ有りの場合

<notify notification="操作完了">
    <inputItem item="ログインユーザ情報" from="content:CC_AAA_111/ログインユーザ情報"/>
    <inputItem item="操作時刻" from="calendar:NOW"/>
</notify>

説明 :
Notification定義で定義されている通知イベントを送信します。
必要であれば送信元からパラメータを通知イベントに含めることが出来ます。

ここで指定できる通知イベント名は、Notification定義で定義されているものだけです。
定義されていない通知が指定されるとエラーとなります。

属性値 :
notifyタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
notification	送信する通知イベント名を指定します。	文字列	必須	不可

任意のオプションとして、パラメータ設定を行うinputItemタグがあります。

inputItem

呼び出し元から通知イベントに含める入力パラメーターの指定です。 通知イベントを受信する側で処理に必要な情報を渡す必要がある場合に使用して下さい。 任意の個数を設定できますが、設定できるパラメータはNotification定義に定義されているものだけです。 それ以外のitemが指定された場合はエラーになります。 属性値名 説明 形式 必須／非必須 参照記法可／不可 item Notification項目IDを指定します。 文字列 必須 不可 from 呼び出し元から渡す値を指定します。 直接指定や参照記法によるContent項目の指定などができます。 文字列 必須 可

記述例１ : 検索結果テーブルの選択行を先頭に変更する

<changeSelection component="検索結果テーブル" operation="first"/>

記述例２ : 検索結果テーブルの選択行をクリアする

<changeSelection component="検索結果テーブル" operation="clear"/>

記述例３ : 検索結果テーブルの選択行を特定の行データに合わせる。
ただし、該当データがなければ先頭行に合わせる。

<changeSelection component="検索結果テーブル" operation="rowdata" rowdata="content:CC_XXX_EditList/対象データ" notfound="first"/>

説明 :
Area上に配置されているTableもしくはListコンポーネントの選択行をCommand側から変更する命令です。
特定のコマンドを実行した後にTable等の選択行を変更したい場合に使用してください。

operation="rowdata"の場合、rowdata属性で指定した行データに該当する物が一覧上に無いというケースがあります。
この場合の動作はnotfound属性で指定することができます。該当データがなければ先頭行にする、選択状態をクリアするなどの動作を指定できます。

操作対象となるコンポーネントごとにいくつか注意点があります。
それぞれについて以降で説明します。

• 操作対象がTableの場合
• 操作対象がListの場合

属性値 :
changeSelectionタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
component	選択行を制御したいTableもしくはListのGUIコンポーネントのname属性値を指定します。	文字列	必須	不可
operation	選択行の制御種別を指定します。以下が指定できます。 clear : 選択状態解除 first : 先頭行を選択状態にする last : 最終行を選択状態にする up : 現在の選択行の一行上を選択状態にする down : 現在の選択行の一行下を選択状態にする nochange : 現在の選択行のままにしておく。 これを指定する場合は、まずCommand内の先頭でchangeSelection命令を呼び出して、その後に行いたい処理(データ削除処理など)を行うと良い。 rowdata : rowdata属性で指定されたオブジェクトに対応する行を選択状態にする selectAll : 複数行選択が可能であれば、全行選択する clearAll : 複数行選択が可能であれば、全行選択解除する restoreMulti : 複数行選択が可能であれば、TableタグのmultiSelectedRows属性で指定された情報から複数行選択状態を復元する。	clear, first, last, up, down, nochange, rowdata, selectAll, clearAll, restoreMulti	必須	不可
rowdata	operation="rowdata"の場合に指定する、選択状態にしたい行に対応するデータオブジェクトを指定します。 基本的にはContentのitemを参照記法で指定します。	文字列	operation="rowdata"の場合に必須	可
notfound	operation="rowdata"の場合に、rowdata属性で指定されたデータが一覧上に存在しない場合の動作を指定します。 省略時はclearがデフォルト値として適用されます。 clear : 選択状態解除 first : 先頭行を選択状態にする last : 最終行を選択状態にする selectAll : 複数行選択が可能であれば、全行選択する clearAll : 複数行選択が可能であれば、全行選択解除する	clear, first, last, selectAll, clearAll	非必須(省略時はclearとなる)	不可
multiple	複数行選択の操作として処理を行うかの指定です。 チェックボックスによる複数行選択を行う動作モードのTableコンポーネントに対して使用することを想定しています。 trueと指定された場合は、changeSelection命令によって選択された行の行選択チェックボックスがONになります。 省略時はfalseがデフォルト値として適用されます。	true, false	非必須(省略時はfalseとなる)	可

操作対象がTableの場合

Tableが操作対象の場合は選択操作を行に対して行うか列に対して行うかが指定できるようになっています。 どちらの場合でもchangeSelection命令を使用することはできますが、列選択モードの場合は一部指定できないoperationがあります。 以下にその対応を記述します。 tableのselectStyle 指定できるoperation row clear first last up down nochange rowdata selectAll clearAll restoreMulti column clear first last up down nochange selectAll clearAll

操作対象がListの場合

Listが操作対象の場合は現状では特に注意点はありません。

記述例 : 全タブを閉じる

<changeTabStatus operation="closeAll"/>

記述例 : 特定のタブのみを無効にする

<changeTabStatus operation="disableAt" at="CA_001"/>

記述例 : 特定のタブ以外を有効にする

<changeTabStatus operation="enableExclude" at="CA_001"/>

説明 :
このCommand命令は、レイアウトに以下を使用しているArea(親Area側)でのみ使用できます。

• TabbedPaneLayout
• CombinedTabbedPaneLayout

上記のレイアウトを使用しているAreaは、子のAreaをタブ展開する親Areaという位置づけになります。
この子Areaが格納されている各タブの状態を制御をchangeTabStatus命令で行うことができます。

行える状態変更の操作は以下の９種類です。
All系(全タブが対象)、At系(特定タブが対象)、Exclude系(特定タブ以外の全タブが対象)の３タイプがあります。

operation	制御内容
enableAll	全てのタブを有効化する
disableAll	全てのタブを無効化する
closeAll	全てのタブを閉じる
enableAt	特定のタブのみを有効化する。対象タブはat属性で指定する。
disableAt	特定のタブのみを無効化する。対象タブはat属性で指定する。
closeAt	特定のタブのみを閉じる。対象タブはat属性で指定する。
enableExclude	特定のタブ以外を有効化する。除外対象タブはexclude属性で指定する。
disableExclude	特定のタブ以外を無効化する。除外対象タブはexclude属性で指定する。
closeExclude	特定のタブ以外を閉じる。除外対象タブはexclude属性で指定する。

なお、上記のうちAt系の操作とExclude系の操作については、対象タブ／対象外タブをエリアIDで指定します。

属性値 :
changeTabStatusタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
operation	TabbedPaneLayoutによって生成されたタブに対して行う操作の種別を指定します。 操作種別の意味については上記の一覧を参照して下さい。	enableAll, disableAll, closeAll, enableAt, disableAt, closeAt, enableExclude, disableExclude, closeExclude	必須	不可
at	operation属性がenableAt/disableAt/closeAtの場合に必須となる属性です。 どのタブに対して操作を行うかを、タブに格納されている子AreaのAreaIDで指定します。	文字列	At系操作の場合に必須	可
exclude	operation属性がenableExclude/disableExclude/closeExcludeの場合に必須となる属性です。 どのタブを操作の除外対象にするかを、タブに格納されている子AreaのAreaIDで指定します。	文字列	Exclude系操作の場合に必須	不可

記述例 :

<refresh component="申請書一覧テーブル"/>

説明 :
Area全体、もしくは任意のコンポーネントの表示を強制的にリフレッシュする命令です。
基本的な使用法としては、refreshBy属性を持つコンポーネントで"command"が指定されているものに対してリフレッシュを行うために使用します。
refreshBy属性についてはComponentの共通属性値についての説明を参照してください。

component属性で対象コンポーネントのIDを指定すれば、そのコンポーネントのみを強制リフレッシュします。
component属性を省略した場合はArea全体が強制リフレッシュされます。

属性値 :
refreshタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
component	表示リフレッシュしたいGUIコンポーネントのname属性値を指定します。 省略した場合はArea全体を強制的にリフレッシュします。	文字列	非必須	不可

記述例 : 指定されたファイルを開くようにOSに依頼する

<openFile file="content:CC_SAMPLE_001/開く対象のファイル" />

説明 :
OSの機能を呼び出してファイルを開くための命令です。

Clientを実行しているOS上で対象ファイルに関連付けされているアプリケーションが呼び出されて、 file属性で指定されたファイルを開きます。
showFileChooserDialog命令などと組み合わせて、 選択されたファイルが.txtファイルの場合はテキストエディタを、.xlsファイルならExcelを開くといった事が可能です。

この命令はあくまでOSに対して対象ファイルをOpenすることを要求するだけなので、 実際にどんなアプリケーションが起動するかはOS上でのファイルに対する関連付け設定で決まります。

属性値 :
openFileタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
file	対象ファイルの指定です。通常は参照記法でContentItemを指定します。 ここで指定できる値は対象ファイルを表すjava.io.Fileオブジェクトもしくはフルパス文字列です。	文字列	必須	可

記述例 :

<operateDynamicForm component="作業指示入力フォームPanel" operation="fix"/>

説明 :
DynamicFormコンポーネントタグによる動的フォームを制御するための命令です。
動的フォームは実行エンジン側で初期化などのタイミングを検出することができないため、この命令を使用してArea定義のCommandから指示します。

動的フォームフレームワークについてはサポートフレームワークのガイドを参考にして下さい。

属性値 :
operateDynamicFormタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
component	制御対象の動的フォームのコンポーネントIDを指定します。	文字列	必須	不可
operation	動的フォームに対して行う制御操作を指定します。 setup : 項目メタ情報及び入力値データモデルを読み込んで動的フォームを初期化、表示します。 load : 入力値データモデルの内容を再読込して動的フォーム上に表示し直します。 fix : 動的フォーム上の入力内容を確定して、入力値データモデルに値を設定します。	setup, load, fix	必須	不可

記述例 : 読み込みファイルを表すFileオブジェクトもしくはフルパスで指定

<readFile file="content:CC_SAMPLE_001/読み込みファイル" 
          to="content:CC_SAMPLE_001/ファイル内容"/>

記述例 : 読み込みファイルを表すディレクトリとファイル名の組で指定

<readFile dir="content:CC_SAMPLE_001/読み込みフォルダ" 
          filename="content:CC_SAMPLE_001/読み込みファイル名" 
          to="content:CC_SAMPLE_001/ファイル内容"/>

説明 :
ファイルの読み込みを行う命令です。
showFileChooserDialog命令などと組み合わせて、 特定ディレクトリ内にあるファイルを一度に読み込むと言った用途に使用することが出来ます。

読み込むファイルの指定方法は以下の２通りがあります。

• 対象ファイルを直接指定する(file属性)
• ディレクトリとファイル名の組で指定する(dir属性とfilename属性)

例えば、showFileChooserDialog命令でディレクトリをユーザーに選択させてContentItemに保存しておき、 後者の指定方法を使用して特定のファイルを読み込むことが出来ます。

属性値 :
readFileタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
file	読み込みファイルの指定です。通常は参照記法でContentItemを指定します。 ここで指定できる値は読み込み対象ファイルを表すjava.io.Fileオブジェクトもしくはフルパス文字列です。 dir属性と排他関係となります。	文字列	dir属性を指定しない場合に必須	可
dir	読み込みファイルの格納ディレクトリ指定です。通常は参照記法でContentItemを指定します。 ここで指定できる値は対象ディレクトリを表すjava.io.Fileオブジェクトもしくはフルパス文字列です。 file属性と排他関係となります。またfilename属性と組み合わせることが必須となります。	文字列	file属性を指定しない場合に必須	可
filename	読み込みファイル名(パスは含まない)の指定です。参照記法もしくはファイル名直接指定などができます。 ここで指定できる値はファイル名文字列となります。 dir属性と組み合わせることが必須となります。	文字列	dir属性がある場合に必須	可

記述例 :

<showDialog name="部署選択補助ダイアログ" />

説明 :
コンポーネントタグのDialogタグで定義された入力補助画面を起動する命令です。
name属性でポップアップさせるダイアログのIDを指定します。

なお、この命令で起動できるDialogはowner="area"と指定されている物だけです。
owner="component"となっているDialogは対象外です。

属性値 :
showDialogタグの属性値の意味は以下の通り。

属性値名	説明	形式	必須／非必須	参照記法可／不可
name	起動するDialogタグのid属性で指定されているダイアログ名を指定します。	文字列	必須	不可

記述例 :

<toFront/>

説明 :
この命令を実行したAreaが張り付いているウィンドウを前面表示します。
後ろに隠れている画面に対してnotify命令などでイベント送信して、
イベントを受け取った側の画面でこの命令を実行するような使い方になります。

• 最終更新者 : $Author: tann $
• 最終更新日時 : $Date:: 2017-05-30 15:51:50 #$
• バージョン : $Revision: 8717 $