PFTimer (MZPlatform Component API)

java.lang.Object
- jp.go.aist.dmrc.platform.beans.util.PFTimer

すべての実装されたインタフェース:: java.io.Serializable, PFComponent, PFXMLSerializable, PFActionEventSource, PFEventSource

public class PFTimer
extends java.lang.Object
implements PFComponent, PFActionEventSource, PFXMLSerializable

タイマーコンポーネント。
タイマーコンポーネントから発生するイベントは以下のとおり。

アクションイベント

トリガ	イベント番号
タイマーイベント発生	0
`start()`呼出	1
`restart()`呼出	2
`stop()`呼出	3

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

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

コンストラクタ
コンストラクタと説明
`PFTimer()` デフォルト間隔（１秒）のタイマーを生成する。
`PFTimer(int delay)` 指定間隔のタイマーを生成する。

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`void`	`addPFActionListener(PFActionListener lis)` 引数で与えられたイベントリスナを登録し、アクションイベント発生時に処理を行う対象とする。
`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`	`getDelay()` タイマー発生間隔を取得する。
`int`	`getInitialDelay()` 初期遅延時間を返す。
`java.util.Iterator`	`getPFActionListenerList()` イベントリスナ配列を取得する。
`protected void`	`init()` タイマーを初期化する。
`protected void`	`initEventListener()` タイマーイベント初期化処理。
`boolean`	`isAllowPullTransfer()` 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
`boolean`	`isAllowPushTransfer()` 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
`boolean`	`isAllowRemoteInvocation()` 他PFからのコンポーネント連携要求に対する可否属性を取得する.
`boolean`	`isRepeats()` タイマーイベントを繰り返し発生させるかどうかを返す。
`boolean`	`isRunning()` タイマーが動作しているかどうかを返す。
`void`	`localeUpdated()` ロケール更新への対応を行う。
`void`	`readXML(PFXMLLoader in)` コンポーネントのXML入力.
`void`	`removePFActionListener(PFActionListener lis)` 引数で与えられたイベントリスナを削除し、アクションイベント発生時に処理を行う対象から外す。
`void`	`restart()` タイマーを再起動する。
`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 keys)` 全ロケール分のコンポーネントキーを設定する。
`void`	`setComponentPublicName(java.lang.String publicName)` コンポーネント公開名を設定する.
`void`	`setDelay(int delay)` タイマー発生間隔を設定する。
`void`	`setInitialDelay(int delay)` 初期遅延時間を設定する。
`void`	`setRepeats(boolean repeat)` タイマーイベントを繰り返し発生させるかどうかを設定する。
`void`	`start()` タイマーを開始する。
`void`	`stop()` タイマーを停止する。
`void`	`writeXML(PFXMLGenerator out)` コンポーネントのXML出力.

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

- コンストラクタの詳細
  - PFTimer
```
public PFTimer()
```
    デフォルト間隔（１秒）のタイマーを生成する。
  - PFTimer
```
public PFTimer(int delay)
```
    指定間隔のタイマーを生成する。
    
    パラメータ:
    
    delay - 間隔（ミリ秒）
- メソッドの詳細
  - getComponentName
```
public java.lang.String getComponentName()
```
    コンポーネント名称を取得する。
    
    定義:
    
    getComponentName インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント名
  - getComponentKey
```
public java.lang.String getComponentKey()
```
    コンポーネントキーを取得する。
    
    定義:
    
    getComponentKey インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネントキー文字列
  - setComponentKey
```
public void setComponentKey(java.lang.String key)
```
    コンポーネントキーを設定する。
    
    定義:
    
    setComponentKey インタフェース内 PFComponent
    
    パラメータ:
    
    key - コンポーネントキー
  - getComponentKeys
```
public PFMultiLocaleString getComponentKeys()
```
    全ロケール分のコンポーネントキーを返す。
    
    戻り値:
    
    全ロケール分のコンポーネントキー
  - setComponentKeys
