PEXA Clientについて

チュートリアル

定義パターン

定義ファイル

リファレンス

目次

  1. はじめに
  2. AreaLayout定義の内容
  3. identityセクション
  4. descriptionセクション
  5. location-listセクション
  6. statusセクション
  7. AreaLayout定義全体のサンプル


はじめに

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

AreaLayout定義ファイルは、Areaに対して適用されるエリアレイアウトの「仕様」を定義するメタ情報ファイルです。
この定義ファイルには、AreaLayoutの実装クラス名、レイアウトが持つlocationについての情報が含まれます。

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

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


AreaLayout定義の内容

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

AreaLayoutの識別情報

AreaLayoutはシステム内でユニークに特定できる必要があります。
そのために、AreaLayoutを識別するためのIDや名称を必ず定義する必要があります。

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


レイアウト内のlocationの情報

AreaLayoutが持つlocationについての情報です。
locationとは、そのAreaLayoutがエリア内にサブエリアを配置する「位置」を表します。

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



identityセクション

記述例 :

<!--==============================================================
==  識別情報
===============================================================-->
<identity id="BorderLayout"
          name="ボーダーレイアウトによるエリアレイアウト"
          implement="pexa.client.std.view.swing.layout.BorderAreaLayout"/>

説明 :
identityセクションは、AreaLayoutの識別情報を記述するセクションです。
レイアウトの識別名、名称、実装クラス名を指定します。

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

属性値名 説明 形式 必須/非必須 参照記法可/不可
id システム内でユニークになるAreaLayoutの識別ID 文字列 必須 不可
name AreaLayoutの詳細名称 文字列 必須 不可
implement AreaLayoutの実装クラス名 文字列 必須 不可


descriptionセクション

記述例 :

<description>
    java.awt.BorderLayoutをベースに子エリアの配置を行うエリアレイアウトです。
</description>

説明 :
descriptionセクションは、AreaLayoutの詳細説明を記述するセクションです。
フリーフォーマットで文章で記入してください。


location-listセクション

記述例 :

<!--==============================================================
==  ロケーションメタ情報
==============================================================-->
<location-list>
    <location name="NORTH" context="combine" required="false">
        <operation add="disable" remove="enable" change="enable"/>
    </location>
    <location name="SOUTH" context="combine" required="false">
        <operation add="disable" remove="enable" change="enable"/>
    </location>
    <location name="EAST" context="combine" required="false">
        <operation add="disable" remove="enable" change="enable"/>
    </location>
    <location name="WEST" context="combine" required="false">
        <operation add="disable" remove="enable" change="enable"/>
    </location>
    <location name="CENTER" context="combine" required="false">
        <operation add="disable" remove="enable" change="enable"/>
    </location>
</location-list>

説明 :
AreaLayoutがサブエリアを配置する「位置」についての情報を定義するセクションです。
location-listの子タグとしてlocationタグを複数個記述できます。
ここで宣言されたlocationが、そのAreaLayoutを使用した際にサブエリアを配置できる位置であるということになります。 AreaLayoutでは、locationの解釈は実装クラスによって異なります。

例:BorderLayoutの場合
NORTH, SOUTH, EAST, WESTと言ったように、パネル上の東西南北中央に配置場所が用意されます。

例:タブエリアの場合
AreaLayout定義では、locationは「タブ領域」というものが一つだけ用意されます。
その代わり、Area定義側でlocationに対する配置を記述する場合はlocation="タブ領域[過去情報]"といった形で 大括弧をつけてサブ名称を付けることでタブ一枚一枚を表現します。

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

locationタグ

AreaLayoutがサブ要素を配置できる「位置」を表すタグです。 locationタグの属性値は以下の通り。

属性値名 説明 形式 必須/非必須 参照記法可/不可
name locationを表す名称を指定します。
AreaLayout内でユニークになる必要があります。
ここで宣言したlocation名を、Area定義のlayoutセクションで指定することになります。
文字列 必須 不可
context このlocationに配置されたサブエリアの実行コンテキストを、親エリアと同一(combine)にするか独立(separate)させるかの指定です。
このパラメータは親エリアおよびサブエリアが参照するContent項目の共有スコープに影響を与えます。
combine,
separate
必須 不可
required このlocationへのサブエリア配置の必須指定です。
trueの場合にこのlocationに対してサブエリアの配置がなければ実行時にエラーとなります。
true,
false
必須 不可

