Area (PEXA API Document)

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

AreaContainer, java.util.EventListener, NotificationListener, ReferenceSource

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

SwingArea

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

AbstractArea, SimpleSwingArea
```
public interface Area
extends AreaContainer, NotificationListener, ReferenceSource
```
画面を構成する”領域”を表すインタフェース

バージョン:

$Revision: 5450 $ $Date:: 2010-10-07 18:48:40 #$

作成者:

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static java.lang.String`	`AREA_COMPONENTS` 初期化パラメータのキー
`static java.lang.String`	`AREA_DEFINITION` 初期化パラメータのキー
`static java.lang.String`	`AREA_LAYOUT` 初期化パラメータのキー
`static java.lang.String`	`CLIENT_CONTEXT` 初期化パラメータのキー
`static java.lang.String`	`PAGE` 初期化パラメータのキー

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド
修飾子とタイプ	メソッドと説明
`void`	`acceptComponentOperator(Expression exp)` コンポーネント制御要求を受け付ける
`void`	`addAreaEventListener(AreaEventListener ael)` エリアイベントのリスナを追加する
`void`	`destroy()` 終了処理を行う
`AreaEventListener[]`	`getAreaEventListeners()` リスナー配列を取得する
`Area`	`getChild(java.lang.String areaID)` 子に当たるエリアを取得する
`Area[]`	`getChildren()` 子に当たる全てのエリアを取得する
`Area[]`	`getChildren(java.lang.String areaID)` 子に当たるエリアを取得する
`VirtualComponent`	`getComponent(java.lang.String componentID)` エリアに紐尽くコンポーネントを取得する
`VirtualComponent[]`	`getComponents()` エリアに紐尽く全てのコンポーネントを取得する
`AreaContainer`	`getContainer()` このAreaを格納しているコンテナのインスタンスを取得する。
`Content`	`getContent(java.lang.String contentID)` ひも尽くコンテントを取得する
`Content[]`	`getContents()` ひも尽くコンテントを取得する
`ClientEvent`	`getCurrentProcessingEvent()` 現在処理中のイベントを取得する。
`AreaDefinition`	`getDefinition()` エリア定義を取得する
`DialogPane`	`getDialogPane(java.lang.String dialogID)` ダイアログを表示するためのアダプタを取得する。
`java.lang.String`	`getInstanceID()` 領域のインスタンスIDを取得する
`AreaLayout`	`getLayout()` エリア内の画面レイアウトの制御オブジェクトを取得する。
`Page`	`getPage()` 自身がひも尽く画面オブジェクトを取得する
`Area`	`getParent()` 親に当たるエリアを取得する
`java.lang.String`	`getPreference(java.lang.String key)` エリアに関するユーザー設定値を取得する
`java.lang.String`	`getState()` 現在の状態を取得する
`boolean`	`hasEventPermission(java.lang.String event)` イベントの実行が可能な状態か判定する
`void`	`installAccessControlPermission(ClientEvent e)` Area上の各要素に対する権限制御パーミッションをインストールする
`void`	`installContainer(AreaContainer container)` エリアが所属するページを登録する。
`void`	`installContent(Content c)` ひも尽くコンテントを登録する
`void`	`installController(Controller c)` 対応するコントローラを登録する登録は一度しかできない。
`void`	`processEvent(ClientEvent e)` コントローラーにイベント処理を要求する
`void`	`removeAreaEventListener(AreaEventListener ael)` エリアイベントのリスナを削除する
`void`	`setPreference(java.lang.String key, java.lang.Object value)` エリアに関するユーザー設定値を設定する
`void`	`start(ClientEvent e)` Areaの実行を開始する。
`void`	`update(ClientEvent e)` Areaの表示を更新する
`boolean`	`validateCommand(java.lang.String commandID, ClientEvent e)` コマンドを実行し、エラー有無を判定する。

インタフェースから継承されたメソッド pexa.client.std.view.AreaContainer
addArea, addAreaContainerEventListener, changeArea, getArea, getAreaContainerDefinition, getAreaContainerEventListeners, getAreaContainerLayout, getAreas, getAreas, getClientContext, getParentContainer, installArea, isPage, removeArea, removeAreaContainerEventListener

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

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

- フィールドの詳細
  - AREA_DEFINITION
```
static final java.lang.String AREA_DEFINITION
```
    初期化パラメータのキー
    
    関連項目:
    
    定数フィールド値
  - AREA_COMPONENTS
```
static final java.lang.String AREA_COMPONENTS
```
    初期化パラメータのキー
    
    関連項目:
    
    定数フィールド値
  - AREA_LAYOUT
```
static final java.lang.String AREA_LAYOUT
```
    初期化パラメータのキー
    
    関連項目:
    
    定数フィールド値
  - PAGE
```
static final java.lang.String PAGE
```
    初期化パラメータのキー
    
    関連項目:
    
    定数フィールド値
  - CLIENT_CONTEXT
```
static final java.lang.String CLIENT_CONTEXT
```
    初期化パラメータのキー
    
    関連項目:
    
    定数フィールド値
- メソッドの詳細
  - getDefinition
```
AreaDefinition getDefinition()
```
    エリア定義を取得する
    
    戻り値:
    
    エリア定義
  - getInstanceID
```
java.lang.String getInstanceID()
```
    領域のインスタンスIDを取得する
    
    戻り値:
    
    インスタンスID
  - installContainer
```
void installContainer(AreaContainer container)
```
    エリアが所属するページを登録する。登録できるのは一度だけで、二度目以降はエラーとなる。
    
    パラメータ:
    
    container - エリアが所属するページ
    
    例外:
    
    java.lang.IllegalStateException - 設定を二度行った場合
  - getContainer
```
AreaContainer getContainer()
```
    このAreaを格納しているコンテナのインスタンスを取得する。
    
    戻り値:
    
    このAreaを格納しているコンテナ
  - getPage
```
Page getPage()
```
    自身がひも尽く画面オブジェクトを取得する
    
    定義:
    
    getPage インタフェース内 AreaContainer
    
    定義:
    
    getPage インタフェース内 NotificationListener
    
    戻り値:
    
    画面オブジェクト
  - getLayout
```
AreaLayout getLayout()
```
    エリア内の画面レイアウトの制御オブジェクトを取得する。
    
    戻り値:
    
    レイアウト制御オブジェクト
  - installController
```
void installController(Controller c)
```
    対応するコントローラを登録する登録は一度しかできない。
    
    パラメータ:
    
    c - コントローラ
  - installContent
```
void installContent(Content c)
```
    ひも尽くコンテントを登録する
    
    パラメータ:
    
    c - コンテントインスタンス
  - installAccessControlPermission
```
void installAccessControlPermission(ClientEvent e)
                             throws RecoverableException
