AbstractVirtualComponent (PEXA API Document)

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

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

ReferenceSource, VirtualComponent

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

AbstractSwingVirtualComponent
```
public abstract class AbstractVirtualComponent
extends java.lang.Object
implements VirtualComponent
```
仮想コンポーネントの抽象基底クラス。本クラスを拡張してプラットフォーム毎の具象クラスを作成してください。

バージョン:

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

作成者:

フィールドのサマリー
- インタフェースから継承されたフィールド pexa.client.std.view.VirtualComponent
  COMPONENT_DEFINITION

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

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

AbstractVirtualComponent()

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected void`	`addAvailableState(java.lang.String state)` コンポーネントが有効となる状態を登録する
`void`	`addComponentEventListener(ComponentEventListener cel)` コンポーネントイベントリスナを追加する。
`protected void`	`addProcessEvent(java.lang.String event)` コンポーネントから送信するイベントを登録する
`void`	`destroy()` 終了処理を行う。
`void`	`fireDisplayUpdated(java.util.EventObject cause)` コンポーネント上で全体表示のリフレッシュが要求されたことをリスナに通知する
`void`	`fireEventTriggered(java.lang.String event, java.util.EventObject cause)` コンポーネント上で任意のイベント発行が行われたことをリスナに通知する。
`void`	`fireInputFixed(java.util.EventObject cause)` コンポーネント上で入力確定が行われたことをリスナに通知する。
`Area`	`getArea()` コンポーネントが所属するエリアを取得する。
`protected abstract AreaEventListener`	`getAreaEventListener()` エリアに登録するイベントリスナを取得する。
`ClientContext`	`getClientContext()` コンポーネントがひも尽く実行セッションを取得する
`ComponentEventListener[]`	`getComponentEventListeners()` リスナー配列を取得する
`ComponentDefinition`	`getDefinition()` コンポーネント定義情報を取得する。
`java.lang.String`	`getInstanceID()` インスタンスに割り当てられたユニークなIDを取得する
`java.lang.String`	`getPreference(java.lang.String key)` コンポーネントに関するユーザー設定値を取得する
`Reference`	`getReference(java.lang.String ref)` 参照オブジェクトを取得する
`Translator`	`getTranslator(java.lang.String name)` トランスレータを取得する
`protected void`	`init(java.lang.String instanceID, java.util.Map params)` 初期化メソッド。
`void`	`installAccessControlPermission(ClientEvent e)` コンポーネントの権限制御パーミッションをインストールする
`void`	`installArea(Area a)` コンポーネントが所属するエリアを登録する。
`protected boolean`	`isAvailableState()` コンポーネントが状態遷移表上で有効になっているか判定する。
`protected boolean`	`isEnabled()` コンポーネントが有効状態であるかを判定する
`protected boolean`	`isEnabledCondition()` コンポーネントが有効状態の条件に合っているか判定する
`protected boolean`	`isSavePreference()` ユーザー設定の保存を行うべきかを判定する
`protected boolean`	`isStarted()` 初期化が完了しているかを判定する
`protected boolean`	`isVisible()` コンポーネントが可視状態かを判定する
`protected boolean`	`isVisibleCondition()` コンポーネントが可視状態の条件に合っているか判定する
`void`	`removeComponentEventListener(ComponentEventListener cel)` コンポーネントイベントのリスナオブジェクトを削除する。
`protected void`	`setEnabled(boolean enabled)` コンポーネントの有効、無効を設定する
`protected abstract void`	`setEnabledLocal(boolean enabled)` 実装に応じた、setEnabled後の処理を実装してください。
`void`	`setPreference(java.lang.String key, java.lang.Object value)` コンポーネントに関するユーザー設定値を設定する
`protected void`	`setStarted()` 初期化済状態にする
`protected void`	`setVisible(boolean visible)` コンポーネントの表示、非表示を設定する
`protected abstract void`	`setVisibleLocal(boolean visible)` 実装に応じた、setVisible後の処理を実装してください。
`java.lang.String`	`toString()` 文字列表現を返す

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

インタフェースから継承されたメソッド pexa.client.std.view.VirtualComponent
getRealComponent, input, start, update

- コンストラクタの詳細
  - AbstractVirtualComponent
```
public AbstractVirtualComponent()
```
- メソッドの詳細
  - getInstanceID
```
public java.lang.String getInstanceID()
```
    インスタンスに割り当てられたユニークなIDを取得する
    
    定義:
    
    getInstanceID インタフェース内 VirtualComponent
    
    戻り値:
    
    インスタンスID
  - getDefinition
```
public ComponentDefinition getDefinition()
```
    コンポーネント定義情報を取得する。
    
    定義:
    
    getDefinition インタフェース内 VirtualComponent
    
    戻り値:
    
    コンポーネント定義情報
  - addComponentEventListener
```
public void addComponentEventListener(ComponentEventListener cel)
```
    コンポーネントイベントリスナを追加する。
    
    定義:
    
    addComponentEventListener インタフェース内 VirtualComponent
    
    パラメータ:
    
    cel - コンポーネントイベントリスナ
  - getComponentEventListeners
```
public ComponentEventListener[] getComponentEventListeners()
```
    リスナー配列を取得する
    
    定義:
    
    getComponentEventListeners インタフェース内 VirtualComponent
    
    戻り値:
    
    リスナーリストのコピー配列
  - removeComponentEventListener
```
public void removeComponentEventListener(ComponentEventListener cel)
```
    コンポーネントイベントのリスナオブジェクトを削除する。
    
    定義:
    
    removeComponentEventListener インタフェース内 VirtualComponent
    
    パラメータ:
    
    cel - コンポーネントイベントリスナ
  - installArea
```
public void installArea(Area a)
```
    コンポーネントが所属するエリアを登録する。登録は一度だけ行うことができる。二度目以降の登録が行われた場合はエラー
    
    定義:
    
    installArea インタフェース内 VirtualComponent
    
    パラメータ:
    
    a - 所属するエリア
    
    例外:
    
    java.lang.IllegalStateException - 二度目以降の登録が行われた場合
  - installAccessControlPermission
```
public void installAccessControlPermission(ClientEvent e)
                                    throws RecoverableException
