AbstractSwingVirtualComponent (PEXA API Document)

java.lang.Object
- pexa.client.std.view.base.AbstractVirtualComponent
- - pexa.client.std.view.swing.component.virtual.AbstractSwingVirtualComponent

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

ReferenceSource, SwingVirtualComponent, VirtualComponent

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

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 abstract class AbstractSwingVirtualComponent
extends AbstractVirtualComponent
implements SwingVirtualComponent
```
リッチクライアント向けの仮想コンポーネントの抽象実装クラス。このクラスを拡張して個々の仮想コンポーネントクラスを作成してください。

バージョン:

$Revision: 6615 $ $Date:: 2011-09-04 12:53:40 #$

作成者:

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected static java.lang.String`	`ATTR_Background` 定義から取得する属性値キー(背景色)
`protected static java.lang.String`	`ATTR_Foreground` 定義から取得する属性値キー(前景色)
`protected static java.lang.String`	`ATTR_OnChange` 定義の属性値キー

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

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

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

AbstractSwingVirtualComponent()

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected void`	`arrangeFont(java.awt.Component target, java.awt.Font font)` 画面上のフォントを設定し直す
`void`	`destroy()` 終了処理を行う。
`protected abstract void`	`destroyLocal()` destoryメソッドの最後にコールされる。
`protected void`	`fireOnChange(java.util.EventObject e)` onChange属性が指定されている場合はイベントを発行する。
`protected AreaEventListener`	`getAreaEventListener()` エリアに登録するイベントリスナを取得する。
`protected java.awt.Color`	`getBackground()` 背景色設定を取得する
`protected java.awt.Font`	`getComponentFont(java.awt.Component target)` コンポーネントに適用するフォントを取得する
`protected java.awt.Color`	`getDisabledBackground()` disable時の背景色を取得する。
`protected java.awt.Color`	`getEnabledBackground()` enable時の背景色を取得する。
`protected java.awt.Color`	`getForeground()` 前景色設定を取得する
`protected java.awt.Component`	`getGUIComponent()` この仮想コンポーネントが制御するGUIコンポーネントを取得する。
`protected java.awt.Font`	`getPopupMenuFont(java.awt.Component target)` PopupMenuに適用するフォントを取得する
`java.util.Collection`	`getRealComponent()` 仮想コンポーネントがラッピングしている実際の制御対象コンポーネントを返す
`protected java.awt.Color`	`getRequiredBackground()` 必須入力項目時の背景色を取得する
`protected SwingArea`	`getSwingArea()` 自身が所属するAreaをSwingAreaのインスタンスとして取得する
`protected abstract java.lang.Class[]`	`getTargetGUIComponentTypes()` 仮想コンポーネントが制御対象とするGUIコンポーネントのクラスを配列で返す。
`void`	`input(ClientEvent e)` コンポーネントによる値の入力確定を行う
`protected abstract void`	`inputLocal(ClientEvent e)` doInputメソッドの最後にコールされる。
`void`	`installAccessControlPermission(ClientEvent e)` コンポーネントの権限制御パーミッションをインストールする
`protected boolean`	`isChanged(java.util.EventObject e)` 前回の入力確定時と現時点を比べて、入力値が変更されているかを判定する。
`boolean`	`isFocusOwner()` 仮想コンポーネントに対応するSwingのGUIコンポーネントがフォーカスを保持しているかを判定する。
`boolean`	`isInputValidationSucceeded()` 入力バリデーションが成功したかを返す
`protected boolean`	`isRefreshable(ClientEvent e)` 表示リフレッシュを行える状態かを判定する
`boolean`	`isTextComponent()` テキスト系コンポーネントかを判定する。
`protected void`	`onChange(ClientEvent e)` 入力処理が発生したことを契機とする実行を実行する。
`protected java.awt.Component`	`prepareGUIComponent(ClientEvent e)` リッチクライアントの具象GUIコンポーネントを用意する処理のデフォルト実装。
`protected void`	`removePopupMenu()` ポップアップメニューを削除する
`protected void`	`requestFocus()` GUIコンポーネントに対してフォーカスを要求する
`void`	`resetWaitingCursor()` カーソルを通常状態に戻す
`protected void`	`savePreference()` ユーザー設定の保存処理を行うこのクラスでは空実装となるので、必要に応じてオーバーライドしてください。
`protected void`	`setBackground(java.awt.Color background)` コンポーネントに背景色を設定する
`protected void`	`setEditable()` Text系コンポーネントのeditable属性を設定する
`protected void`	`setEnabledLocal(boolean enabled)` コンポーネントの有効、無効を設定する
`protected void`	`setForeground(java.awt.Color foreground)` コンポーネントに前景色を設定する
`protected void`	`setGUIComponent(java.awt.Component comp)` この仮想コンポーネントが制御するGUIコンポーネントを登録する
`protected void`	`setRefreshable()` リフレッシュ区分を設定する
`protected void`	`setToolTip()` コンポーネントに対するToolTip設定を行う
`protected void`	`setupFont()` コンポーネントのフォントを設定する
`protected void`	`setupPopupMenu()` ポップアップメニューが定義されている場合にセットアップする
`protected void`	`setVisibleLocal(boolean visible)` コンポーネントの表示、非表示を設定する
`void`	`setWaitingCursor()` カーソルを待機状態に設定する
`void`	`start(ClientEvent e)` Componentの処理を開始する。
`protected abstract void`	`startLocal(ClientEvent e)` startメソッドの最後にコールされる。
`void`	`update(ClientEvent e)` Componentの表示を更新する
`protected abstract void`	`updateLocal(ClientEvent e)` updateメソッドの最後にコールされる。

クラスから継承されたメソッド pexa.client.std.view.base.AbstractVirtualComponent
addAvailableState, addComponentEventListener, addProcessEvent, fireDisplayUpdated, fireEventTriggered, fireInputFixed, getArea, getClientContext, getComponentEventListeners, getDefinition, getInstanceID, getPreference, getReference, getTranslator, init, installArea, isAvailableState, isEnabled, isEnabledCondition, isSavePreference, isStarted, isVisible, isVisibleCondition, removeComponentEventListener, setEnabled, setPreference, setStarted, setVisible, toString

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

インタフェースから継承されたメソッド pexa.client.std.view.VirtualComponent
addComponentEventListener, fireDisplayUpdated, fireEventTriggered, fireInputFixed, getArea, getClientContext, getComponentEventListeners, getDefinition, getInstanceID, getPreference, getTranslator, installArea, removeComponentEventListener, setPreference

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

- フィールドの詳細
  - ATTR_OnChange
```
protected static final java.lang.String ATTR_OnChange
```
    定義の属性値キー
    
    関連項目:
    
    定数フィールド値
  - ATTR_Background
```
protected static final java.lang.String ATTR_Background
```
    定義から取得する属性値キー(背景色)
    
    関連項目:
    
    定数フィールド値
  - ATTR_Foreground
```
protected static final java.lang.String ATTR_Foreground
```
    定義から取得する属性値キー(前景色)
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - AbstractSwingVirtualComponent
```
public AbstractSwingVirtualComponent()
```
- メソッドの詳細
  - start
```
public void start(ClientEvent e)
           throws RecoverableException