```
    Area上の各要素に対する権限制御パーミッションをインストールする
    
    パラメータ:
    
    e - イベント情報
    
    例外:
    
    RecoverableException - パーミッション設定に失敗
  - getContent
```
Content getContent(java.lang.String contentID)
```
    ひも尽くコンテントを取得する
    
    パラメータ:
    
    contentID - コンテントID
    
    戻り値:
    
    コンテントインスタンス
  - getContents
```
Content[] getContents()
```
    ひも尽くコンテントを取得する
    
    戻り値:
    
    コンテントインスタンスの配列
  - getComponent
```
VirtualComponent getComponent(java.lang.String componentID)
```
    エリアに紐尽くコンポーネントを取得する
    
    パラメータ:
    
    componentID - 取得したいコンポーネントのID
    
    戻り値:
    
    コンポーネント
  - getComponents
```
VirtualComponent[] getComponents()
```
    エリアに紐尽く全てのコンポーネントを取得する
    
    戻り値:
    
    コンポーネント配列
  - addAreaEventListener
```
void addAreaEventListener(AreaEventListener ael)
```
    エリアイベントのリスナを追加する
    
    パラメータ:
    
    ael - エリアイベントリスナ
  - getAreaEventListeners
```
AreaEventListener[] getAreaEventListeners()
```
    リスナー配列を取得する
    
    戻り値:
    
    リスナーリストのコピー配列
  - removeAreaEventListener
```
void removeAreaEventListener(AreaEventListener ael)
```
    エリアイベントのリスナを削除する
    
    パラメータ:
    
    ael - エリアイベントリスナ
  - start
```
void start(ClientEvent e)
    throws RecoverableException
