pexa.client.std.view

インタフェース Page

すべてのスーパーインタフェース:

AreaContainer, java.util.EventListener, NotificationListener, ReferenceSource

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

SwingPage

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

AbstractPage, SimpleSwingPage

public interface Page
extends AreaContainer, NotificationListener, ReferenceSource

AreaViewを統合して成り立つ”画面”を表すインタフェース

バージョン:

$Revision: 5034 $ $Date:: 2010-05-14 13:39:54 #$

作成者:

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static java.lang.String	CLIENT_CONTEXT ページの初期化パラメータのキー
static java.lang.String	PAGE_DEFINITION ページの初期化パラメータのキー
static java.lang.String	PAGE_EVENT_LISTENER_INTERPRETER ページイベントリスナインタプリタ
static java.lang.String	PAGE_LAYOUT ページの初期化パラメータのキー

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addPageEventListener(PageEventListener pel) ページイベントのリスナーオブジェクトを登録する
void	destroy() ページインスタンスの終了処理を行う
void	firePagePopped(java.util.EventObject cause) ポップアップイベントをリスナーに通知する。
Page[]	getChildren() 画面遷移上で子にあたる全てのPageを取得する
Page[]	getChildren(Area area) 引数で指定されたArea上からポップアップした全てのPageを取得する
PageDefinition	getDefinition() インスタンスのメタデータとなる定義体オブジェクトを取得する
java.lang.String	getInstanceID() インスタンスに割り振られたユニークなIDを取得する
Interpreter	getInterpreter() PageEventListenerインタプリタを取得する
PageLayout	getLayout() ページ内の画面レイアウトの制御オブジェクトを取得する。
PageEventListener[]	getPageEventListeners() イベントリスナー配列を取得する
Page	getParent() 画面遷移上で親にあたるPageを取得する
java.lang.String	getPreference(java.lang.String key) ページに関するユーザー設定値を取得する
boolean	isModal() Pageがmodal状態であるか返す
void	popUp(PageLocation location, boolean modal, boolean fireEvent, ClientEvent e) 画面をポップアップさせる
void	removeEventListener(PageEventListener pel) ページイベントのリスナーオブジェクトを削除する
void	setPreference(java.lang.String key, java.lang.Object value) ページに関するユーザー設定値を設定する
void	toFront(ClientEvent e) 画面を最前面に出す。
void	transit(PageLocation location, Page fromPage, ClientEvent e) ページ遷移を実行する
void	update(ClientEvent e) 画面を更新する

インタフェースから継承されたメソッド pexa.client.std.view.AreaContainer

addArea, addAreaContainerEventListener, changeArea, getArea, getAreaContainerDefinition, getAreaContainerEventListeners, getAreaContainerLayout, getAreas, getAreas, getClientContext, getPage, getParentContainer, installArea, isPage, removeArea, removeAreaContainerEventListener

インタフェースから継承されたメソッド pexa.client.std.notification.NotificationListener

getClientContext, getNotificationListenerID, getPage, notificationReceived

インタフェースから継承されたメソッド pexa.client.std.platform.reference.ReferenceSource

getReference

フィールドの詳細

PAGE_DEFINITION

static final java.lang.String PAGE_DEFINITION

ページの初期化パラメータのキー

関連項目:

定数フィールド値

PAGE_LAYOUT

static final java.lang.String PAGE_LAYOUT

ページの初期化パラメータのキー

関連項目:

定数フィールド値

CLIENT_CONTEXT

static final java.lang.String CLIENT_CONTEXT

ページの初期化パラメータのキー

関連項目:

定数フィールド値

PAGE_EVENT_LISTENER_INTERPRETER

static final java.lang.String PAGE_EVENT_LISTENER_INTERPRETER

ページイベントリスナインタプリタ

関連項目:

定数フィールド値

メソッドの詳細

getDefinition

PageDefinition getDefinition()

インスタンスのメタデータとなる定義体オブジェクトを取得する

戻り値:

ページ定義

getInstanceID

java.lang.String getInstanceID()

インスタンスに割り振られたユニークなIDを取得する

戻り値:

ClientContext内におけるユニークなインスタンスID

getLayout

PageLayout getLayout()

ページ内の画面レイアウトの制御オブジェクトを取得する。

戻り値:

レイアウト制御オブジェクト

transit

void transit(PageLocation location,
             Page fromPage,
             ClientEvent e)

ページ遷移を実行する

パラメータ:

location - 画面遷移後のページ配置位置情報

fromPage - 遷移元ページ

e - イベント情報

popUp

void popUp(PageLocation location,
           boolean modal,
           boolean fireEvent,
           ClientEvent e)

画面をポップアップさせる

パラメータ:

location - 画面遷移後のページ配置位置情報

modal - trueならモーダル、falseならモーダレス

fireEvent - trueならイベントを発行し、falseならしない

e - イベント情報

toFront

void toFront(ClientEvent e)

画面を最前面に出す。

パラメータ:

e - イベント情報

firePagePopped

void firePagePopped(java.util.EventObject cause)

ポップアップイベントをリスナーに通知する。

パラメータ:

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

update

void update(ClientEvent e)
     throws RecoverableException

画面を更新する

パラメータ:

e - イベント情報

例外:

RecoverableException - 回復可能な業務例外

addPageEventListener

void addPageEventListener(PageEventListener pel)

ページイベントのリスナーオブジェクトを登録する

パラメータ:

pel - ページイベントリスナー

getPageEventListeners

PageEventListener[] getPageEventListeners()

イベントリスナー配列を取得する

戻り値:

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

removeEventListener

void removeEventListener(PageEventListener pel)

ページイベントのリスナーオブジェクトを削除する

パラメータ:

pel - ページイベントリスナー

destroy

void destroy()

ページインスタンスの終了処理を行う

isModal

boolean isModal()

Pageがmodal状態であるか返す

戻り値:

modalならtrue、非modalならfalse

getParent

Page getParent()

画面遷移上で親にあたるPageを取得する

戻り値:

画面遷移上での親Page。なければnull。

getChildren

Page[] getChildren()

画面遷移上で子にあたる全てのPageを取得する

戻り値:

画面遷移上での子Page配列。なければサイズ0の配列になる。

getChildren

Page[] getChildren(Area area)

引数で指定されたArea上からポップアップした全てのPageを取得する

パラメータ:

area - ポップアップ元のAreaインスタンス

戻り値:

画面遷移上での子Page配列。なければサイズ0の配列になる。

getInterpreter

Interpreter getInterpreter()

PageEventListenerインタプリタを取得する

戻り値:

インタプリタ

getPreference

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

ページに関するユーザー設定値を取得する

パラメータ:

key - 設定値キー

戻り値:

設定値文字列

setPreference

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

ページに関するユーザー設定値を設定する

パラメータ:

key - 設定値キー

value - 設定値