```
    Componentの処理を開始する。
    
    定義:
    
    start インタフェース内 VirtualComponent
    
    パラメータ:
    
    e - イベント情報
    
    例外:
    
    RecoverableException - 回復可能な業務例外
  - update
```
public void update(ClientEvent e)
            throws RecoverableException
```
    Componentの表示を更新する
    
    定義:
    
    update インタフェース内 VirtualComponent
    
    パラメータ:
    
    e - イベント情報
    
    例外:
    
    RecoverableException - 回復可能な業務例外
  - input
```
public void input(ClientEvent e)
           throws RecoverableException
```
    コンポーネントによる値の入力確定を行う
    
    定義:
    
    input インタフェース内 VirtualComponent
    
    パラメータ:
    
    e - イベント情報
    
    例外:
    
    RecoverableException - 回復可能な業務例外
  - destroy
```
public void destroy()
```
    終了処理を行う。
    
    定義:
    
    destroy インタフェース内 VirtualComponent
    
    オーバーライド:
    
    destroy クラス内 AbstractVirtualComponent
  - isFocusOwner
```
public boolean isFocusOwner()
```
    仮想コンポーネントに対応するSwingのGUIコンポーネントがフォーカスを保持しているかを判定する。
    
    定義:
    
    isFocusOwner インタフェース内 SwingVirtualComponent
    
    戻り値:
    
    コンポーネントがフォーカスを保持していたらtrue、していなければfalse
  - isTextComponent
```
public boolean isTextComponent()
```
    テキスト系コンポーネントかを判定する。この実装では、getGUIComponentで取得されるGUIコンポーネントがText系コンポーネントの場合にtrueを返す。カスタムコンポーネントを使用している場合は必要に応じてオーバーライドして下さい。
    
    定義:
    
    isTextComponent インタフェース内 SwingVirtualComponent
    
    戻り値:
    
    テキスト系コンポーネントならtrue、しないならfalse
  - setWaitingCursor
```
public void setWaitingCursor()
```
    カーソルを待機状態に設定する
    
    定義:
    
    setWaitingCursor インタフェース内 SwingVirtualComponent
  - resetWaitingCursor
```
public void resetWaitingCursor()
```
    カーソルを通常状態に戻す
    
    定義:
    
    resetWaitingCursor インタフェース内 SwingVirtualComponent
  - isInputValidationSucceeded
```
public boolean isInputValidationSucceeded()
```
    入力バリデーションが成功したかを返す
    
    定義:
    
    isInputValidationSucceeded インタフェース内 SwingVirtualComponent
    
    戻り値:
    
    成功していればtrue
  - getRealComponent
```
public java.util.Collection getRealComponent()
```
    仮想コンポーネントがラッピングしている実際の制御対象コンポーネントを返す
    
    定義:
    
    getRealComponent インタフェース内 VirtualComponent
    
    戻り値:
    
    制御対象コンポーネントオブジェクト
  - installAccessControlPermission
```
public void installAccessControlPermission(ClientEvent e)
                                    throws RecoverableException
