jp.go.aist.dmrc.platform.beans.gui.event
クラス PFKeyEventFilter

java.lang.Object
  上位を拡張 jp.go.aist.dmrc.platform.beans.gui.event.PFInputEventFilter
      上位を拡張 jp.go.aist.dmrc.platform.beans.gui.event.PFKeyEventFilter
すべての実装されたインタフェース:
java.io.Serializable, PFComponent, PFXMLSerializable, PFEventSource, PFKeyEventSource

public class PFKeyEventFilter
extends PFInputEventFilter
implements PFKeyEventSource, PFXMLSerializable

キーイベントのイベント内容によって新たなイベントを発生させるための イベントフィルタリングを行うコンポーネント。

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

フィールドの概要
 
クラス jp.go.aist.dmrc.platform.beans.gui.event.PFInputEventFilter から継承されたフィールド
componentID, componentKey, eventMaskList
 
コンストラクタの概要
PFKeyEventFilter()
          キーイベントフィルタコンポーネントを生成する。
 
メソッドの概要
 void addEventFilter(char keyChar, int eventNo)
          キータイプイベントのフィルタを追加する。
 void addEventFilter(int eventType, int keyCode, int keyModifiers, int eventNo)
          キーイベントのフィルタを追加する。
 void addKeyModifiers(int eventNo, int keyModifiers)
          キーイベントフィルタに修飾キーを追加する。
 void addPFKeyListener(PFKeyListener lis)
          引数で与えられたイベントリスナを登録し、 キーイベント発生時に処理を行う対象とする。
 void clearEventFilter()
          キーイベントのフィルタをクリアする。
 void clearKeyModifiers(int eventNo)
          キーイベントフィルタの修飾キーをクリアする。
static int getAlphabetKeyCode(char alpha)
          アルファベットのキーコードを取得する。
 java.lang.String getComponentName()
          コンポーネント名称を取得する。
static int getDigitKeyCode(char digit)
          数字のキーコードを取得する。
static int getFunctionKeyCode(int function)
          ファンクションキーのキーコードを取得する。
static int getKeyPressEventType()
          キープレスイベントの種別を取得する。
static int getKeyReleaseEventType()
          キーリリースイベントの種別を取得する。
static int getKeyTypeEventType()
          キータイプイベントの種別を取得する。
 java.util.Iterator getPFKeyListenerList()
          キーイベントリスナ配列を取得する。
 void localeUpdated()
          ロケール変更に対応する。
 void notifyEvent(PFKeyEvent event)
          イベントを受け取る。
 void readXML(PFXMLLoader in)
          コンポーネントのXML入力.
 void removeEventFilter(int eventNo)
          キーイベントのフィルタを削除する。
 void removeKeyModifiers(int eventNo, int keyModifiers)
          キーイベントフィルタの修飾キーを削除する。
 void removePFKeyListener(PFKeyListener lis)
          引数で与えられたイベントリスナを削除し、 キーイベント発生時に処理を行う対象から外す。
 void writeXML(PFXMLGenerator out)
          コンポーネントのXML出力.
 
クラス jp.go.aist.dmrc.platform.beans.gui.event.PFInputEventFilter から継承されたメソッド
getAltGraphKeyModifier, getAltKeyModifier, getComponentID, getComponentKey, getComponentKeys, getComponentPublicName, getComponentString, getCtrlKeyModifier, getMetaKeyModifier, getShiftKeyModifier, isAllowPullTransfer, isAllowPushTransfer, isAllowRemoteInvocation, setAllowPullTransfer, setAllowPushTransfer, setAllowRemoteInvocation, setComponentID, setComponentKey, setComponentKeys, setComponentPublicName
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

PFKeyEventFilter

public PFKeyEventFilter()
キーイベントフィルタコンポーネントを生成する。

メソッドの詳細

getComponentName

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

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

getPFKeyListenerList

public java.util.Iterator getPFKeyListenerList()
キーイベントリスナ配列を取得する。

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

addPFKeyListener

public void addPFKeyListener(PFKeyListener lis)
引数で与えられたイベントリスナを登録し、 キーイベント発生時に処理を行う対象とする。

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

removePFKeyListener

public void removePFKeyListener(PFKeyListener lis)
引数で与えられたイベントリスナを削除し、 キーイベント発生時に処理を行う対象から外す。

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

localeUpdated

public void localeUpdated()
ロケール変更に対応する。

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

notifyEvent

public void notifyEvent(PFKeyEvent event)
                 throws PFMethodException,
                        PFRuntimeException
イベントを受け取る。

パラメータ:
event - キーイベント
例外:
PFMethodException - メソッド起動時のエラー
PFRuntimeException - 予期しない実行時エラー

addEventFilter

public void addEventFilter(int eventType,
                           int keyCode,
                           int keyModifiers,
                           int eventNo)
キーイベントのフィルタを追加する。

パラメータ:
eventType - イベント識別(任意:-1)
keyCode - キーコード(任意:-1)
keyModifiers - 修飾キー(任意:-1/なし:0)
eventNo - 発生させるイベントNO

addEventFilter

public void addEventFilter(char keyChar,
                           int eventNo)
キータイプイベントのフィルタを追加する。

パラメータ:
keyChar - 入力文字
eventNo - 発生させるイベントNO

removeEventFilter

public void removeEventFilter(int eventNo)
キーイベントのフィルタを削除する。

パラメータ:
eventNo - 削除対象イベントフィルタのイベントNO

clearEventFilter

public void clearEventFilter()
キーイベントのフィルタをクリアする。


addKeyModifiers

public void addKeyModifiers(int eventNo,
                            int keyModifiers)
キーイベントフィルタに修飾キーを追加する。

パラメータ:
eventNo - 追加対象のイベントNO
keyModifiers - 追加修飾キー

removeKeyModifiers

public void removeKeyModifiers(int eventNo,
                               int keyModifiers)
キーイベントフィルタの修飾キーを削除する。

パラメータ:
eventNo - 削除対象のイベントNO
keyModifiers - 削除修飾キー

clearKeyModifiers

public void clearKeyModifiers(int eventNo)
キーイベントフィルタの修飾キーをクリアする。

パラメータ:
eventNo - クリア対象のイベントNO

getKeyPressEventType

public static int getKeyPressEventType()
キープレスイベントの種別を取得する。

戻り値:
キープレスイベント識別

getKeyReleaseEventType

public static int getKeyReleaseEventType()
キーリリースイベントの種別を取得する。

戻り値:
キーリリースイベント識別

getKeyTypeEventType

public static int getKeyTypeEventType()
キータイプイベントの種別を取得する。

戻り値:
キータイプイベント識別

getAlphabetKeyCode

public static int getAlphabetKeyCode(char alpha)
アルファベットのキーコードを取得する。

パラメータ:
alpha - キー文字(A〜Z)
戻り値:
キーコード

getDigitKeyCode

public static int getDigitKeyCode(char digit)
数字のキーコードを取得する。

パラメータ:
digit - キー文字(0〜9)
戻り値:
キーコード

getFunctionKeyCode

public static int getFunctionKeyCode(int function)
ファンクションキーのキーコードを取得する。

パラメータ:
function - ファンクションキー番号(F1〜F24)
戻り値:
キーコード

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