pexa.client.std.view

インタフェース AreaContainer

既知のサブインタフェースのリスト:

Area, Page, SwingArea, SwingPage

既知の実装クラスのリスト:

AbstractArea, AbstractPage, SimpleSwingArea, SimpleSwingPage

public interface AreaContainer

Areaを内部に格納することが出来るコンテナを表すインタフェース。 コンテナへのエリアインスタンス登録および、画面遷移としてのエリア切替、追加、削除をサポートする。

バージョン:

$Revision: 2596 $ $Date:: 2008-10-30 20:16:22 #$

作成者:

morishita

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addArea(java.lang.String location, java.lang.String areaID, ClientEvent e) 画面遷移としてのエリア追加を実行する。
void	addAreaContainerEventListener(AreaContainerEventListener acel) イベントリスナを登録する
void	changeArea(java.lang.String location, java.lang.String areaID, ClientEvent e) 画面遷移としてのエリア切替を実行する。
Area	getArea(java.lang.String areaID) IDで指定されたコンテナに含まれる領域オブジェクトを取得する。
AreaContainerDefinition	getAreaContainerDefinition() AreaContainerの定義情報を取得する
AreaContainerEventListener[]	getAreaContainerEventListeners() 登録されているイベントリスナを配列で取得する
AreaContainerLayout	getAreaContainerLayout() このコンテナに紐尽くレイアウトを取得する
Area[]	getAreas() コンテナに含まれるすべての領域オブジェクトを取得する
Area[]	getAreas(java.lang.String areaID) IDで指定されたコンテナに含まれる領域オブジェクトを取得する。
ClientContext	getClientContext() このコンテナが紐尽くClientContextを取得する。
Page	getPage() このAreaContainerが紐尽くPageインスタンスを取得する
AreaContainer	getParentContainer() このAreaContainerの親コンテナを取得する。
void	installArea(Area area) Areaインスタンスをコンテナに登録する。
boolean	isPage() このコンテナがPageかどうか判定する
void	removeArea(Area area, ClientEvent e) 引数で指定されたAreaをこのコンテナから削除する
void	removeAreaContainerEventListener(AreaContainerEventListener acel) イベントリスナを削除する

メソッドの詳細

getAreaContainerDefinition

AreaContainerDefinition getAreaContainerDefinition()

AreaContainerの定義情報を取得する

戻り値:

AreaContainer定義情報

getClientContext

ClientContext getClientContext()

このコンテナが紐尽くClientContextを取得する。

戻り値:

紐尽くClientContext

getParentContainer

AreaContainer getParentContainer()

このAreaContainerの親コンテナを取得する。

戻り値:

親のコンテナ

getPage

Page getPage()

このAreaContainerが紐尽くPageインスタンスを取得する

戻り値:

Pageインスタンス

getAreas

Area[] getAreas()

コンテナに含まれるすべての領域オブジェクトを取得する

戻り値:

領域オブジェクトの配列

getAreas

Area[] getAreas(java.lang.String areaID)

IDで指定されたコンテナに含まれる領域オブジェクトを取得する。

パラメータ:

areaID - エリアID

戻り値:

領域オブジェクトの配列

getArea

Area getArea(java.lang.String areaID)

IDで指定されたコンテナに含まれる領域オブジェクトを取得する。 同じIDを持つAreaインスタンスが複数存在した場合は、 最初に見つかったAreaインスタンスが返される。

パラメータ:

areaID - エリアID

戻り値:

領域オブジェクト

installArea

void installArea(Area area)

Areaインスタンスをコンテナに登録する。 複数回呼び出せるが、同じインスタンスに対しては無視する。

パラメータ:

area - 格納対象のAreaインスタンス。

changeArea

void changeArea(java.lang.String location,
                java.lang.String areaID,
                ClientEvent e)

画面遷移としてのエリア切替を実行する。

パラメータ:

location - 切替対象の領域名を指定する。

areaID - 切替後に有効にするAreaのID

e - イベント情報

addArea

void addArea(java.lang.String location,
             java.lang.String areaID,
             ClientEvent e)

画面遷移としてのエリア追加を実行する。

パラメータ:

location - 追加対象の領域名を指定する。

areaID - 追加するAreaのID

e - イベント情報

removeArea

void removeArea(Area area,
                ClientEvent e)

引数で指定されたAreaをこのコンテナから削除する

パラメータ:

area - 削除対象のAreaインスタンス。

e - イベント情報

isPage

boolean isPage()

このコンテナがPageかどうか判定する

戻り値:

Pageならtrue、ちがうならfalse

getAreaContainerLayout

AreaContainerLayout getAreaContainerLayout()

このコンテナに紐尽くレイアウトを取得する

戻り値:

このコンテナに紐尽くレイアウトインスタンス

addAreaContainerEventListener

void addAreaContainerEventListener(AreaContainerEventListener acel)

イベントリスナを登録する

パラメータ:

acel - 登録するエリアコンテナイベントのリスナ

getAreaContainerEventListeners

AreaContainerEventListener[] getAreaContainerEventListeners()

登録されているイベントリスナを配列で取得する

戻り値:

登録されているイベントリスナの配列

removeAreaContainerEventListener

void removeAreaContainerEventListener(AreaContainerEventListener acel)

イベントリスナを削除する

パラメータ:

acel - 削除するエリアコンテナイベントのリスナ