```
public void setComponentKeys(PFMultiLocaleString keys)
```
    全ロケール分のコンポーネントキーを設定する。
    
    パラメータ:
    
    keys - 全ロケール分のコンポーネントキー
  - getComponentID
```
public int getComponentID()
```
    コンポーネントIDを取得する。
    
    定義:
    
    getComponentID インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネントID
  - setComponentID
```
public void setComponentID(int id)
```
    コンポーネントIDを設定する。
    コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。
    
    定義:
    
    setComponentID インタフェース内 PFComponent
    
    パラメータ:
    
    id - 設定するコンポーネントID
  - getComponentString
```
public java.lang.String getComponentString()
```
    コンポーネントの文字列表現を取得する。
    形式："Component Name" [ ID : "ID" ]
    
    定義:
    
    getComponentString インタフェース内 PFComponent
    
    戻り値:
    
    文字列表現
  - getComponentPublicName
```
public java.lang.String getComponentPublicName()
```
    コンポーネント公開名を取得する.
    
    定義:
    
    getComponentPublicName インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント公開名
  - setComponentPublicName
```
public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException
```
    コンポーネント公開名を設定する.
    空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。また、既存コンポーネントとの重複も認めない.
    
    定義:
    
    setComponentPublicName インタフェース内 PFComponent
    
    パラメータ:
    
    publicName - 設定するコンポーネント公開名
    
    例外:
    
    PFComponentException - 規約に反する名前が設定されようとした場合
  - isAllowRemoteInvocation
```
public boolean isAllowRemoteInvocation()
```
    他PFからのコンポーネント連携要求に対する可否属性を取得する.
    
    定義:
    
    isAllowRemoteInvocation インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント連携要求可否属性
  - setAllowRemoteInvocation
```
public void setAllowRemoteInvocation(boolean flag)
```
    他PFからのコンポーネント連携要求に対する可否属性を設定する.
    
    定義:
    
    setAllowRemoteInvocation インタフェース内 PFComponent
    
    パラメータ:
    
    flag - コンポーネント連携要求に対する可否
  - isAllowPullTransfer
```
public boolean isAllowPullTransfer()
```
    他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
    
    定義:
    
    isAllowPullTransfer インタフェース内 PFComponent
    
    戻り値:
    
    Pull型コンポーネント転送要求可否属性
  - setAllowPullTransfer
```
public void setAllowPullTransfer(boolean flag)
```
    他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
    
    定義:
    
    setAllowPullTransfer インタフェース内 PFComponent
    
    パラメータ:
    
    flag - Pull型コンポーネント転送要求に対する可否
  - isAllowPushTransfer
```
public boolean isAllowPushTransfer()
```
    他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
    
    定義:
    
    isAllowPushTransfer インタフェース内 PFComponent
    
    戻り値:
    
    Push型コンポーネント転送要求可否属性
  - setAllowPushTransfer
```
public void setAllowPushTransfer(boolean flag)
```
    他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
    
    定義:
    
    setAllowPushTransfer インタフェース内 PFComponent
    
    パラメータ:
    
    flag - Push型コンポーネント転送要求に対する可否
  - getPFActionListenerList
```
public java.util.Iterator getPFActionListenerList()
```
    イベントリスナ配列を取得する。
    
    定義:
    
    getPFActionListenerList インタフェース内 PFActionEventSource
    
    戻り値:
    
    イベントリスナイテレータ
  - addPFActionListener
```
public void addPFActionListener(PFActionListener lis)
```
    引数で与えられたイベントリスナを登録し、アクションイベント発生時に処理を行う対象とする。
    
    定義:
    
    addPFActionListener インタフェース内 PFActionEventSource
    
    パラメータ:
    
    lis - 追加対象イベントリスナ
  - removePFActionListener
```
public void removePFActionListener(PFActionListener lis)
```
    引数で与えられたイベントリスナを削除し、アクションイベント発生時に処理を行う対象から外す。
    
    定義:
    
    removePFActionListener インタフェース内 PFActionEventSource
    
    パラメータ:
    
    lis - 削除対象イベントリスナ
  - firePFActionPerformed
```
protected void firePFActionPerformed(PFActionEvent event)
```
    アクションイベントをリスナーに通知する。
    
    パラメータ:
    
    event - アクションイベント
  - localeUpdated
```
public void localeUpdated()
```
    ロケール更新への対応を行う。
    
    定義:
    
    localeUpdated インタフェース内 PFComponent
  - readXML
```
public void readXML(PFXMLLoader in)
```
    コンポーネントのXML入力.
    
    定義:
    
    readXML インタフェース内 PFXMLSerializable
    
    パラメータ:
    
    in - XML入力ユーティリティ
  - writeXML
```
public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
```
    コンポーネントのXML出力.
    
    定義:
    
    writeXML インタフェース内 PFXMLSerializable
    
    パラメータ:
    
    out - XML出力ユーティリティ
    
    例外:
    
    java.io.IOException
  - init
```
protected void init()
```
    タイマーを初期化する。
  - initEventListener
```
protected void initEventListener()
```
    タイマーイベント初期化処理。
  - getDelay
```
public int getDelay()
```
    タイマー発生間隔を取得する。
    
    戻り値:
    
    タイマー間隔(ミリ秒)
    
    関連項目:
    
    setDelay(int)
  - setDelay
```
public void setDelay(int delay)
```
    タイマー発生間隔を設定する。
    ただし初期遅延時間については別途設定してください。
    
    パラメータ:
    
    delay - タイマー間隔(ミリ秒)
    
    関連項目:
    
    getDelay()
  - getInitialDelay
```
public int getInitialDelay()
```
    初期遅延時間を返す。
    
    戻り値:
    
    初期遅延時間(ミリ秒)
    
    関連項目:
    
    setInitialDelay(int)
  - setInitialDelay
```
public void setInitialDelay(int delay)
```
    初期遅延時間を設定する。
    初期遅延時間とは、タイマー開始から一回目のイベント発生までの時間のことである。
    
    パラメータ:
    
    delay - 初期遅延時間(ミリ秒)
    
    関連項目:
    
    getInitialDelay()
  - isRepeats
```
public boolean isRepeats()
```
    タイマーイベントを繰り返し発生させるかどうかを返す。
    
    戻り値:
    
    タイマーイベントを繰り返し発生させるかどうか
    
    関連項目:
    
    setRepeats(boolean)
  - setRepeats
```
public void setRepeats(boolean repeat)
```
    タイマーイベントを繰り返し発生させるかどうかを設定する。
    falseの場合、開始から初期遅延時間後にタイマーイベントを1回発生させて停止しますが、このとき停止アクションイベントは発生しません。
    
    パラメータ:
    
    repeat - タイマーイベントを繰り返し発生させるかどうか
    
    関連項目:
    
    isRepeats()
  - isRunning
```
public boolean isRunning()
```
    タイマーが動作しているかどうかを返す。
    
    戻り値:
    
    タイマー動作有無
  - start
```
public void start()
```
    タイマーを開始する。
  - restart
```
public void restart()
```
    タイマーを再起動する。
  - stop
```
public void stop()
```
    タイマーを停止する。

クラス PFTimer

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

メソッドのサマリー

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

コンストラクタの詳細

PFTimer

PFTimer

メソッドの詳細

getComponentName

getComponentKey

setComponentKey

getComponentKeys

setComponentKeys

getComponentID

setComponentID

getComponentString

getComponentPublicName

setComponentPublicName

isAllowRemoteInvocation

setAllowRemoteInvocation

isAllowPullTransfer

setAllowPullTransfer

isAllowPushTransfer

setAllowPushTransfer

getPFActionListenerList

addPFActionListener

removePFActionListener

firePFActionPerformed

localeUpdated

readXML

writeXML

init

initEventListener

getDelay

setDelay

getInitialDelay

setInitialDelay

isRepeats

setRepeats

isRunning

start

restart

stop