pexa.client.std.view.base

クラス AbstractArea

java.lang.Object

pexa.client.std.view.base.AbstractArea

すべての実装されたインタフェース:

java.util.EventListener, NotificationListener, ReferenceSource, Area, AreaContainer

直系の既知のサブクラス:

SimpleSwingArea

public abstract class AbstractArea
extends java.lang.Object
implements Area

Areaの抽象基底クラス。 本クラスを拡張してプラットフォーム毎の具象クラスを作成してください。

バージョン:

$Revision: 6613 $ $Date:: 2011-09-03 21:01:42 #$

作成者:

フィールドのサマリー

インタフェースから継承されたフィールド pexa.client.std.view.Area

AREA_COMPONENTS, AREA_DEFINITION, AREA_LAYOUT, CLIENT_CONTEXT, PAGE

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
AbstractArea()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	acceptComponentOperator(Expression exp) コンポーネント制御要求を受け付ける
void	addArea(java.lang.String location, java.lang.String areaID, ClientEvent e) 画面遷移としてのエリア追加を実行する。
void	addAreaContainerEventListener(AreaContainerEventListener acel) イベントリスナを登録する
void	addAreaEventListener(AreaEventListener ael) エリアイベントのリスナを追加する
protected void	addComponent(VirtualComponent comp) コンポーネントを登録する
void	changeArea(java.lang.String location, java.lang.String areaID, ClientEvent e) 画面遷移としてのエリア切替を実行する。
void	destroy() エリアインスタンスの終了処理を行う。
protected void	fireAreaAdded(Area target, java.util.EventObject cause) エリア追加イベントをリスナーに通知する。
protected void	fireAreaChanged(Area target, java.util.EventObject cause) エリア切り替えイベントをリスナーに通知する。
protected void	fireStateChanged(java.lang.String oldState, java.lang.String newState, ClientEvent cause) 状態変更イベントを発行する
Area	getArea(java.lang.String areaID) エリアにひも尽く、ネストしたエリアを取得する
AreaContainerDefinition	getAreaContainerDefinition() AreaContainerの定義情報を取得する
protected AreaContainerEventListener	getAreaContainerEventListener() エリアコンテナイベントリスナを取得する。
AreaContainerEventListener[]	getAreaContainerEventListeners() 登録されているイベントリスナを配列で取得する
AreaContainerLayout	getAreaContainerLayout() このコンテナに紐尽くレイアウトを取得する
protected AreaEventListener	getAreaEventListener() エリアイベントリスナを取得する。
AreaEventListener[]	getAreaEventListeners() リスナー配列を取得する
Area[]	getAreas() エリアにひも尽く、ネストしたエリアを配列で取得する
Area[]	getAreas(java.lang.String areaID) エリアにひも尽く、ネストしたエリアを配列で取得する
Area	getChild(java.lang.String areaID) 子に当たるエリアを取得する
Area[]	getChildren() 子に当たる全てのエリアを取得する
Area[]	getChildren(java.lang.String areaID) 子に当たるエリアを取得する
ClientContext	getClientContext() エリアが紐尽くClientSessionを取得する
protected ClientContextEventListener	getClientContextEventListener() コンテキストイベントリスナを取得する。
VirtualComponent	getComponent(java.lang.String componentID) エリアに紐尽くコンポーネントを取得する
protected ComponentEventListener	getComponentEventListener() コンポーネントイベントリスナを取得する。
protected ComponentOperatorFactory	getComponentOperatorFactory() ComponentOperatorFactoryを取得する
VirtualComponent[]	getComponents() エリアに紐尽く全てのコンポーネントを取得する
AreaContainer	getContainer() このAreaを格納しているコンテナのインスタンスを取得する。
Content	getContent(java.lang.String contentID) ひも尽くコンテントを取得する
protected ContentEventListener	getContentEventListener() コンテントイベントリスナを取得する デフォルト以外のリスナを使用したい場合はオーバライドしてください。
Content[]	getContents() ひも尽くコンテンツを取得する
protected Controller	getController() 自身にひも尽くコントローラのオブジェクトを取得する
protected ControllerEventListener	getControllerEventListener() コントローラーイベントリスナを取得する 別のリスナを使用したい場合は、派生クラスでオーバライドすること。
ClientEvent	getCurrentProcessingEvent() 現在処理中のイベントを取得する。
AreaDefinition	getDefinition() エリア定義を取得する
DialogPane	getDialogPane(java.lang.String dialogID) ダイアログを表示するためのアダプタを取得する。
java.lang.String	getInstanceID() 領域のインスタンスIDを取得する
AreaLayout	getLayout() エリアレイアウトを取得する。
java.lang.String	getNotificationListenerID() このリスナーを識別する一意キーを取得する
Page	getPage() このAreaContainerが紐尽くPageインスタンスを取得する
protected PageEventListener	getPageEventListener() ページイベントリスナを取得する。
Area	getParent() 親にあたるエリアを取得する
AreaContainer	getParentContainer() このAreaContainerの親コンテナを取得する。
java.lang.String	getPreference(java.lang.String key) エリアに関するユーザー設定値を取得する
Reference	getReference(java.lang.String ref) 参照オブジェクトを取得する コンテント内もしくはコンテントアクション内の処理で使用される
java.lang.String	getState() 現在の状態を取得する
protected ViewLayoutFactory	getViewLayoutFactory() ViewLayoutFactoryを取得する
protected VirtualComponentFactory	getVirtualComponentFactory() 仮想コンポーネントファクトリを取得する
boolean	hasEventPermission(java.lang.String event) イベントの実行が可能な状態か判定する
protected void	init(java.lang.String instanceID, AreaDefinition ad, ClientContext context) 初期化を行う。
void	installAccessControlPermission(ClientEvent e) Area上の各要素に対する権限制御パーミッションをインストールする
void	installArea(Area area) エリアを登録する すでに登録されているインスタンスは無視する
void	installContainer(AreaContainer container) エリアが所属するページを登録する。
void	installContent(Content c) ひも尽くコンテンツを登録する
void	installController(Controller c) コントローラを登録する
protected boolean	isControllerEnabled() コントローラーが有効な状態になっているかを判定する
boolean	isPage() このコンテナがPageかどうか判定する
protected boolean	isSavePreference() ユーザー設定の保存を行うべきかを判定する
void	notificationReceived(Notification n) Client内通知を受け取った際に呼び出される
void	notifyUpdate(ClientEvent e) Areaに表示更新を通知する
protected void	processComponentOperation(ClientEvent e) 一覧表示系コンポーネントの選択行変更を実行する。
void	processEvent(ClientEvent e) コントローラーにイベント処理を要求する
protected abstract void	processEventAfter(ClientEvent e) イベント処理要求の後処理を行う
protected abstract void	processEventBefore(ClientEvent e) イベント処理要求の前処理を行う。
protected abstract void	processEventError(ClientEvent e, java.lang.Throwable t) イベント処理要求で発生したエラーのハンドリングを行う
void	removeArea(Area area, ClientEvent e) 引数で指定されたAreaをこのコンテナから削除する
void	removeAreaContainerEventListener(AreaContainerEventListener acel) イベントリスナを削除する
void	removeAreaEventListener(AreaEventListener ael) エリアイベントのリスナを削除する
void	setPreference(java.lang.String key, java.lang.Object value) エリアに関するユーザー設定値を設定する
void	start(ClientEvent e) Areaの初期化を行う
void	update(ClientEvent e) Areaの表示を更新する
protected void	update(ClientEvent e, boolean force) Areaの更新処理を行う
protected void	updateComponents(ClientEvent e) 全コンポーネントの表示更新を行う
boolean	validateCommand(java.lang.String commandID, ClientEvent e) コマンドを実行し、エラー有無を判定する。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

