AbstractPage (PEXA API Document)

java.lang.Object
- pexa.client.std.view.base.AbstractPage

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

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

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

SimpleSwingPage
```
public abstract class AbstractPage
extends java.lang.Object
implements Page
```
ページの抽象実装クラス。本クラスを拡張してプラットフォーム毎の具象クラスを作成してください。

バージョン:

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

作成者:

フィールドのサマリー
- インタフェースから継承されたフィールド pexa.client.std.view.Page
  CLIENT_CONTEXT, PAGE_DEFINITION, PAGE_EVENT_LISTENER_INTERPRETER, PAGE_LAYOUT

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

コンストラクタ
コンストラクタと説明

AbstractPage()

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addArea(java.lang.String location, java.lang.String areaID, ClientEvent e)` 画面遷移としてのエリア追加を実行する。
`void`	`addAreaContainerEventListener(AreaContainerEventListener acel)` イベントリスナを登録する
`void`	`addPageEventListener(PageEventListener pel)` ページイベントのリスナーオブジェクトを登録する
`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`	`firePageClosed(java.util.EventObject cause)` ページ終了をリスナーに通知する。
`void`	`firePagePopped(java.util.EventObject cause)` ポップアップイベントをリスナーに通知する。
`protected void`	`firePageTransitted(java.util.EventObject cause)` ページ遷移イベントをリスナーに通知する。
`Area`	`getArea(java.lang.String areaID)` IDで指定された画面に含まれる領域オブジェクトを取得する
`AreaContainerDefinition`	`getAreaContainerDefinition()` AreaContainerの定義情報を取得する
`AreaContainerEventListener[]`	`getAreaContainerEventListeners()` 登録されているイベントリスナを配列で取得する
`AreaContainerLayout`	`getAreaContainerLayout()` このコンテナに紐尽くレイアウトを取得する
`protected AreaEventListener`	`getAreaEventListener()` エリアイベントリスナを取得する。
`Area[]`	`getAreas()` 画面に含まれるすべての領域オブジェクトを取得する
`Area[]`	`getAreas(java.lang.String areaID)` IDで指定された画面に含まれる領域オブジェクトを取得する。
`Page[]`	`getChildren()` 画面遷移上で子にあたる全てのPageを取得する
`Page[]`	`getChildren(Area area)` 引数で指定されたArea上からポップアップした全てのPageを取得する
`ClientContext`	`getClientContext()` ページが紐尽くClientSessionを取得する
`PageDefinition`	`getDefinition()` インスタンスのメタデータとなる定義体オブジェクトを取得する
`java.lang.String`	`getInstanceID()` インスタンスに割り振られたユニークなIDを取得する
`Interpreter`	`getInterpreter()` PageEventListenerインタプリタを取得する
`protected InterpreterFactory`	`getInterpreterFactory()` PageListenerInterpreterFactoryを取得する
`PageLayout`	`getLayout()` ページレイアウトを取得する
`java.lang.String`	`getNotificationListenerID()` このリスナーを識別する一意キーを取得する
`Page`	`getPage()` このAreaContainerが紐尽くPageインスタンスを取得する
`PageEventListener[]`	`getPageEventListeners()` イベントリスナー配列を取得する
`Page`	`getParent()` 画面遷移上で親にあたるPageを取得する
`AreaContainer`	`getParentContainer()` このAreaContainerの親コンテナを取得する。
`java.lang.String`	`getPreference(java.lang.String key)` ページに関するユーザー設定値を取得する
`Reference`	`getReference(java.lang.String ref)` 参照オブジェクトを取得するページ、レイアウトの処理で使用される
`protected ViewLayoutFactory`	`getViewLayoutFactory()` ViewLayoutFactoryを取得する
`protected void`	`init(java.lang.String instanceID, PageDefinition pd, ClientContext context)` 初期化メソッド。
`void`	`installArea(Area area)` エリアを登録する既に登録されているインスタンスに対しては無視する
`boolean`	`isModal()` Pageがmodal状態であるか返す
`boolean`	`isPage()` このコンテナがPageかどうか判定する
`protected boolean`	`isSavePreference()` ユーザー設定の保存を行うべきかを判定する
`void`	`notificationReceived(Notification n)` Client内通知を受け取った際に呼び出される
`void`	`removeArea(Area area, ClientEvent e)` 引数で指定されたAreaをこのコンテナから削除する
`void`	`removeAreaContainerEventListener(AreaContainerEventListener acel)` イベントリスナを削除する
`void`	`removeEventListener(PageEventListener pel)` ページイベントのリスナーオブジェクトを削除する
`protected void`	`setModal(boolean modal)` モーダルフラグを設定する
`void`	`setPreference(java.lang.String key, java.lang.Object value)` ページに関するユーザー設定値を設定する

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド pexa.client.std.view.Page
popUp, toFront, transit, update

- コンストラクタの詳細
  - AbstractPage
```
public AbstractPage()
```
- メソッドの詳細
  - getAreaContainerDefinition
```
public AreaContainerDefinition getAreaContainerDefinition()
```
    AreaContainerの定義情報を取得する
    
    定義:
    
    getAreaContainerDefinition インタフェース内 AreaContainer
    
    戻り値:
    
    AreaContainer定義情報
  - getParentContainer
```
public AreaContainer getParentContainer()
```
    このAreaContainerの親コンテナを取得する。
    
    定義:
    
    getParentContainer インタフェース内 AreaContainer
    
    戻り値:
    
    親のコンテナ
  - getPage
```
public Page getPage()
```
    このAreaContainerが紐尽くPageインスタンスを取得する
    
    定義:
    
    getPage インタフェース内 NotificationListener
    
    定義:
    
    getPage インタフェース内 AreaContainer
    
    戻り値:
    
    Pageインスタンス
  - installArea
```
public void installArea(Area area)
```
    エリアを登録する既に登録されているインスタンスに対しては無視する
    
    定義:
    
    installArea インタフェース内 AreaContainer
    
    パラメータ:
    
    area - 登録エリアインスタンス
  - 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 PageDefinition getDefinition()
```
    インスタンスのメタデータとなる定義体オブジェクトを取得する
    
    定義:
    
    getDefinition インタフェース内 Page
    
    戻り値:
    
    ページ定義
  - getInstanceID