```
    コンポーネントの権限制御パーミッションをインストールする
    
    定義:
    
    installAccessControlPermission インタフェース内 VirtualComponent
    
    オーバーライド:
    
    installAccessControlPermission クラス内 AbstractVirtualComponent
    
    パラメータ:
    
    e - イベント情報
    
    例外:
    
    RecoverableException - パーミッション設定に失敗
  - getGUIComponent
```
protected java.awt.Component getGUIComponent()
```
    この仮想コンポーネントが制御するGUIコンポーネントを取得する。
    
    戻り値:
    
    制御対象のswingのGUIコンポーネント
  - setGUIComponent
```
protected void setGUIComponent(java.awt.Component comp)
```
    この仮想コンポーネントが制御するGUIコンポーネントを登録する
    
    パラメータ:
    
    comp - 制御対象のswingのGUIコンポーネント
  - prepareGUIComponent
```
protected java.awt.Component prepareGUIComponent(ClientEvent e)
```
    リッチクライアントの具象GUIコンポーネントを用意する処理のデフォルト実装。 GUIの準備処理を独自に行いたい場合はこのメソッドをオーバライドして必要な処理を実装してください。
    
    パラメータ:
    
    e - イベント情報
  - getBackground
```
protected java.awt.Color getBackground()
```
    背景色設定を取得する
    
    戻り値:
    
    背景色を表すColorオブジェクト
  - setBackground
```
protected void setBackground(java.awt.Color background)
```
    コンポーネントに背景色を設定する
    
    パラメータ:
    
    background - 背景色
  - getForeground
```
protected java.awt.Color getForeground()
```
    前景色設定を取得する
    
    戻り値:
    
    前景色を表すColorオブジェクト
  - setForeground
```
protected void setForeground(java.awt.Color foreground)
```
    コンポーネントに前景色を設定する
    
    パラメータ:
    
    foreground -
  - getAreaEventListener
```
protected AreaEventListener getAreaEventListener()
```
    エリアに登録するイベントリスナを取得する。
    
    定義:
    
    getAreaEventListener クラス内 AbstractVirtualComponent
    
    戻り値:
    
    エリアイベントリスナー
  - setVisibleLocal
```
protected void setVisibleLocal(boolean visible)
```
    コンポーネントの表示、非表示を設定する
    
    定義:
    
    setVisibleLocal クラス内 AbstractVirtualComponent
    
    パラメータ:
    
    visible - 表示するならtrue、しないならfalse
  - setEnabledLocal
```
protected void setEnabledLocal(boolean enabled)
```
    コンポーネントの有効、無効を設定する
    
    定義:
    
    setEnabledLocal クラス内 AbstractVirtualComponent
    
    パラメータ:
    
    enabled - 有効ならtrue、無効ならfalse
  - setToolTip
```
protected void setToolTip()
```
    コンポーネントに対するToolTip設定を行う
  - getSwingArea
```
protected SwingArea getSwingArea()
```
    自身が所属するAreaをSwingAreaのインスタンスとして取得する
    
    戻り値:
    
    自身が所属するSwingArea
  - requestFocus
```
protected void requestFocus()
```
    GUIコンポーネントに対してフォーカスを要求する
  - isChanged
```
protected boolean isChanged(java.util.EventObject e)
```
    前回の入力確定時と現時点を比べて、入力値が変更されているかを判定する。この実装では常にtrueを返すので、必要に応じてオーバーライドして下さい。
    
    パラメータ:
    
    e - イベント情報
    
    戻り値:
    
    変更されていたらtrue、なければfalse
  - setRefreshable
```
protected void setRefreshable()
```
    リフレッシュ区分を設定する
  - isRefreshable
```
protected boolean isRefreshable(ClientEvent e)
```
    表示リフレッシュを行える状態かを判定する
    
    パラメータ:
    
    e - イベント情報
    
    戻り値:
    
    リフレッシュできるならtrue, できなければfalse
  - onChange
```
protected void onChange(ClientEvent e)
```
    入力処理が発生したことを契機とする実行を実行する。この実装では、onChange属性が指定されていたらイベントを発行する。
    
    パラメータ:
    
    e - イベント情報
  - fireOnChange
```
protected void fireOnChange(java.util.EventObject e)
```
    onChange属性が指定されている場合はイベントを発行する。
    
    パラメータ:
    
    e - イベント発行の契機となった原因イベント情報
  - getEnabledBackground
```
protected java.awt.Color getEnabledBackground()
```
    enable時の背景色を取得する。
    
    戻り値:
    
    enable時の背景色。指定無しならnull
  - getDisabledBackground
```
protected java.awt.Color getDisabledBackground()
```
    disable時の背景色を取得する。
    
    戻り値:
    
    disable時の背景色。指定無しならnull
  - getRequiredBackground
```
protected java.awt.Color getRequiredBackground()
```
    必須入力項目時の背景色を取得する
    
    戻り値:
    
    required時の背景色。指定無しならnull
  - setupFont
```
protected void setupFont()
```
    コンポーネントのフォントを設定する
  - getComponentFont
```
protected java.awt.Font getComponentFont(java.awt.Component target)
```
    コンポーネントに適用するフォントを取得する
    
    パラメータ:
    
    target - 適用対象のコンポーネント
    
    戻り値:
    
    フォントオブジェクト
  - getPopupMenuFont
```
protected java.awt.Font getPopupMenuFont(java.awt.Component target)
```
    PopupMenuに適用するフォントを取得する
    
    パラメータ:
    
    target - 適用対象のコンポーネント
    
    戻り値:
    
    フォントオブジェクト
  - arrangeFont
```
protected void arrangeFont(java.awt.Component target,
                           java.awt.Font font)