AbstractArea

public AbstractArea()

メソッドの詳細

getAreaContainerDefinition

public AreaContainerDefinition getAreaContainerDefinition()

AreaContainerの定義情報を取得する

定義:

getAreaContainerDefinition インタフェース内 AreaContainer

戻り値:

AreaContainer定義情報

getParentContainer

public AreaContainer getParentContainer()

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

定義:

getParentContainer インタフェース内 AreaContainer

戻り値:

親のコンテナ

getPage

public Page getPage()

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

定義:

getPage インタフェース内 NotificationListener

定義:

getPage インタフェース内 Area

定義:

getPage インタフェース内 AreaContainer

戻り値:

Pageインスタンス

installArea

public void installArea(Area area)

エリアを登録する すでに登録されているインスタンスは無視する

定義:

installArea インタフェース内 AreaContainer

パラメータ:

areas - エリア配列

changeArea

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

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

定義:

changeArea インタフェース内 AreaContainer

パラメータ:

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

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

e - イベント情報

addArea

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

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

定義:

addArea インタフェース内 AreaContainer

パラメータ:

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

areaID - 追加するAreaのID

e - イベント情報

removeArea

public void removeArea(Area area,
                       ClientEvent e)

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

定義:

removeArea インタフェース内 AreaContainer

パラメータ:

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

