The PEXA Client - Page定義ファイル

PEXA Clientについて

チュートリアル

定義パターン

定義ファイル

リファレンス

はじめに

Page定義の内容

identityセクション

descriptionセクション

layoutセクション

event-listener-listセクション

transition-listセクション

statusセクション

Page定義全体のサンプル

はじめに

このドキュメントは、PEXAクライアントフレームワークで使用するPage定義ファイルについて解説するものです。

Page定義ファイルは、"画面"の単位で作成されるXML形式の定義ファイルです。
この定義ファイルには、画面に含まれるAreaとその配置情報、画面遷移情報などが含まれます。位置づけとしては、MVCモデルにおけるV(View)にあたります。

Page定義ファイルの内部は、いくつかのセクションに分かれています。以下でPage定義ファイルの内容の概説およびそれぞれのセクションの詳細を解説していきます。

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

Page定義の内容

Page定義に含まれる情報には、主に以下の物があります。

Pageの識別情報

Pageのレイアウト制御情報

イベントリスナの定義

画面遷移の情報

Pageの識別情報

Pageはシステム内でユニークに特定できる必要があります。
そのために、Pageを識別するためのIDや名称を必ず定義する必要があります。
また、ページの補助的な属性情報として、ステレオタイプや実行コンテキストを定義できます。

詳細はidentityセクションを参照してください。

Pageのレイアウト制御情報

PageはWindow内の特定の場所にAreaをはめ込むことで画面を生成します。
このときの配置レイアウトはフレームワークで汎用レイアウトが一つ用意されており、それ以外にもプロジェクト毎に専用レイアウトを作成して利用することが出来ます。
それらのうち、どのレイアウトを使用してどの領域にどのAreaを配置するかを記述するのがこのセクションです。

また、リッチクライアントの場合のOptional情報として、ウィンドウのサイズ、リサイズ可、不可、ウィンドウタイトル設定といった細かいウィンドウ制御のパラメータや、エリアをはめ込む位置に対するパラメータを指定することが出来ます。

詳しくはlayoutセクションを参照してください。

イベントリスナの定義

ある特定のユーザー操作によって、ページ上で特定のイベントが発生することがあります。たとえば、ウィンドウのタイトルバー右上のバツボタンによって画面を閉じようとした場合などがあります。
こういったイベントが発生した際に、画面がどのように反応するかを定義するのがこのセクションです。
また、ClientFrameworkのNotification機能によって送信される通知イベントに対する処理もここで定義できます。

ここでは、実行する処理内容をスクリプト的に処理命令で記述することが出来ます。

詳しくはevent-listener-listセクションを参照してください。

画面遷移の情報

このフレームワークでは、画面遷移はPage間の遷移情報として表されます。
そのため、ある画面から発生しうる画面遷移は全て遷移元のPage定義に宣言されます。
Area定義に記述されている画面操作時の処理定義でこのPage定義上の画面遷移をIDで指定することで実際の画面遷移を実行することが出来ます。

画面遷移の種別は４種類あり、Windowを変えずに行う画面遷移、別Windowのポップアップを伴う画面遷移、 Page内の特定のAreaのみを切り替えるArea切替、タブ領域にAreaを追加するArea追加を行うことが出来ます。

詳しくはtransition-listセクションを参照してください。

identityセクション

記述例 :
<identity id="CP_WKFL_Login"
          name="ワークフローログイン"
          stereotype="ログイン画面"
          context="ログイン"/>
説明 :
identityセクションは、Pageの識別情報を記述するセクションです。
IDや名称、画面展開パターンにおけるページのステレオタイプ、実行コンテキストを定義します。

フレームワークの制御上、id属性は必須になりますが、残りは省略可です。
ただし、これらはプロジェクトによってはウィンドウタイトル等を決定するための補助情報として利用される場合がありますので、プロジェクト毎のルールに従って記述してください。

属性値 :
identityタグの属性値は以下の通り。

属性値名説明形式必須／非必須参照記法可／不可

id システム内でユニークになるPageの識別ID 文字列必須不可

name Pageの名称。
画面タイトル文字列などに利用される場合がある。文字列非必須不可

stereotype 画面展開パターン内でのPageのステレオタイプ。
画面タイトルやウィンドウタイトルなどを決定するための補助情報として利用される場合がある。文字列非必須不可