```
public java.lang.String getInstanceID()
```
    インスタンスに割り振られたユニークなIDを取得する
    
    定義:
    
    getInstanceID インタフェース内 Page
    
    戻り値:
    
    ClientContext内におけるユニークなインスタンスID
  - getAreas
```
public Area[] getAreas()
```
    画面に含まれるすべての領域オブジェクトを取得する
    
    定義:
    
    getAreas インタフェース内 AreaContainer
    
    戻り値:
    
    領域オブジェクトの配列
  - getAreas
```
public Area[] getAreas(java.lang.String areaID)
```
    IDで指定された画面に含まれる領域オブジェクトを取得する。
    
    定義:
    
    getAreas インタフェース内 AreaContainer
    
    パラメータ:
    
    areaID - エリアID
    
    戻り値:
    
    領域オブジェクトの配列
  - getArea
```
public Area getArea(java.lang.String areaID)
```
    IDで指定された画面に含まれる領域オブジェクトを取得する
    
    定義:
    
    getArea インタフェース内 AreaContainer
    
    パラメータ:
    
    areaID - エリアID
    
    戻り値:
    
    領域オブジェクト
  - getLayout
```
public PageLayout getLayout()
```
    ページレイアウトを取得する
    
    定義:
    
    getLayout インタフェース内 Page
    
    戻り値:
    
    ページレイアウトインスタンス
  - getClientContext