e - イベント情報

isPage

public boolean isPage()

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

定義:

isPage インタフェース内 AreaContainer

戻り値:

Pageならtrue、ちがうならfalse

getAreaContainerLayout

public AreaContainerLayout getAreaContainerLayout()

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

定義:

getAreaContainerLayout インタフェース内 AreaContainer

戻り値:

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

notificationReceived

public void notificationReceived(Notification n)

Client内通知を受け取った際に呼び出される

定義:

notificationReceived インタフェース内 NotificationListener

パラメータ:

n - 通知イベントオブジェクト

getNotificationListenerID

public java.lang.String getNotificationListenerID()

このリスナーを識別する一意キーを取得する

定義:

getNotificationListenerID インタフェース内 NotificationListener

戻り値:

リスナー識別キー

getDefinition

public AreaDefinition getDefinition()

エリア定義を取得する

定義:

getDefinition インタフェース内 Area

戻り値:

自身のメタデータとなるエリア定義

getInstanceID

public java.lang.String getInstanceID()

領域のインスタンスIDを取得する

定義:

getInstanceID インタフェース内 Area

戻り値:

インスタンスID

getAreas

public Area[] getAreas()

エリアにひも尽く、ネストしたエリアを配列で取得する

定義:

getAreas インタフェース内 AreaContainer

戻り値:

ネストしてひも付いているエリアインスタンスの配列

getAreas

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

エリアにひも尽く、ネストしたエリアを配列で取得する

定義:

getAreas インタフェース内 AreaContainer

パラメータ:

areaID - エリアID

戻り値:

ネストしてひも付いているエリアインスタンスの配列

getArea

public Area getArea(java.lang.String areaID)

エリアにひも尽く、ネストしたエリアを取得する

定義:

getArea インタフェース内 AreaContainer

パラメータ:

areaID - エリアID

戻り値:

ネストしてひも付いているエリアインスタンス

installContainer

public void installContainer(AreaContainer container)

エリアが所属するページを登録する。 登録できるのは一度だけで、二度目以降はエラーとなる。

定義:

installContainer インタフェース内 Area

パラメータ:

container - エリアが所属するページ

例外:

java.lang.IllegalStateException - 設定を二度行った場合

getContainer

public AreaContainer getContainer()

このAreaを格納しているコンテナのインスタンスを取得する。

定義:

getContainer インタフェース内 Area

戻り値:

このAreaを格納しているコンテナ

getParent

public Area getParent()

親にあたるエリアを取得する

定義:

getParent インタフェース内 Area

戻り値:

親エリアインスタンス

getChildren

public Area[] getChildren()

子に当たる全てのエリアを取得する

定義:

getChildren インタフェース内 Area

戻り値:

子エリア

getChildren

public Area[] getChildren(java.lang.String areaID)

子に当たるエリアを取得する

定義:

