pexa.client.std.view

インタフェース VirtualComponent

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

ReferenceSource

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

SwingVirtualComponent, VButton, VCalendar, VCheckBox, VCheckBoxGroup, VClear, VComboBox, VComponent, VDialog, VDynamicForm, VHTMLPane, VLabel, VLink, VLinkMenu, VList, VMenuBar, VMenuButton, VPanel, VPlugin, VRadioButtonGroup, VScrollPane, VSpinner, VTabbedPane, VTable, VTextArea, VTextField, VToggleButtonGroup, VTree, VTreeMenu

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

AbstractSwingVirtualComponent, AbstractVirtualComponent, DefaultVButtonImpl, DefaultVCalendarImpl, DefaultVCheckBoxGroupImpl, DefaultVCheckBoxImpl, DefaultVClearImpl, DefaultVComboBoxImpl, DefaultVComponentImpl, DefaultVDialogImpl, DefaultVDynamicFormImpl, DefaultVHTMLPaneImpl, DefaultVLabelImpl, DefaultVLinkImpl, DefaultVLinkMenuImpl, DefaultVListImpl, DefaultVMenuBarImpl, DefaultVMenuButtonImpl, DefaultVPanelImpl, DefaultVPluginImpl, DefaultVRadioButtonGroupImpl, DefaultVScrollPaneImpl, DefaultVSpinnerImpl, DefaultVTabbedPaneImpl, DefaultVTableImpl, DefaultVTextAreaImpl, DefaultVTextFieldImpl, DefaultVToggleButtonGroupImpl, DefaultVTreeImpl, DefaultVTreeMenuImpl, EditableVTableImpl

public interface VirtualComponent
extends ReferenceSource

クライアント形態ごとのGUIコンポーネントに接続する仮想コンポーネント が実装すべきインタフェース。

バージョン:

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

作成者:

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static java.lang.String	COMPONENT_DEFINITION 初期化パラメータのキー

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addComponentEventListener(ComponentEventListener cel) コンポーネントイベントのリスナオブジェクトを追加する。
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() コンポーネントが所属するエリアを取得する。
ClientContext	getClientContext() コンポーネントがひも尽く実行コンテキストを取得する
ComponentEventListener[]	getComponentEventListeners() リスナー配列を取得する
ComponentDefinition	getDefinition() コンポーネント定義を取得する
java.lang.String	getInstanceID() インスタンスに割り当てられたユニークなIDを取得する
java.lang.String	getPreference(java.lang.String key) コンポーネントに関するユーザー設定値を取得する
java.util.Collection	getRealComponent() 仮想コンポーネントがラッピングしている実際の制御対象コンポーネントを返す (optional operation)
Translator	getTranslator(java.lang.String name) トランスレータを取得する
void	input(ClientEvent e) コンポーネントによる値の入力確定を行う
void	installAccessControlPermission(ClientEvent e) Componentの権限制御パーミッションをインストールする
void	installArea(Area area) コンポーネントが所属するエリアを登録する。
void	removeComponentEventListener(ComponentEventListener cel) コンポーネントイベントのリスナオブジェクトを削除する。
void	setPreference(java.lang.String key, java.lang.Object value) コンポーネントに関するユーザー設定値を設定する
void	start(ClientEvent e) Componentの処理を開始する。
void	update(ClientEvent e) Componentの表示を更新する

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

getReference

フィールドの詳細

COMPONENT_DEFINITION

static final java.lang.String COMPONENT_DEFINITION

初期化パラメータのキー

関連項目:

定数フィールド値

メソッドの詳細

getInstanceID

java.lang.String getInstanceID()

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

戻り値:

インスタンスID

getDefinition

ComponentDefinition getDefinition()

コンポーネント定義を取得する

戻り値:

コンポーネント定義

addComponentEventListener

void addComponentEventListener(ComponentEventListener cel)

コンポーネントイベントのリスナオブジェクトを追加する。

パラメータ:

cel - コンポーネントイベントリスナ

getComponentEventListeners

ComponentEventListener[] getComponentEventListeners()

リスナー配列を取得する

戻り値:

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

removeComponentEventListener

void removeComponentEventListener(ComponentEventListener cel)

コンポーネントイベントのリスナオブジェクトを削除する。

パラメータ:

cel - コンポーネントイベントリスナ

installArea

void installArea(Area area)

コンポーネントが所属するエリアを登録する。 登録は一度だけ行うことができる。二度目以降の登録が行われた場合はエラー

パラメータ:

area - 所属するエリア

例外:

java.lang.IllegalStateException - 二度目以降の登録が行われた場合

installAccessControlPermission

void installAccessControlPermission(ClientEvent e)
                             throws RecoverableException

Componentの権限制御パーミッションをインストールする

パラメータ:

e - イベント情報

例外:

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

getArea

Area getArea()

コンポーネントが所属するエリアを取得する。

戻り値:

area 所属するエリア

getClientContext

ClientContext getClientContext()

コンポーネントがひも尽く実行コンテキストを取得する

戻り値:

実行コンテキスト

start

void start(ClientEvent e)
    throws RecoverableException

Componentの処理を開始する。

パラメータ:

e - イベント情報

例外:

RecoverableException - 回復可能な業務例外

update

void update(ClientEvent e)
     throws RecoverableException

Componentの表示を更新する

パラメータ:

e - イベント情報

例外:

RecoverableException - 回復可能な業務例外

input

void input(ClientEvent e)
    throws RecoverableException

コンポーネントによる値の入力確定を行う

パラメータ:

e - イベント情報

例外:

RecoverableException - 回復可能な業務例外

fireInputFixed

void fireInputFixed(java.util.EventObject cause)

コンポーネント上で入力確定が行われたことをリスナに通知する。

パラメータ:

cause - イベント発行の原因となったイベント

fireDisplayUpdated

void fireDisplayUpdated(java.util.EventObject cause)

コンポーネント上で全体表示のリフレッシュが要求されたことをリスナに通知する

パラメータ:

cause - イベント発行の原因となったイベント

fireEventTriggered

void fireEventTriggered(java.lang.String event,
                        java.util.EventObject cause)

コンポーネント上で任意のイベント発行が行われたことをリスナに通知する。

パラメータ:

event - 発行イベント名

cause - イベント発行の原因となったイベント

destroy

void destroy()

終了処理を行う。

getRealComponent

java.util.Collection getRealComponent()

仮想コンポーネントがラッピングしている実際の制御対象コンポーネントを返す (optional operation)

戻り値:

制御対象コンポーネントオブジェクト

getPreference

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

コンポーネントに関するユーザー設定値を取得する

パラメータ:

key - 設定値キー

戻り値:

設定値文字列

setPreference

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

コンポーネントに関するユーザー設定値を設定する

パラメータ:

key - 設定値キー

value - 設定値

getTranslator

Translator getTranslator(java.lang.String name)

トランスレータを取得する

パラメータ:

name - トランスレータ名。nullの場合はdefault指定と解釈する。

戻り値:

Translatorオブジェクト