```
public ClientContext getClientContext()
```
    ページが紐尽くClientSessionを取得する
    
    定義:
    
    getClientContext インタフェース内 NotificationListener
    
    定義:
    
    getClientContext インタフェース内 AreaContainer
    
    戻り値:
    
    エリアが紐尽くClientSession
  - addPageEventListener
```
public void addPageEventListener(PageEventListener pel)
```
    ページイベントのリスナーオブジェクトを登録する
    
    定義:
    
    addPageEventListener インタフェース内 Page
    
    パラメータ:
    
    pel - ページイベントリスナー
  - getPageEventListeners
```
public PageEventListener[] getPageEventListeners()
```
    イベントリスナー配列を取得する
    
    定義:
    
    getPageEventListeners インタフェース内 Page
    
    戻り値:
    
    リスナーリストのコピー配列
  - removeEventListener
```
public void removeEventListener(PageEventListener pel)
```
    ページイベントのリスナーオブジェクトを削除する
    
    定義:
    
    removeEventListener インタフェース内 Page
    
    パラメータ:
    
    pel - ページイベントリスナー
  - addAreaContainerEventListener
```
public void addAreaContainerEventListener(AreaContainerEventListener acel)
```
    イベントリスナを登録する
    
    定義:
    
    addAreaContainerEventListener インタフェース内 AreaContainer
    
    パラメータ:
    
    acel - 登録するエリアコンテナイベントのリスナ
  - getAreaContainerEventListeners
```
public AreaContainerEventListener[] getAreaContainerEventListeners()
```
    登録されているイベントリスナを配列で取得する
    
    定義:
    
    getAreaContainerEventListeners インタフェース内 AreaContainer
    
    戻り値:
    
    登録されているイベントリスナの配列
  - removeAreaContainerEventListener
```
public void removeAreaContainerEventListener(AreaContainerEventListener acel)
```
    イベントリスナを削除する
    
    定義:
    
    removeAreaContainerEventListener インタフェース内 AreaContainer
    
    パラメータ:
    
    acel - 削除するエリアコンテナイベントのリスナ
  - destroy
```
public void destroy()
```
    終了処理を行う
    
    定義:
    
    destroy インタフェース内 Page
  - getReference
```
public Reference getReference(java.lang.String ref)
```
    参照オブジェクトを取得するページ、レイアウトの処理で使用される
    
    定義:
    
    getReference インタフェース内 ReferenceSource
    
    パラメータ:
    
    ref - 参照先をしめす文字列
    
    戻り値:
    
    参照オブジェクト
  - isModal
```
public boolean isModal()
```
    Pageがmodal状態であるか返す
    
    定義:
    
    isModal インタフェース内 Page
    
    戻り値:
    
    modalならtrue、非modalならfalse
  - getParent
```
public Page getParent()
```
    画面遷移上で親にあたるPageを取得する
    
    定義:
    
    getParent インタフェース内 Page
    
    戻り値:
    
    画面遷移上での親Page。なければnull。
  - getChildren
```
public Page[] getChildren()
```
    画面遷移上で子にあたる全てのPageを取得する
    
    定義:
    
    getChildren インタフェース内 Page
    
    戻り値:
    
    画面遷移上での子Page配列。なければサイズ0の配列になる。
  - getChildren
```
public Page[] getChildren(Area area)
```
    引数で指定されたArea上からポップアップした全てのPageを取得する
    
    定義:
    
    getChildren インタフェース内 Page
    
    パラメータ:
    
    area - ポップアップ元のAreaインスタンス
    
    戻り値:
    
    画面遷移上での子Page配列。なければサイズ0の配列になる。
  - getInterpreter
```
public Interpreter getInterpreter()
```
    PageEventListenerインタプリタを取得する
    
    定義:
    
    getInterpreter インタフェース内 Page
    
    戻り値:
    
    インタプリタ
  - firePagePopped
```
public void firePagePopped(java.util.EventObject cause)
```
    ポップアップイベントをリスナーに通知する。
    
    定義:
    
    firePagePopped インタフェース内 Page
    
    パラメータ:
    
    cause - 原因となったイベント情報
  - getPreference