getChildren インタフェース内 Area

パラメータ:

areaID - 取得したいAreaのID

戻り値:

子エリア

getChild

public Area getChild(java.lang.String areaID)

子に当たるエリアを取得する

定義:

getChild インタフェース内 Area

パラメータ:

areaID - 取得したいAreaのID

戻り値:

子エリア

getLayout

public AreaLayout getLayout()

エリアレイアウトを取得する。

定義:

getLayout インタフェース内 Area

戻り値:

エリアレイアウト

installController

public void installController(Controller c)

コントローラを登録する

定義:

installController インタフェース内 Area

パラメータ:

c - エリアに対応するコントローラ

installContent

public void installContent(Content c)

ひも尽くコンテンツを登録する

定義:

installContent インタフェース内 Area

パラメータ:

c - コンテンツインスタンス

installAccessControlPermission

public void installAccessControlPermission(ClientEvent e)
                                    throws RecoverableException

Area上の各要素に対する権限制御パーミッションをインストールする

定義:

installAccessControlPermission インタフェース内 Area

パラメータ:

e - イベント情報

例外:

RecoverableException - パーミッション設定に失敗

getContent

public Content getContent(java.lang.String contentID)

ひも尽くコンテントを取得する

定義:

getContent インタフェース内 Area

パラメータ:

contentID - コンテントID

戻り値:

コンテントインスタンス

getContents

public Content[] getContents()

ひも尽くコンテンツを取得する

定義:

getContents インタフェース内 Area

戻り値:

コンテンツインスタンスの配列

getClientContext

public ClientContext getClientContext()

エリアが紐尽くClientSessionを取得する

定義:

getClientContext インタフェース内 NotificationListener

定義:

getClientContext インタフェース内 AreaContainer

戻り値:

エリアが紐尽くClientSession

getComponent

public VirtualComponent getComponent(java.lang.String componentID)

エリアに紐尽くコンポーネントを取得する

定義:

getComponent インタフェース内 Area

パラメータ:

componentID - 取得したいコンポーネントのID

戻り値:

コンポーネント

getComponents

public VirtualComponent[] getComponents()

エリアに紐尽く全てのコンポーネントを取得する

定義:

getComponents インタフェース内 Area

戻り値:

コンポーネント配列

addAreaEventListener

public void addAreaEventListener(AreaEventListener ael)

エリアイベントのリスナを追加する

定義:

addAreaEventListener インタフェース内 Area

パラメータ:

ael - エリアイベントリスナ

getAreaEventListeners

public AreaEventListener[] getAreaEventListeners()

リスナー配列を取得する

定義:

getAreaEventListeners インタフェース内 Area

戻り値:

リスナーリストのコピー配列

removeAreaEventListener

public void removeAreaEventListener(AreaEventListener ael)

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

定義:

removeAreaEventListener インタフェース内 Area

パラメータ:

ael - エリアイベントリスナ

addAreaContainerEventListener

public void addAreaContainerEventListener(AreaContainerEventListener acel)

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

定義:

addAreaContainerEventListener インタフェース内 AreaContainer

パラメータ:

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

getAreaContainerEventListeners

public AreaContainerEventListener[] getAreaContainerEventListeners()

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

定義:

getAreaContainerEventListeners インタフェース内 AreaContainer

戻り値:

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

removeAreaContainerEventListener

public void removeAreaContainerEventListener(AreaContainerEventListener acel)

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

定義:

removeAreaContainerEventListener インタフェース内 AreaContainer

パラメータ:

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

start

public void start(ClientEvent e)
           throws RecoverableException

Areaの初期化を行う

定義:

start インタフェース内 Area

パラメータ:

e - イベント情報

例外:

RecoverableException - 回復可能な業務例外

update

public void update(ClientEvent e)
            throws RecoverableException

Areaの表示を更新する

定義:

update インタフェース内 Area

パラメータ:

e - イベント情報

例外:

RecoverableException - 回復可能な業務例外

notifyUpdate

public void notifyUpdate(ClientEvent e)
                  throws RecoverableException

Areaに表示更新を通知する

パラメータ:

e - イベント情報

例外:

RecoverableException - 回復可能な業務例外

destroy

public void destroy()

エリアインスタンスの終了処理を行う。

定義:

destroy インタフェース内 Area

getReference

public Reference getReference(java.lang.String ref)

参照オブジェクトを取得する コンテント内もしくはコンテントアクション内の処理で使用される

定義:

getReference インタフェース内 ReferenceSource

パラメータ:

ref - 参照先をしめす文字列

戻り値:

参照オブジェクト

getState

public java.lang.String getState()

現在の状態を取得する

定義:

getState インタフェース内 Area

パラメータ:

現状態 -

hasEventPermission

public boolean hasEventPermission(java.lang.String event)

イベントの実行が可能な状態か判定する

定義:

hasEventPermission インタフェース内 Area

パラメータ:

event - 実行可能であるかを判定したいイベント名

戻り値:

実行可能ならtrue、実行不可能ならfalse

processEvent

public void processEvent(ClientEvent e)

コントローラーにイベント処理を要求する

定義:

processEvent インタフェース内 Area

パラメータ:

e - 実行イベント情報

getCurrentProcessingEvent

public ClientEvent getCurrentProcessingEvent()

現在処理中のイベントを取得する。

定義:

getCurrentProcessingEvent インタフェース内 Area

戻り値:

現在処理中のイベント。

acceptComponentOperator

public void acceptComponentOperator(Expression exp)

コンポーネント制御要求を受け付ける

定義:

acceptComponentOperator インタフェース内 Area

パラメータ:

exp - 制御命令

getDialogPane

public DialogPane getDialogPane(java.lang.String dialogID)

ダイアログを表示するためのアダプタを取得する。

定義:

getDialogPane インタフェース内 Area

パラメータ:

dialogID - 取得したいダイアログのID

戻り値:

ダイアログ表示アダプタオブジェクト

getPreference

public java.lang.String getPreference(java.lang.String key)

エリアに関するユーザー設定値を取得する

定義:

getPreference インタフェース内 Area

パラメータ:

key - 設定値キー

戻り値:

設定値文字列

setPreference

public void setPreference(java.lang.String key,
                          java.lang.Object value)

エリアに関するユーザー設定値を設定する

定義:

setPreference インタフェース内 Area

パラメータ:

key - 設定値キー

value - 設定値

validateCommand

public boolean validateCommand(java.lang.String commandID,
                               ClientEvent e)

コマンドを実行し、エラー有無を判定する。

定義:

validateCommand インタフェース内 Area

パラメータ:

commandID - 実行コマンドのID

e - 実行イベント情報

戻り値:

エラーなしで実行されればtrue,エラーが発生していればfalse

isSavePreference

protected boolean isSavePreference()

ユーザー設定の保存を行うべきかを判定する

戻り値:

保存するならtrue、しないならfalse

update

protected void update(ClientEvent e,
                      boolean force)
               throws RecoverableException

Areaの更新処理を行う

パラメータ:

e - イベント情報

force - trueなら強制更新、falseなら状態に応じて更新する

例外:

RecoverableException

updateComponents

protected void updateComponents(ClientEvent e)
                         throws RecoverableException

全コンポーネントの表示更新を行う

パラメータ:

e - イベント情報

例外:

表示更新でエラー発生

RecoverableException

init

protected void init(java.lang.String instanceID,
                    AreaDefinition ad,
                    ClientContext context)

初期化を行う。 実装クラスのコンストラクタでコールすること。

パラメータ:

instanceID - インスタンスID

ad - エリア定義

context - 実行コンテキスト

getController

protected Controller getController()

自身にひも尽くコントローラのオブジェクトを取得する

戻り値:

コントローラ

processEventBefore

protected abstract void processEventBefore(ClientEvent e)
                                    throws RecoverableException

イベント処理要求の前処理を行う。

パラメータ:

e - 実行イベント情報

例外:

RecoverableException

processEventAfter

protected abstract void processEventAfter(ClientEvent e)
                                   throws RecoverableException

イベント処理要求の後処理を行う

パラメータ:

e - 実行イベント情報

例外:

RecoverableException

processEventError

protected abstract void processEventError(ClientEvent e,
                                          java.lang.Throwable t)

イベント処理要求で発生したエラーのハンドリングを行う

パラメータ:

e - 実行イベント情報

t - エラー情報

processComponentOperation

protected void processComponentOperation(ClientEvent e)
                                  throws RecoverableException

一覧表示系コンポーネントの選択行変更を実行する。

パラメータ:

e - 実行イベント情報

例外:

RecoverableException

isControllerEnabled

protected boolean isControllerEnabled()

コントローラーが有効な状態になっているかを判定する

戻り値:

コントローラーが有効ならtrue、無効ならfalse

getComponentEventListener

protected ComponentEventListener getComponentEventListener()

コンポーネントイベントリスナを取得する。 デフォルト以外のリスナを使用したい場合はオーバライドしてください。

戻り値:

標準のコンポーネントイベントリスナ

getAreaContainerEventListener

protected AreaContainerEventListener getAreaContainerEventListener()

エリアコンテナイベントリスナを取得する。 デフォルト以外のリスナを使用したい場合はオーバライドしてください。

戻り値:

標準のエリアコンテナイベントリスナ

getPageEventListener

protected PageEventListener getPageEventListener()

ページイベントリスナを取得する。 デフォルト以外のリスナを使用したい場合はオーバライドしてください。

戻り値:

標準のページイベントリスナ

getContentEventListener

protected ContentEventListener getContentEventListener()

コンテントイベントリスナを取得する デフォルト以外のリスナを使用したい場合はオーバライドしてください。

戻り値:

標準のコンテントイベントリスナ

getAreaEventListener

protected AreaEventListener getAreaEventListener()

エリアイベントリスナを取得する。 別のリスナを使用したい場合は、派生クラスでオーバライドすること。

戻り値:

エリアイベントリスナ

getClientContextEventListener

protected ClientContextEventListener getClientContextEventListener()

コンテキストイベントリスナを取得する。 別のリスナを使用したい場合は、派生クラスでオーバライドすること。

戻り値:

エリアイベントリスナ

getControllerEventListener

protected ControllerEventListener getControllerEventListener()

コントローラーイベントリスナを取得する 別のリスナを使用したい場合は、派生クラスでオーバライドすること。

戻り値:

コントローラーイベントリスナ

addComponent

protected void addComponent(VirtualComponent comp)

コンポーネントを登録する

パラメータ:

comps - コンポーネント配列

fireAreaChanged

protected void fireAreaChanged(Area target,
                               java.util.EventObject cause)

エリア切り替えイベントをリスナーに通知する。

パラメータ:

target - 切替後のAreaインスタンス

cause - 原因となったイベント情報

fireAreaAdded

protected void fireAreaAdded(Area target,
                             java.util.EventObject cause)

エリア追加イベントをリスナーに通知する。

パラメータ:

target - 追加されたエリアインスタンス

cause - 原因となったイベント情報

fireStateChanged

protected void fireStateChanged(java.lang.String oldState,
                                java.lang.String newState,
                                ClientEvent cause)

状態変更イベントを発行する

パラメータ:

oldState - 遷移前状態

newState - 遷移後状態

cause - 状態変更の原因となったイベント

getVirtualComponentFactory

protected VirtualComponentFactory getVirtualComponentFactory()

仮想コンポーネントファクトリを取得する

戻り値:

仮想コンポーネントファクトリ

getViewLayoutFactory

protected ViewLayoutFactory getViewLayoutFactory()

ViewLayoutFactoryを取得する

戻り値:

Viewレイアウトファクトリ

getComponentOperatorFactory

protected ComponentOperatorFactory getComponentOperatorFactory()

ComponentOperatorFactoryを取得する

戻り値:

オペレータファクトリ