```
    画面上のフォントを設定し直す
    
    パラメータ:
    
    target - 設定対象のコンポーネント
    
    font - フォントオブジェクト
  - setupPopupMenu
```
protected void setupPopupMenu()
```
    ポップアップメニューが定義されている場合にセットアップする
  - removePopupMenu
```
protected void removePopupMenu()
```
    ポップアップメニューを削除する
  - savePreference
```
protected void savePreference()
```
    ユーザー設定の保存処理を行うこのクラスでは空実装となるので、必要に応じてオーバーライドしてください。
  - setEditable
```
protected void setEditable()
```
    Text系コンポーネントのeditable属性を設定する
  - getTargetGUIComponentTypes
```
protected abstract java.lang.Class[] getTargetGUIComponentTypes()
```
    仮想コンポーネントが制御対象とするGUIコンポーネントのクラスを配列で返す。コンポーネント毎の個別処理を実装クラスでオーバライドしてください。
    
    戻り値:
    
    制御対象のGUIコンポーネントのクラス配列。チェック不要ならnullを返す。
  - startLocal
```
protected abstract void startLocal(ClientEvent e)
                            throws RecoverableException
```
    startメソッドの最後にコールされる。コンポーネント毎の個別処理を実装クラスでオーバライドしてください。
    
    パラメータ:
    
    e - イベント情報
    
    例外:
    
    RecoverableException - 回復可能な業務例外
  - updateLocal
```
protected abstract void updateLocal(ClientEvent e)
                             throws RecoverableException