context 画面で行われる処理を端的に表す実行コンテキスト名称
コンポーネントの制御するための補助情報として利用される場合がある。文字列非必須不可

preference Pageに関する設定保存のON,OFF指定。
プロパティファイルのPreference.page.defaultの設定に対するPage単位での上書き設定となる。 save,
not_save 非必須不可

descriptionセクション

記述例 :
<description>
    ワークフローにログインする画面です。
</description>
説明 :
descriptionセクションは、Pageの詳細説明を記述するセクションです。
フリーフォーマットで文章で記入してください。

layoutセクション

記述例 : BorderLayoutによる単純な配置の場合
<layout ref="BorderLayout">
    <gui width="1024" height="733"/>
    <area-mapping>
        <area location="NORTH" ref="CA_COMM_000_01_Header"/>
        <area location="CENTER" ref="CA_WKFL_000_01_Login"/>
        <area location="SOUTH" ref="CA_COMM_000_02_Footer"/>
    </area-mapping>
</layout>
記述例 : 各エリアの初期サイズ指定をする場合
<layout ref="BorderLayout">
    <gui width="1024" height="733">
        <location ref="NORTH" preferredSize="500,100"/>
        <location ref="CENTER" preferredSize="500,350"/>
        <location ref="SOUTH" preferredSize="500,50"/>
    </gui>
    <menubar ref="CA_WKFL_MenuBar"/>
    <area-mapping>
        <area location="NORTH" ref="CA_COMM_000_01_Header"/>
        <area location="CENTER" ref="CA_WKFL_000_01_Login"/>
        <area location="SOUTH" ref="CA_COMM_000_02_Footer"/>
    </area-mapping>
</layout>
記述例 : ウィンドウのサイズおよび表示座標を遷移元画面と同じにする場合
<layout ref="BorderLayout">
    <gui size="inherit" location="inherit"/>
    <area-mapping>
        <area location="NORTH" ref="CA_COMM_000_01_Header"/>
        <area location="CENTER" ref="CA_WKFL_000_01_Login"/>
        <area location="SOUTH" ref="CA_COMM_000_02_Footer"/>
    </area-mapping>
</layout>
説明 :
layoutセクションは、Page内でのAreaの配置情報、Windowの制御情報を記述するセクションです。
ref属性でPageLayout定義のIDを指定すると、そのIDにひも尽く画面レイアウト制御機能が実行されます。

フレームワークでは汎用レイアウトを一つ用意しているので、単純なポップアップ画面などはそれを使用してWindowを構成できます。また、必要に応じてプロジェクト毎にPageLayout定義を作成することで、専用レイアウトを設計することができます。

汎用レイアウト及び、プロジェクト毎の専用レイアウトの定義例については別途リファレンスが用意されているのでそちらを参照してください。また、Pageに対応するウィンドウに関する細かい制御をguiタグで行うことが出来ます。
guiタグで制御できる内容は具体的には以下のものです。

ウィンドウサイズの指定(高さ、幅での指定や遷移元画面と同じにするなど)

ウィンドウ表示座標の指定(x座標,y座標の指定やOS任せなど)

ウィンドウのリサイズ可、不可の指定

ウィンドウタイトルの指定

各エリアの初期サイズ指定

なお、ウィンドウサイズ及びウィンドウ表示位置の制御内容はtransition-listセクションの画面遷移タグの側でも指定することが出来ます。
画面遷移タグ側の指定とこのセクションでの指定が異なる場合は、画面遷移タグ側の指定が常に優先されます。

属性値 :
layoutタグの属性値は以下の通り。

属性値名説明形式必須／非必須参照記法可／不可

ref PageLayout定義のIDを指定します。
このIDにひも尽くレイアウト制御機能がAreaを組み立てて画面を生成します。
汎用レイアウトについてはこちらを参照してください。
implmemnt属性と排他になります。文字列非必須不可

implement レイアウト制御機能の実装クラス指定。
標準で用意されていないカスタムのレイアウト制御機能を自分で実装して使用したい場合に指定します。
name属性と排他になります。文字列非必須不可

セクション内の子要素 :
layoutセクションの子要素として、以下の物があります。

guiタグ

画面のWindowに関する設定を行うタグです。
サイズ、表示座標、タイトル等を設定できます。

また、エリアをはめ込む位置毎に子タグ(locationタグ)で細かいパラメータを指定できます。

guiタグの属性値は以下の通り。

属性値名説明形式必須／非必須参照記法可／不可

size ウィンドウサイズの制御方法の区分を指定します。指定できるのは以下の２通りです。

dimension : 高さ及び幅を数値で直接指定する。省略時のデフォルトはこちら。

inherit : 遷移元画面のウィンドウサイズと同じにする。

dimension,
inherit 非必須不可

width size="dimension"の場合に指定する、ウィンドウの横幅の指定です。数値非必須不可

height size="dimension"の場合に指定する、ウィンドウの縦幅の指定です。数値非必須不可

resizable ウィンドウをリサイズ可能にするか指定します。省略時はfalseとして扱われます。 true,
false 非必須不可

title ウィンドウタイトルの指定です。文字列非必須可

location このページに遷移した際のモニタ内でのウィンドウ表示位置の制御方法の指定です。
指定できるのは以下の４通りです。

center : モニタの中央にウィンドウを表示します。

platform : OSに表示位置を任せます。

inherit : 遷移元画面と中心点を同じにして表示します。

point : 表示位置のx座標、y座標を数値で指定します。

center,
platform,
inherit,
point 非必須不可

pointX location="point"の場合に指定する、ウィンドウ左上隅のX座標の指定です。数値非必須不可

pointY location="point"の場合に指定する、ウィンドウ左上隅のY座標の指定です。数値非必須不可

background ウィンドウに配置するすべてのAreaに対するベースの背景色を指定できます。
Areaの画面パネルがopaque="false"になっていると、このベース背景色を透過表示させることができます。デザイン上での配色統一などを行う場合などに利用して下さい。基本的にcolor参照を使用して色を指定します。 color参照などでjava.awt.Colorを与える非必須可

locationタグ
guiタグの子タグとして、locationタグを指定できます。このタグは省略可能です。
このタグにより、エリアをはめ込む位置毎に最大サイズ、最小サイズ、推奨サイズなどの細かいパラメータを指定出来ます。

locationタグの属性値は以下の通り。

属性値名説明形式必須／非必須参照記法可／不可

ref 設定対象のlocation名を指定します。文字列必須不可

preferredSize 対象のlocationの推奨サイズを指定します。
カンマ区切りでwidthとheightの数値を指定します。

例 : preferredSize="500,100" 数値非必須不可

minSize 対象のlocationの最小サイズを指定します。
カンマ区切りでwidthとheightの数値を指定します。

例 : minSize="500,50" 数値非必須不可

maxSize 対象のlocationの最大サイズを指定します。
カンマ区切りでwidthとheightの数値を指定します。

例 : maxSize="500,400" 数値非必須不可

menubarタグ

Windowのメニューバーを構成するエリアを指定するためのタグです。
ref属性で、メニューバーの内容を定義するエリア定義のIDを指定します。
メニューバーを使用しない場合はこのタグは省略可能です。
guiタグの属性値は以下の通り。

属性値名説明形式必須／非必須参照記法可／不可

ref メニューバーエリアのIDを指定します。文字列必須不可

area-mappingセクション

Page内でのAreaの配置情報を記述するセクションです。

子タグとしてareaタグがあり、このタグにlayoutタグのname属性で指定された、レイアウト毎に指定できる領域名とそこにはめ込むAreaのIDを指定します。

areaタグの属性値は以下の通りです。

属性値名説明形式必須／非必須参照記法可／不可

location レイアウト毎に用意されている領域名を指定します。文字列必須不可

ref name属性で指定された領域にはめ込むAreaのIDを指定します。文字列必須不可

event-listener-listセクション

記述例 :

<event-listener-list>
    
    <PageEventListener event="windowClosing">
        
    <NotificationListener event="操作完了">
        <!-- 特定のエリアに対してイベントを転送する --/>
        <forwardEvent area="CA_XXXX_001" event="再検索"/>
    </NotificationListener>
</event-listener-list>
説明 :
ページ上で発生するイベントに対する処理を記述するセクションです。
例えば、タイトルバー右上のバツボタンなどでウィンドウの終了をユーザーが指定した場合などにどのような処理を行うかなどの指定ができます。