locationのオプション設定となるタグとして、以下の物があります。


operationタグ

記述例 : エリア追加は不可、エリア削除とエリア切替が可能。
<location name="CENTER" context="combine" required="false">
    <operation add="disable" remove="enable" change="enable"/>
</location>
エリアに対する画面遷移制御に関する設定情報です。
エリアに対して実行できる画面遷移は
  • エリア追加:locationに対してサブエリアを追加配置する
  • エリア削除:locationに配置されているサブエリアを消去する
  • エリア切替:locationに配置されているサブエリアを別のエリアに置き換える
の3種類があり、location毎にそれぞれをAreaLayoutがサポートするかどうかの指定をここで行います。

以下の属性値があります。

属性値名 説明 形式 必須/非必須 参照記法可/不可
add エリア追加が行えるかの指定です。
基本的にこれが出来るのはタブを使用したエリアレイアウトの場合のみです。
true,
false
必須 不可
remove エリア削除が行えるかの指定です。
この操作はほとんどの場合において行うことができます。
true,
false
必須 不可
change エリア切替が行えるかの指定です。 基本的にタブを使用したエリアレイアウトでは行えません。 true,
false
必須 不可


statusセクション

記述例 :

<status>
    <author>$Author: morishita $</author>
    <datetime>$Date:: 2008-08-29 22:48:31 #$</datetime>
    <version>$Revision: 2282 $</version>
</status>

説明 :
AreaLayout定義ファイルの編集情報を記述するセクションです。
バージョン管理システムの置換キーワードなどと連携して使用してください。

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

authorタグ

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


datetimeタグ

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


versionタグ

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



AreaLayout定義全体のサンプル

<?xml version="1.0" encoding="Windows-31j"?>
<!--
 - Copyright
 -->
<!DOCTYPE client-arealayout SYSTEM "../doctype/client-arealayout.dtd">
<!--==============================================================
 == Current-Module:   $HeadURL$
 == Release-Date:     $Date:: 2008-08-29 22:48:31 #$
 == Release-Version:  $Revision: 2282 $
 == First-Created-On: 2007/03/05
 == First-Created-By:
 == Copy-Right-Owner:
 ==============================================================-->
<client-arealayout>
<!--==============================================================
==  識別情報
===============================================================-->
    <identity id="BorderLayout"
              name="ボーダーレイアウトによるエリアレイアウト"
              implement="pexa.client.std.view.swing.layout.BorderAreaLayout"/>
<!--==============================================================
==  詳細説明
===============================================================-->
    <description>
        ボーダーレイアウトによって構成されるエリア用のレイアウト定義情報です
    </description>
<!--==============================================================
==  ロケーションメタ情報
==============================================================-->
    <location-list>
        <location name="NORTH" context="combine" required="false">
            <operation add="disable" remove="enable" change="enable"/>
        </location>
        <location name="SOUTH" context="combine" required="false">
            <operation add="disable" remove="enable" change="enable"/>
        </location>
        <location name="EAST" context="combine" required="false">
            <operation add="disable" remove="enable" change="enable"/>
        </location>
        <location name="WEST" context="combine" required="false">
            <operation add="disable" remove="enable" change="enable"/>
        </location>
        <location name="CENTER" context="combine" required="false">
            <operation add="disable" remove="enable" change="enable"/>
        </location>
    </location-list>
<!--==============================================================
==  ファイル編集情報
==============================================================-->
    <status>
        <author>$Author: morishita $</author>
        <datetime>$Date:: 2008-08-29 22:48:31 #$</datetime>
        <version>$Revision: 2282 $</version>
    </status>
</client-arealayout>


更新情報

  • 最終更新者 : $Author: morishita $
  • 最終更新日時 : $Date:: 2008-08-29 22:48:31 #$
  • バージョン : $Revision: 2282 $



Copyright © 2006, Atrris Corporation