```
    コンポーネントの権限制御パーミッションをインストールする
    
    定義:
    
    installAccessControlPermission インタフェース内 VirtualComponent
    
    パラメータ:
    
    e - イベント情報
    
    例外:
    
    RecoverableException - パーミッション設定に失敗
  - getArea
```
public Area getArea()
```
    コンポーネントが所属するエリアを取得する。
    
    定義:
    
    getArea インタフェース内 VirtualComponent
    
    戻り値:
    
    area 所属するエリア
  - getClientContext
```
public ClientContext getClientContext()
```
    コンポーネントがひも尽く実行セッションを取得する
    
    定義:
    
    getClientContext インタフェース内 VirtualComponent
    
    戻り値:
    
    実行セッション
  - fireInputFixed
```
public void fireInputFixed(java.util.EventObject cause)
```
    コンポーネント上で入力確定が行われたことをリスナに通知する。
    
    定義:
    
    fireInputFixed インタフェース内 VirtualComponent
    
    パラメータ:
    
    cause - イベント発行の原因となったイベント
  - fireDisplayUpdated
```
public void fireDisplayUpdated(java.util.EventObject cause)
```
    コンポーネント上で全体表示のリフレッシュが要求されたことをリスナに通知する
    
    定義:
    
    fireDisplayUpdated インタフェース内 VirtualComponent
    
    パラメータ:
    
    cause - イベント発行の原因となったイベント
  - fireEventTriggered
```
public void fireEventTriggered(java.lang.String event,
                               java.util.EventObject cause)
```
    コンポーネント上で任意のイベント発行が行われたことをリスナに通知する。
    
    定義:
    
    fireEventTriggered インタフェース内 VirtualComponent
    
    パラメータ:
    
    event - 発行イベント名
    
    cause - イベント発行の原因となったイベント
  - destroy
```
public void destroy()
```
    終了処理を行う。
    
    定義:
    
    destroy インタフェース内 VirtualComponent
  - getReference
```
public Reference getReference(java.lang.String ref)
```
    参照オブジェクトを取得する
    
    定義:
    
    getReference インタフェース内 ReferenceSource
    
    パラメータ:
    
    ref - 参照文字列
    
    戻り値:
    
    参照オブジェクト
  - getPreference
```
public java.lang.String getPreference(java.lang.String key)
```
    コンポーネントに関するユーザー設定値を取得する
    
    定義:
    
    getPreference インタフェース内 VirtualComponent
    
    パラメータ:
    
    key - 設定値キー
    
    戻り値:
    
    設定値文字列
  - setPreference
```
public void setPreference(java.lang.String key,
                          java.lang.Object value)
```
    コンポーネントに関するユーザー設定値を設定する
    
    定義:
    
    setPreference インタフェース内 VirtualComponent
    
    パラメータ:
    
    key - 設定値キー
    
    value - 設定値
  - getTranslator
```
public Translator getTranslator(java.lang.String name)
```
    トランスレータを取得する
    
    定義:
    
    getTranslator インタフェース内 VirtualComponent
    
    パラメータ:
    
    name - トランスレータ名。nullの場合はdefault指定と解釈する。
    
    戻り値:
    
    Translatorオブジェクト
  - toString
```
public java.lang.String toString()
```
    文字列表現を返す
    
    オーバーライド:
    
    toString クラス内 java.lang.Object
    
    戻り値:
    
    文字列表現
  - isSavePreference
```
protected boolean isSavePreference()
```
    ユーザー設定の保存を行うべきかを判定する
    
    戻り値:
    
    保存するならtrue、しないならfalse
  - isVisible
```
protected boolean isVisible()
```
    コンポーネントが可視状態かを判定する
    
    戻り値:
    
    可視状態ならtrue、違うならfalse
  - setVisible
```
protected void setVisible(boolean visible)
```
    コンポーネントの表示、非表示を設定する
    
    パラメータ:
    
    visible - 表示するならtrue、しないならfalse
  - isEnabled
```
protected boolean isEnabled()
```
    コンポーネントが有効状態であるかを判定する
    
    戻り値:
    
    有効ならtrue、無効ならfalse
  - setEnabled
```
protected void setEnabled(boolean enabled)
```
    コンポーネントの有効、無効を設定する
    
    パラメータ:
    
    enabled - 有効ならtrue、無効ならfalse
  - isAvailableState
```
protected boolean isAvailableState()
```
    コンポーネントが状態遷移表上で有効になっているか判定する。
    
    戻り値:
    
    このコンポーネントが有効な状態ならtrue、無効ならfalse
  - isVisibleCondition
```
protected boolean isVisibleCondition()
```
    コンポーネントが可視状態の条件に合っているか判定する
    
    戻り値:
    
    可視状態ならtrue、違うならfalse
  - isEnabledCondition
```
protected boolean isEnabledCondition()
```
    コンポーネントが有効状態の条件に合っているか判定する
    
    戻り値:
    
    有効ならtrue、無効ならfalse
  - init
```
protected void init(java.lang.String instanceID,
                    java.util.Map params)
```
    初期化メソッド。実装クラスのコンストラクタで必ずコールしてください。
    
    パラメータ:
    
    instanceID - コンポーネントインスタンスに割り当てられたユニークなID
    
    params - 初期化パラメータ格納Map
  - addProcessEvent
```
protected void addProcessEvent(java.lang.String event)
```
    コンポーネントから送信するイベントを登録する
    
    パラメータ:
    
    event -
  - addAvailableState
```
protected void addAvailableState(java.lang.String state)
```
    コンポーネントが有効となる状態を登録する
    
    パラメータ:
    
    state - 有効になる状態
  - setStarted
```
protected void setStarted()
```
    初期化済状態にする
  - isStarted
```
protected boolean isStarted()
```
    初期化が完了しているかを判定する
    
    戻り値:
    
    初期化済ならtrue、違うならfalse
  - setVisibleLocal
```
protected abstract void setVisibleLocal(boolean visible)
```
    実装に応じた、setVisible後の処理を実装してください。
    
    パラメータ:
    
    visible - 可視、不可視フラグ
  - setEnabledLocal
```
protected abstract void setEnabledLocal(boolean enabled)
```
    実装に応じた、setEnabled後の処理を実装してください。
    
    パラメータ:
    
    enabled - 有効、無効フラグ
  - getAreaEventListener
```
protected abstract AreaEventListener getAreaEventListener()
```
    エリアに登録するイベントリスナを取得する。派生クラスで実装してください。
    
    戻り値:
    
    エリアイベントリスナー

クラス AbstractVirtualComponent

フィールドのサマリー

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

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

メソッドのサマリー

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

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

コンストラクタの詳細

AbstractVirtualComponent

メソッドの詳細

getInstanceID

getDefinition

addComponentEventListener

getComponentEventListeners

removeComponentEventListener

installArea

installAccessControlPermission

getArea

getClientContext

fireInputFixed

fireDisplayUpdated

fireEventTriggered

destroy

getReference

getPreference

setPreference

getTranslator

toString

isSavePreference

isVisible

setVisible

isEnabled

setEnabled

isAvailableState

isVisibleCondition

isEnabledCondition

init

addProcessEvent

addAvailableState

setStarted

isStarted

setVisibleLocal

setEnabledLocal

getAreaEventListener