```
    Areaの実行を開始する。
    
    パラメータ:
    
    e - イベント情報
    
    例外:
    
    RecoverableException - 回復可能な業務例外
  - update
```
void update(ClientEvent e)
     throws RecoverableException
```
    Areaの表示を更新する
    
    パラメータ:
    
    e - イベント情報
    
    例外:
    
    RecoverableException - 回復可能な業務例外
  - destroy
```
void destroy()
```
    終了処理を行う
  - getState
```
java.lang.String getState()
```
    現在の状態を取得する
    
    パラメータ:
    
    現状態 -
  - hasEventPermission
```
boolean hasEventPermission(java.lang.String event)
```
    イベントの実行が可能な状態か判定する
    
    パラメータ:
    
    event - 実行可能であるかを判定したいイベント名
    
    戻り値:
    
    実行可能ならtrue、実行不可能ならfalse
  - processEvent
```
void processEvent(ClientEvent e)
```
    コントローラーにイベント処理を要求する
    
    パラメータ:
    
    e - 実行イベント情報
  - getParent
```
Area getParent()
```
    親に当たるエリアを取得する
    
    戻り値:
    
    親エリア
  - getChildren
```
Area[] getChildren()
```
    子に当たる全てのエリアを取得する
    
    戻り値:
    
    子エリア
  - getChildren
```
Area[] getChildren(java.lang.String areaID)
```
    子に当たるエリアを取得する
    
    パラメータ:
    
    areaID - 取得したいAreaのID
    
    戻り値:
    
    子エリア
  - getChild
```
Area getChild(java.lang.String areaID)
```
    子に当たるエリアを取得する
    
    パラメータ:
    
    areaID - 取得したいAreaのID
    
    戻り値:
    
    子エリア
  - getCurrentProcessingEvent
```
ClientEvent getCurrentProcessingEvent()
```
    現在処理中のイベントを取得する。
    
    戻り値:
    
    現在処理中のイベント。
  - acceptComponentOperator
```
void acceptComponentOperator(Expression exp)
```
    コンポーネント制御要求を受け付ける
    
    パラメータ:
    
    exp - 制御命令
  - getDialogPane
```
DialogPane getDialogPane(java.lang.String dialogID)
```
    ダイアログを表示するためのアダプタを取得する。
    
    パラメータ:
    
    dialogID - 取得したいダイアログのID
    
    戻り値:
    
    ダイアログ表示アダプタオブジェクト
  - getPreference
```
java.lang.String getPreference(java.lang.String key)
```
    エリアに関するユーザー設定値を取得する
    
    パラメータ:
    
    key - 設定値キー
    
    戻り値:
    
    設定値文字列
  - setPreference
```
void setPreference(java.lang.String key,
                   java.lang.Object value)
```
    エリアに関するユーザー設定値を設定する
    
    パラメータ:
    
    key - 設定値キー
    
    value - 設定値
  - validateCommand
```
boolean validateCommand(java.lang.String commandID,
                        ClientEvent e)
```
    コマンドを実行し、エラー有無を判定する。
    
    パラメータ:
    
    commandID - 実行コマンドのID
    
    e - 実行イベント情報
    
    戻り値:
    
    エラーなしで実行されればtrue,エラーが発生していればfalse

インタフェース Area

フィールドのサマリー

メソッドのサマリー

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

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

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

フィールドの詳細

AREA_DEFINITION

AREA_COMPONENTS

AREA_LAYOUT

PAGE

CLIENT_CONTEXT

メソッドの詳細

getDefinition

getInstanceID

installContainer

getContainer

getPage

getLayout

installController

installContent

installAccessControlPermission

getContent

getContents

getComponent

getComponents

addAreaEventListener

getAreaEventListeners

removeAreaEventListener

start

update

destroy

getState

hasEventPermission

processEvent

getParent

getChildren

getChildren

getChild

getCurrentProcessingEvent

acceptComponentOperator

getDialogPane

getPreference

setPreference

validateCommand