ここでは以下の２種類のリスナを定義できます。

PageEventListener : ウィンドウ関連のイベントを受信するリスナ

NotificationListener : フレームワークのNotificaiton機能により送信される通知を受信するリスナ

待機したいイベントの分だけListenerタグを複数個列挙し、それぞれの内部にスクリプト的に処理命令を記述できます。
ここで使用できる処理命令は、別途リファレンスが用意してありますのでそちらを参照してくさい。

セクション内の子要素 :
event-listener-listの子要素として、以下があります。

PageEventListenerタグ

ウィンドウ関連のイベントを受信した際の実行処理を定義するタグです。 PageEventListenerで受信できるイベント名は決まっています。現在は以下のイベントが指定できます。

イベント名イベントの発生契機

windowClosing ユーザーがウィンドウのタイトルバー右上のバツボタンによってウィンドウを閉じる操作をした時に発生する。
もしこのイベントのリスナーを記述した場合、明示的に画面を終了する処理を記述しない限りはウィンドウは閉じない。

このタグの内部に、簡易スクリプト的に処理命令、分岐命令等を記述して処理内容を定義します。
使用できる実行命令については、別途リファレンスが用意されていますので、詳細はそちらを参照してください。

このタグの属性値は以下の通り。

属性値名説明形式必須／非必須参照記法可／不可

event 待機するイベント名を指定します。
ある一つのイベントに対してはPage内で定義できるリスナーはひとつだけです。文字列必須不可

NotificationListenerタグ

ClientFrameworkのNotification機能によって送信される通知を受信した際の実行処理を定義するタグです。 NotificationListenerで受信できる通知名は、Notification定義によって定義されます。

このタグの内部に、簡易スクリプト的に処理命令、分岐命令等を記述して処理内容を定義します。
使用できる実行命令については、別途リファレンスが用意されていますので、詳細はそちらを参照してください。

このタグの属性値は以下の通り。

属性値名説明形式必須／非必須参照記法可／不可

event 待機する通知イベント名を指定します。
ある一つの通知イベントに対してはPage内で定義できるリスナーはひとつだけです。文字列必須不可

transition-listセクション

記述例 :
<transition-list>
    <transition id="ある画面をポップアップ">
        <transit-page next="CP_XXXX_001"/>
    </transition>
    <transition id="同ウィンドウ内で遷移">
        <popup-page next="CP_XXXX_002"/>
    </transition>
    <transition id="一部のエリアを切替">
        <change-are target="ポータル領域" next="CA_XXX_002"/>
    </transition>
</transition-list>
説明 : 画面遷移の情報を記述するセクションです。
画面遷移は、基本的にPage間のリンク情報としてここで定義されます。
どのような形で遷移するか、遷移先のPageはどこか等をtranstionタグのリストとして定義していきます。

また、遷移タグのパラメータで以下の指定を行うことが出来ます。

[遷移先のウィンドウ位置と座標の制御]
transit-pageタグとpopup-pageタグで遷移先画面のウィンドウに関する制御パラメータを指定することが出来ます。
ここで指定できるのは遷移先画面のウィンドウサイズおよびウィンドウ表示位置に関する制御内容です。
ここで指定したパラメータは、遷移先画面のPage定義におけるlayoutセクションでのguiタグによる指定に対するオーバーライドになります。 layoutセクション側の設定と画面遷移タグ側の指定が違う場合は、画面遷移タグ側のパラメータが常に優先されます。

特にtransit-pageタグによるウィザード的な画面遷移を行うような場合、画面遷移を行うたびにウィンドウがモニタ中央に移動しては使いづらくなるので、その場合は
    <transit-page next=""遷移先画面ID size="inherit" location="inherit"/>
と指定することでウィンドウの位置及び大きさをそのままにした状態で画面遷移を行うことが出来ます。

[遷移先への画面遷移パラメータの受け渡し]
transit-pageタグとpopup-pageタグのcontext属性及びsituation属性で、遷移先画面の実行コンテキストに任意の名称や状況名を与えることが出来ます。これは、遷移先の画面側での初期化処理の分岐条件、コンポーネントの有効／無効制御などで使用することが出来ます。

context属性は遷移先画面が行うべき処理を表すような名称を、situation属性は遷移元を表すような名称を指定してください。
例としては以下のようになります。
例)「見積承認」からの「更新」を行うような場合
    <popup-page next="CP_XXXX" context="更新" situation="見積承認"/>
参照記法のcontext参照を使用することでこの名称を参照できます。

セクション内の子要素
transition-listの子要素として、以下のものがあります。

transitionタグ

Pageから発生しうる、画面遷移を表すタグです。
transition-listの子要素として複数個列挙できますので、Pageから発生しうる画面遷移の数だけ定義してください。

なお、ref属性でTransition定義のIDを指定することで、Transition定義による条件判定つき画面遷移を利用することができます。この場合はPage定義側のtransitionタグには子タグを記述せず、Transition定義側に画面遷移処理を委譲する形になります。

transitionタグには以下の属性値があります。

属性値名説明形式必須／非必須参照記法可／不可

id 画面遷移を表すIDを指定します。
Page定義内でユニークになるように文字列で指定してください。
なお、このIDはArea定義から参照されます。主にCommand定義で指定されるdoTranstionタグから指定されます。文字列必須不可

ref 画面遷移の具体的な内容を委譲するTransition定義のIDを指定します。
Transition定義による条件判定付きの画面遷移を利用したい場合に記述してください。文字列非必須不可

画面遷移の種別に応じて、以下のタグのいずれかを子タグとして指定します。

transit-page
同じウィンドウ内でPageを切り替える画面遷移です。
属性値は以下の通り。

属性値名説明形式必須／非必須参照記法可／不可

next 遷移先画面のPageのIDを指定します。文字列必須不可

context 遷移先画面の実行コンテキストに名前を割り当てます。文字列非必須不可

situation 遷移元画面の状況を表す文字列を割り当てます。文字列非必須不可

location 遷移先画面のモニタ内でのウィンドウ表示位置の制御方法の指定です。
指定できるのは以下の４通りです。

center : モニタの中央にウィンドウを表示します。

platform : OSに表示位置を任せます。

inherit : 遷移元画面と中心点を同じにして表示します。

point : 表示位置のx座標、y座標を数値で指定します。

center,
platform,
inherit,
point 非必須不可

pointX location="point"の場合に指定する、遷移先画面のウィンドウ左上隅のX座標の指定です。数値非必須不可

pointY location="point"の場合に指定する、遷移先画面のウィンドウ左上隅のY座標の指定です。数値非必須不可

size 遷移先画面のウィンドウサイズの制御方法の区分を指定します。指定できるのは以下の２通りです。

dimension : 高さ及び幅を数値で直接指定する。

inherit : 遷移元画面のウィンドウサイズと同じにする。

dimension,
inherit 非必須不可

width size="dimension"の場合に指定する、遷移先画面のウィンドウの横幅の指定です。数値非必須不可

height size="dimension"の場合に指定する、遷移先画面のウィンドウの縦幅の指定です。数値非必須不可

popup-page
新しいウィンドウをポップアップさせる画面遷移です。
属性値は以下の通り。

属性値名説明形式必須／非必須参照記法可／不可

next ポップアップさせる画面のPageのIDを指定します。文字列必須不可

modal ポップアップ元画面をロックさせたい場合にはtrueを指定してください。
省略時はfalseとして処理させます。 true,
false 非必須不可

multiplicity ポップアップさせる画面のウィンドウインスタンスの多重度指定です。
以下を指定することが出来ます。

multiple : 複数枚のウィンドウのポップアップが出来ます。省略時のデフォルトはこちら。

single : １枚のみウィンドウのポップアップができます。すでにポップアップ済みの場合に再度この画面遷移が実行されようとすると、ポップアップ済みウィンドウが最前面に表示されます。

multiple,
single 非必須不可

context ポップアップさせる画面の実行コンテキストに名前を割り当てます。文字列非必須不可

situation 遷移元画面の状況を表す文字列を割り当てます。文字列非必須不可

location 遷移先画面のモニタ内でのウィンドウ表示位置の制御方法の指定です。
指定できるのは以下の４通りです。

center : モニタの中央にウィンドウを表示します。

platform : OSに表示位置を任せます。

inherit : 遷移元画面と中心点を同じにして表示します。

point : 表示位置のx座標、y座標を数値で指定します。

center,
platform,
inherit,
point 非必須不可

pointX location="point"の場合に指定する、遷移先画面のウィンドウ左上隅のX座標の指定です。数値非必須不可

pointY location="point"の場合に指定する、遷移先画面のウィンドウ左上隅のY座標の指定です。数値非必須不可

size 遷移先画面のウィンドウサイズの制御方法の区分を指定します。指定できるのは以下の２通りです。

dimension : 高さ及び幅を数値で直接指定する。

inherit : 遷移元画面のウィンドウサイズと同じにする。

dimension,
inherit 非必須不可

width size="dimension"の場合に指定する、遷移先画面のウィンドウの横幅の指定です。数値非必須不可

height size="dimension"の場合に指定する、遷移先画面のウィンドウの縦幅の指定です。数値非必須不可

change-area
Page内のある領域のエリア切替を行う画面遷移です。
属性値は以下の通り。

属性値名説明形式必須／非必須参照記法可／不可

location 切替を行う領域名を指定します。
このページのレイアウトが持つlocationを指定します。文字列必須不可

next 切替先のAreaのIDを指定します。文字列必須不可

add-area
Page内のある領域にエリア追加を行う画面遷移です。
属性値は以下の通り。

属性値名説明形式必須／非必須参照記法可／不可

location 追加を行う領域名を指定します。
このページのレイアウトが持つlocationを指定します。文字列必須不可

add 追加するAreaのIDを指定します。文字列必須不可

statusセクション

記述例 :
<status>
    <author>$Author: morishita $</author>
    <datetime>$Date:: 2012-02-19 15:55:15 #$</datetime>
    <version>$Revision: 6852 $</version>
</status>
説明 :
Page定義ファイルの編集情報を記述するセクションです。
バージョン管理システムの置換キーワードなどと連携して使用してください。

セクション内の子要素 : 以下の子要素があります。

authorタグ

タグの間にはさんで、ファイルの編集者を記述します。

datetimeタグ

タグの間にはさんで、ファイルの編集日時を記述します。

versionタグ

タグの間にはさんで、ファイルのバージョンを記述します。

Page定義全体のサンプル

<?xml version="1.0" encoding="Windows-31J"?>
<!--
 - Copyright
 -->
<!DOCTYPE client-page SYSTEM "../doctype/client-page.dtd">
<!--==============================================================
 == Current-Module:
 == Release-Date:
 == Release-Version:
 == First-Created-On:
 == First-Created-By:
 == Copy-Right-Owner:
 ==============================================================-->
<client-page>
<!--==============================================================
==  ページの識別情報
===============================================================-->
    <identity id="CP_WKFL_Login"
              name="一般申請ログイン"
              stereotype="ログイン"/>
<!--==============================================================
==  ページの詳細説明
===============================================================-->
    <description>
        一般申請アプリケーションのログイン画面となるページ定義
    </description>
<!--==============================================================
==  表示レイアウト
===============================================================-->
    <layout ref="BorderLayout">
        <gui width="1024" height="733"/>
        <area-mapping>
            <area location="NORTH" ref="CA_COMM_000_01_Header"/>
            <area location="CENTER" ref="CA_WKFL_000_01_Login"/>
            <area location="SOUTH" ref="CA_COMM_000_02_Footer"/>
        </area-mapping>
    </layout>
<!--==============================================================
==  イベントリスナ
===============================================================-->
    <event-listener-list>
        <!-- ログインエリアに終了イベントを転送する -->
        <pageEventListener event="windowClosing">
            <forwardEvent area="CA_WKFL_000_01_Login" event="終了"/>
        </pageEventListener>
    </event-listener-list>
<!--==============================================================
==  画面遷移情報
===============================================================-->
    <transition-list>
        <transition>
            <transit-page next="CP_XXXX_0002"/>
        </transition>
    </transition-list>
<!--==============================================================
==  ファイル編集情報
===============================================================-->
    <status>
        <author>$Author: morishita $</author>
        <datetime>$Date:: 2012-02-19 15:55:15 #$</datetime>
        <version>$Revision: 6852 $</version>
    </status>
</client-page>

更新情報

最終更新者 : $Author: morishita $

最終更新日時 : $Date:: 2012-02-19 15:55:15 #$

バージョン : $Revision: 6852 $