概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド

jp.go.aist.dmrc.platform.beans.gui
クラス PFProgressMonitor

java.lang.Object
  拡張jp.go.aist.dmrc.platform.beans.gui.PFProgressMonitor
すべての実装インタフェース:
PFActionEventSource, PFComponent, PFEventSource, PFXMLSerializable, java.io.Serializable
public class PFProgressMonitor
extends java.lang.Object
implements PFComponent, PFActionEventSource, PFXMLSerializable

進捗バーを持つ進捗ダイアログのコンポーネント。

進捗ダイアログの画面イメージは以下のとおりです。

タイトルバー
メッセージ
進捗バーの注記
進捗バー
取消ボタン

進捗ダイアログが表示されたとき、進捗値が最小値と同じ値に設定されますので、ご注意ください。

このコンポーネントから以下のイベントが発生します。

関連項目:
直列化された形式

フィールドの概要
static int CANCEL_CLICKED
          キャンセルボタンが押されたときのイベント番号。
static int CLOSE_CLICKED
          右上のクローズボタンが押されたときのイベント番号
static int CLOSE_INVOKED
          外部からclose()メソッドが呼ばれたときのイベント番号。
static int PROCESS_DONE
          進捗バーが100%になったときのイベント番号。
 
コンストラクタの概要
PFProgressMonitor()
          コンストラクタ。
 
メソッドの概要
 void addPFActionListener(PFActionListener lis)
          引数で与えられたイベントリスナを登録し、 アクションイベント発生時に処理を行う対象とする。
 void close()
          進捗ダイアログを閉じる。
protected  void close(int eventNo)
          進捗ダイアログを閉じる。
protected  void firePFActionPerformed(PFActionEvent event)
          アクションイベントを発生させる。
 int getComponentID()
          コンポーネントIDを取得する。
 java.lang.String getComponentKey()
          コンポーネントキーを取得する。
 PFMultiLocaleString getComponentKeys()
          マルチロケールコンポーネントキーを取得する。
 java.lang.String getComponentName()
          コンポーネント名称を取得する。
 java.lang.String getComponentPublicName()
          コンポーネント公開名を取得する.
 java.lang.String getComponentString()
          コンポーネントの文字列表現を取得する。
 int getMaximum()
          進捗バーの最大値を取得する。
 java.lang.String getMessage()
          メッセージを取得する。
 int getMinimum()
          進捗バーの最小値を取得する。
 PFMultiLocaleString getMultiLocaleMessage()
          メッセージを取得する。
 PFMultiLocaleString getMultiLocaleNote()
          進捗バーの注記を取得する。
 PFMultiLocaleString getMultiLocaleTitle()
          ダイアログのタイトルを取得する。
 java.lang.String getNote()
          進捗バーの注記を取得する。
 java.util.Iterator getPFActionListenerList()
          アクションイベントリスナ配列を取得する。
 int getProgress()
          進捗バーの現在値を取得する。
 java.lang.String getTitle()
          ダイアログのタイトルを取得する。
 void init()
          進捗ダイアログの初期化を行なう。
 void initMessage()
          メッセージ文字列の初期化を行なう。
 void initValue()
          最大値・最小値・現在値の初期化を行なう。
 boolean isAllowPullTransfer()
          他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowPushTransfer()
          他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowRemoteInvocation()
          他PFからのコンポーネント連携要求に対する可否属性を取得する.
 boolean isModal()
          モーダル有無を取得する。
 boolean isPercentComplete()
          進捗バーが100%かどうかを取得する。
 boolean isStringPainted()
          進捗バーにパーセンテージを描画するかどうかを取得する。
 void localeUpdated()
          ロケール更新への対応を行う。
 void readXML(PFXMLLoader in)
          コンポーネントのXML入力.
 void removePFActionListener(PFActionListener lis)
          引数で与えられたイベントリスナを削除し、 アクションイベント発生時に処理を行う対象から外す。
protected  void repaint()
          再描画を行なう。
 void setAllowPullTransfer(boolean flag)
          他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
 void setAllowPushTransfer(boolean flag)
          他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
 void setAllowRemoteInvocation(boolean flag)
          他PFからのコンポーネント連携要求に対する可否属性を設定する.
 void setComponentID(int id)
          コンポーネントIDを設定する。
 void setComponentKey(java.lang.String key)
          コンポーネントキーを設定する。
 void setComponentKeys(PFMultiLocaleString componentKey)
          マルチロケールコンポーネントキーを設定する。
 void setComponentPublicName(java.lang.String publicName)
          コンポーネント公開名を設定する.
 void setMaximum(int maximum)
          進捗バーの最大値を設定する。
 void setMessage(java.lang.String message)
          メッセージを設定する。
 void setMinimum(int minimum)
          進捗バーの最小値を設定する。
 void setModal(boolean modal)
          モーダル・モードレスを設定する。
 void setMultiLocaleMessage(PFMultiLocaleString message)
          メッセージを設定する。
 void setMultiLocaleNote(PFMultiLocaleString note)
          進捗バーの注記を設定する。
 void setMultiLocaleTitle(PFMultiLocaleString title)
          ダイアログのタイトルを設定する。
 void setNote(java.lang.String note)
          進捗バーの注記を設定する。
 void setProgress(int progress)
          進捗バーの現在値を設定する。
 void setStringPainted(boolean percentage)
          進捗バーにパーセンテージを描画するかどうかを設定する。
 void setTitle(java.lang.String title)
          ダイアログのタイトルを設定する。
 void show()
          進捗ダイアログを表示する。
 void show(PFWindowComponent parent)
          進捗ダイアログを表示する。
 void writeXML(PFXMLGenerator out)
          コンポーネントのXML出力.
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