```
    updateメソッドの最後にコールされる。コンポーネント毎の個別処理を実装クラスでオーバライドしてください。
    
    パラメータ:
    
    e - イベント情報
    
    例外:
    
    RecoverableException - 回復可能な業務例外
  - inputLocal
```
protected abstract void inputLocal(ClientEvent e)
                            throws RecoverableException
```
    doInputメソッドの最後にコールされる。コンポーネント毎の個別処理を実装クラスでオーバライドしてください。
    
    パラメータ:
    
    e - イベント情報
    
    例外:
    
    RecoverableException - 回復可能な業務例外
  - destroyLocal
```
protected abstract void destroyLocal()
```
    destoryメソッドの最後にコールされる。コンポーネント毎の個別処理を実装クラスでオーバライドしてください。

クラス AbstractSwingVirtualComponent

フィールドのサマリー

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

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

メソッドのサマリー

クラスから継承されたメソッド pexa.client.std.view.base.AbstractVirtualComponent

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

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

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

フィールドの詳細

ATTR_OnChange

ATTR_Background

ATTR_Foreground

コンストラクタの詳細

AbstractSwingVirtualComponent

メソッドの詳細

start

update

input

destroy

isFocusOwner

isTextComponent

setWaitingCursor

resetWaitingCursor

isInputValidationSucceeded

getRealComponent

installAccessControlPermission

getGUIComponent

setGUIComponent

prepareGUIComponent

getBackground

setBackground

getForeground

setForeground

getAreaEventListener

setVisibleLocal

setEnabledLocal

setToolTip

getSwingArea

requestFocus

isChanged

setRefreshable

isRefreshable

onChange

fireOnChange

getEnabledBackground

getDisabledBackground

getRequiredBackground

setupFont

getComponentFont

getPopupMenuFont

arrangeFont

setupPopupMenu

removePopupMenu

savePreference

setEditable

getTargetGUIComponentTypes

startLocal

updateLocal

inputLocal

destroyLocal