```
public java.lang.String getPreference(java.lang.String key)
```
    ページに関するユーザー設定値を取得する
    
    定義:
    
    getPreference インタフェース内 Page
    
    パラメータ:
    
    key - 設定値キー
    
    戻り値:
    
    設定値文字列
  - setPreference
```
public void setPreference(java.lang.String key,
                          java.lang.Object value)
```
    ページに関するユーザー設定値を設定する
    
    定義:
    
    setPreference インタフェース内 Page
    
    パラメータ:
    
    key - 設定値キー
    
    value - 設定値
  - isSavePreference
```
protected boolean isSavePreference()
```
    ユーザー設定の保存を行うべきかを判定する
    
    戻り値:
    
    保存するならtrue、しないならfalse
  - init
```
protected void init(java.lang.String instanceID,
                    PageDefinition pd,
                    ClientContext context)
```
    初期化メソッド。具象クラスのコンストラクタでコールしてください。
    
    パラメータ:
    
    instanceID - ユニークなインスタンスID
    
    pd - ページ定義
    
    context - 実行コンテキスト
  - getAreaEventListener
```
protected AreaEventListener getAreaEventListener()
```
    エリアイベントリスナを取得する。別のリスナを使用したい場合は、派生クラスでオーバライドすること。
    
    戻り値:
    
    エリアイベントリスナ
  - firePageTransitted
```
protected void firePageTransitted(java.util.EventObject cause)
```
    ページ遷移イベントをリスナーに通知する。
    
    パラメータ:
    
    cause - 原因となったイベント情報
  - fireAreaChanged
```
protected void fireAreaChanged(Area target,
                               java.util.EventObject cause)
```
    エリア切り替えイベントをリスナーに通知する。
    
    パラメータ:
    
    target - TODO
    
    cause - 原因となったイベント情報
  - fireAreaAdded
```
protected void fireAreaAdded(Area target,
                             java.util.EventObject cause)
```
    エリア切り替えイベントをリスナーに通知する。
    
    パラメータ:
    
    target - TODO
    
    cause - 原因となったイベント情報
  - firePageClosed
```
protected void firePageClosed(java.util.EventObject cause)
```
    ページ終了をリスナーに通知する。
    
    パラメータ:
    
    cause - 原因となったイベント情報
  - setModal
```
protected void setModal(boolean modal)
```
    モーダルフラグを設定する
    
    パラメータ:
    
    modal - modalならtrue、非modalならfalse
  - getViewLayoutFactory
```
protected ViewLayoutFactory getViewLayoutFactory()
```
    ViewLayoutFactoryを取得する
    
    戻り値:
    
    Viewレイアウトファクトリ
  - getInterpreterFactory
```
protected InterpreterFactory getInterpreterFactory()
```
    PageListenerInterpreterFactoryを取得する
    
    戻り値:
    
    インタプリタファクトリ

クラス AbstractPage

フィールドのサマリー

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

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

メソッドのサマリー

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

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

コンストラクタの詳細

AbstractPage

メソッドの詳細

getAreaContainerDefinition

getParentContainer

getPage

installArea

changeArea

addArea

removeArea

isPage

getAreaContainerLayout

notificationReceived

getNotificationListenerID

getDefinition

getInstanceID

getAreas

getAreas

getArea

getLayout

getClientContext

addPageEventListener

getPageEventListeners

removeEventListener

addAreaContainerEventListener

getAreaContainerEventListeners

removeAreaContainerEventListener

destroy

getReference

isModal

getParent

getChildren

getChildren

getInterpreter

firePagePopped

getPreference

setPreference

isSavePreference

init

getAreaEventListener

firePageTransitted

fireAreaChanged

fireAreaAdded

firePageClosed

setModal

getViewLayoutFactory

getInterpreterFactory