PROCESS_DONE

public static final int PROCESS_DONE
進捗バーが100%になったときのイベント番号。

関連項目:
定数フィールド値

CLOSE_INVOKED

public static final int CLOSE_INVOKED
外部からclose()メソッドが呼ばれたときのイベント番号。

関連項目:
定数フィールド値

CANCEL_CLICKED

public static final int CANCEL_CLICKED
キャンセルボタンが押されたときのイベント番号。

関連項目:
定数フィールド値

CLOSE_CLICKED

public static final int CLOSE_CLICKED
右上のクローズボタンが押されたときのイベント番号

関連項目:
定数フィールド値
コンストラクタの詳細

PFProgressMonitor

public PFProgressMonitor()
コンストラクタ。

メソッドの詳細

init

public void init()
進捗ダイアログの初期化を行なう。
進捗ダイアログが表示されているときに呼び出さないでください。

関連項目:
initValue(), initMessage()

initValue

public void initValue()
最大値・最小値・現在値の初期化を行なう。
最大値=100、最小値=0、現在値=0 に設定される。
進捗ダイアログが表示されているときに呼び出さないでください。

initMessage

public void initMessage()
メッセージ文字列の初期化を行なう。
メッセージ・注記ともに空文字列が設定される。
進捗ダイアログが表示されているときに呼び出さないでください。

getComponentName

public java.lang.String getComponentName()
コンポーネント名称を取得する。

定義:
インタフェース PFComponent 内の getComponentName
戻り値:
コンポーネント名

getComponentKey

public java.lang.String getComponentKey()
コンポーネントキーを取得する。

定義:
インタフェース PFComponent 内の getComponentKey
戻り値:
コンポーネントキー文字列

setComponentKey

public void setComponentKey(java.lang.String key)
コンポーネントキーを設定する。

定義:
インタフェース PFComponent 内の setComponentKey
パラメータ:
key - コンポーネントキー

getComponentKeys

public PFMultiLocaleString getComponentKeys()
マルチロケールコンポーネントキーを取得する。

戻り値:
マルチロケールコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString componentKey)
マルチロケールコンポーネントキーを設定する。

パラメータ:
componentKey - マルチロケールコンポーネントキー

getComponentID

public int getComponentID()
コンポーネントIDを取得する。

定義:
インタフェース PFComponent 内の getComponentID
戻り値:
コンポーネントID

setComponentID

public void setComponentID(int id)
コンポーネントIDを設定する。
コンポーネントIDはプラットフォームから設定される。 各コンポーネント内では操作しないこと。

定義:
インタフェース PFComponent 内の setComponentID
パラメータ:
id - 設定するコンポーネントID

getComponentString

public java.lang.String getComponentString()
コンポーネントの文字列表現を取得する。
形式："Component Name" [ ID : "ID" ]

定義:
インタフェース PFComponent 内の getComponentString
戻り値:
文字列表現

getComponentPublicName

public java.lang.String getComponentPublicName()
コンポーネント公開名を取得する.

定義:
インタフェース PFComponent 内の getComponentPublicName
戻り値:
コンポーネント公開名

setComponentPublicName

public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException
コンポーネント公開名を設定する.
空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。 また、既存コンポーネントとの重複も認めない.

定義:
インタフェース PFComponent 内の setComponentPublicName
パラメータ:
publicName - 設定するコンポーネント公開名
例外:
PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

public boolean isAllowRemoteInvocation()
他PFからのコンポーネント連携要求に対する可否属性を取得する.

定義:
インタフェース PFComponent 内の isAllowRemoteInvocation
戻り値:
コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)
他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowRemoteInvocation
パラメータ:
flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

public boolean isAllowPullTransfer()
他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.

定義:
インタフェース PFComponent 内の isAllowPullTransfer
戻り値:
Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

public void setAllowPullTransfer(boolean flag)
他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowPullTransfer
パラメータ:
flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

public boolean isAllowPushTransfer()
他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.

定義:
インタフェース PFComponent 内の isAllowPushTransfer
戻り値:
Push型コンポーネント転送要求可否属性

setAllowPushTransfer

public void setAllowPushTransfer(boolean flag)
他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowPushTransfer
パラメータ:
flag - Push型コンポーネント転送要求に対する可否

getPFActionListenerList

public java.util.Iterator getPFActionListenerList()
アクションイベントリスナ配列を取得する。

定義:
インタフェース PFActionEventSource 内の getPFActionListenerList
戻り値:
イベントリスナイテレータ

addPFActionListener

public void addPFActionListener(PFActionListener lis)
引数で与えられたイベントリスナを登録し、 アクションイベント発生時に処理を行う対象とする。

定義:
インタフェース PFActionEventSource 内の addPFActionListener
パラメータ:
lis - 追加対象イベントリスナ

removePFActionListener

public void removePFActionListener(PFActionListener lis)
引数で与えられたイベントリスナを削除し、 アクションイベント発生時に処理を行う対象から外す。

定義:
インタフェース PFActionEventSource 内の removePFActionListener
パラメータ:
lis - 削除対象イベントリスナ

firePFActionPerformed

protected void firePFActionPerformed(PFActionEvent event)
アクションイベントを発生させる。

パラメータ:
event - アクションイベント

localeUpdated

public void localeUpdated()
ロケール更新への対応を行う。

定義:
インタフェース PFComponent 内の localeUpdated

getMaximum

public int getMaximum()
進捗バーの最大値を取得する。

戻り値:
進捗バーの最大値

setMaximum

public void setMaximum(int maximum)
進捗バーの最大値を設定する。

パラメータ:
maximum - 進捗バーの最大値

getMinimum

public int getMinimum()
進捗バーの最小値を取得する。

戻り値:
進捗バーの最小値

setMinimum

public void setMinimum(int minimum)
進捗バーの最小値を設定する。

パラメータ:
minimum - 進捗バーの最小値

getProgress

public int getProgress()
進捗バーの現在値を取得する。

戻り値:
進捗バーの現在値

setProgress

public void setProgress(int progress)
進捗バーの現在値を設定する。

パラメータ:
progress - 進捗バーの現在値

getTitle

public java.lang.String getTitle()
ダイアログのタイトルを取得する。

戻り値:
タイトル

setTitle

public void setTitle(java.lang.String title)
ダイアログのタイトルを設定する。

パラメータ:
title - ダイアログのタイトル

getMultiLocaleTitle

public PFMultiLocaleString getMultiLocaleTitle()
ダイアログのタイトルを取得する。

戻り値:
ダイアログのタイトル

setMultiLocaleTitle

public void setMultiLocaleTitle(PFMultiLocaleString title)
ダイアログのタイトルを設定する。

パラメータ:
title - ダイアログのタイトル

getMessage

public java.lang.String getMessage()
メッセージを取得する。

戻り値:
メッセージ

setMessage

public void setMessage(java.lang.String message)
メッセージを設定する。

パラメータ:
message - メッセージ

getMultiLocaleMessage

public PFMultiLocaleString getMultiLocaleMessage()
メッセージを取得する。

戻り値:
メッセージ

setMultiLocaleMessage

public void setMultiLocaleMessage(PFMultiLocaleString message)
メッセージを設定する。

パラメータ:
message - メッセージ

getNote

public java.lang.String getNote()
進捗バーの注記を取得する。

戻り値:
進捗バーの注記

setNote

public void setNote(java.lang.String note)
進捗バーの注記を設定する。

パラメータ:
note - 進捗バーの注記

getMultiLocaleNote

public PFMultiLocaleString getMultiLocaleNote()
進捗バーの注記を取得する。

戻り値:
注記(マルチロケール文字列)

setMultiLocaleNote

public void setMultiLocaleNote(PFMultiLocaleString note)
進捗バーの注記を設定する。

パラメータ:
note - 注記(マルチロケール文字列)

isStringPainted

public boolean isStringPainted()
進捗バーにパーセンテージを描画するかどうかを取得する。

戻り値:
進捗バーにパーセンテージを描画する場合はtrue

setStringPainted

public void setStringPainted(boolean percentage)
進捗バーにパーセンテージを描画するかどうかを設定する。

パラメータ:
percentage - 進捗バーにパーセンテージを描画する場合はtrue

isPercentComplete

public boolean isPercentComplete()
進捗バーが100%かどうかを取得する。

戻り値:
進捗バーが100%のときtrue

isModal

public boolean isModal()
モーダル有無を取得する。

戻り値:
モーダルの場合true、モードレスの場合false

setModal

public void setModal(boolean modal)
モーダル・モードレスを設定する。
ただし、進捗ダイアログが表示中の場合、モーダル・モードレスの切り替えはできない。

パラメータ:
modal - モーダルの場合true、モードレスの場合false

repaint

protected void repaint()
再描画を行なう。

show

public void show()
進捗ダイアログを表示する。

show

public void show(PFWindowComponent parent)
進捗ダイアログを表示する。

パラメータ:
parent - 親コンポーネント

close

public void close()
進捗ダイアログを閉じる。

close

protected void close(int eventNo)
進捗ダイアログを閉じる。

readXML

public void readXML(PFXMLLoader in)
コンポーネントのXML入力.

定義:
インタフェース PFXMLSerializable 内の readXML
パラメータ:
in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
コンポーネントのXML出力.

定義:
インタフェース PFXMLSerializable 内の writeXML
パラメータ:
out - XML出力ユーティリティ
例外:
java.io.IOException
概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド