PFCursor (MZPlatform Component API)

java.lang.Object
- jp.go.aist.dmrc.platform.beans.gui.PFCursor

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

java.io.Serializable, PFComponent, PFXMLSerializable
```
public class PFCursor
extends java.lang.Object
implements PFComponent, PFXMLSerializable
```
マウスカーソルを扱うコンポーネント。
マウスカーソルの表示を変更するためのオブジェクト取得やマウスカーソル位置の取得、およびマウス操作を実行できる。このコンポーネントからイベントは発生しない。

関連項目:

直列化された形式

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

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

PFCursor()
コンストラクタ

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

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`int`	`getComponentID()` コンポーネントIDを取得する。
`java.lang.String`	`getComponentKey()` コンポーネントキーを取得する。
`PFMultiLocaleString`	`getComponentKeys()` 全ロケール分のコンポーネントキーを返す。
`java.lang.String`	`getComponentName()` コンポーネント名称を取得する。
`java.lang.String`	`getComponentPublicName()` コンポーネント公開名を取得する.
`java.lang.String`	`getComponentString()` コンポーネントの文字列表現を取得する。
`java.awt.Cursor`	`getCrosshairCursor()` 十字のカーソルを取得する。
`java.awt.Cursor`	`getDefaultCursor()` 標準カーソルを取得する。
`java.awt.Cursor`	`getEastResizeCursor()` 東方向サイズ変更のカーソルを取得する。
`java.awt.Cursor`	`getHandCursor()` 手の形状のカーソルを取得する。
`java.awt.Point`	`getLocation()` マウスカーソルの位置を取得する。
`int`	`getLocationX()` マウスカーソルのX座標を取得する。
`int`	`getLocationY()` マウスカーソルのY座標を取得する。
`java.awt.Cursor`	`getMoveCursor()` 移動カーソルを取得する。
`java.awt.Cursor`	`getNorthEastResizeCursor()` 北東方向サイズ変更のカーソルを取得する。
`java.awt.Cursor`	`getNorthResizeCursor()` 北方向サイズ変更のカーソルを取得する。
`java.awt.Cursor`	`getNorthWestResizeCursor()` 北西方向サイズ変更のカーソルを取得する。
`java.awt.Cursor`	`getSouthEastResizeCursor()` 南東方向サイズ変更のカーソルを取得する。
`java.awt.Cursor`	`getSouthResizeCursor()` 南方向サイズ変更のカーソルを取得する。
`java.awt.Cursor`	`getSouthWestResizeCursor()` 南西方向サイズ変更のカーソルを取得する。
`java.awt.Cursor`	`getSystemCustomCursor(java.lang.String cursorName)` システム独自のカーソルを返す。
`java.awt.Cursor`	`getTextCursor()` テキストのカーソルを取得する。
`java.awt.Cursor`	`getWaitCursor()` 待ち状態のカーソルを取得する。
`java.awt.Cursor`	`getWestCursor()` 西方向サイズ変更のカーソルを取得する。
`boolean`	`isAllowPullTransfer()` 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
`boolean`	`isAllowPushTransfer()` 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
`boolean`	`isAllowRemoteInvocation()` 他PFからのコンポーネント連携要求に対する可否属性を取得する.
`void`	`localeUpdated()` ロケール対応。
`void`	`mouseClick1()` マウスボタン１をクリックする。
`void`	`mouseClick2()` マウスボタン２をクリックする。
`void`	`mouseClick3()` マウスボタン３をクリックする。
`void`	`mouseInit()` 操作用にマウスを初期化する。
`void`	`mouseMove(int x, int y)` マウスを移動する。
`void`	`mouseMove(java.awt.Point point)` マウスを移動する。
`void`	`mouseMoveAnimated(int x, int y, int step)` アニメーション付きでマウスを移動する。
`void`	`mouseMoveAnimated(int x, int y, long msec)` アニメーション付きでマウスを移動する。
`void`	`mouseMoveAnimated(java.awt.Point point, int step)` アニメーション付きでマウスを移動する。
`void`	`mouseMoveAnimated(java.awt.Point point, long msec)` アニメーション付きでマウスを移動する。
`void`	`mousePress1()` マウスボタン１を押す。
`void`	`mousePress2()` マウスボタン２を押す。
`void`	`mousePress3()` マウスボタン３を押す。
`void`	`mouseRelease1()` マウスボタン１を離す。
`void`	`mouseRelease2()` マウスボタン２を離す。
`void`	`mouseRelease3()` マウスボタン３を離す。
`void`	`mouseWheel(int wheel)` マウスホイールを動かす。
`void`	`readXML(PFXMLLoader in)` コンポーネントのXML入力.
`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`	`writeXML(PFXMLGenerator out)` コンポーネントのXML出力.

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

- コンストラクタの詳細
  - PFCursor
```
public PFCursor()
```
    コンストラクタ
- メソッドの詳細
  - 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はプラットフォームから設定される。 各コンポーネント内では操作しないこと。
    
    定義:
    
    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型コンポーネント転送要求に対する可否
  - localeUpdated
```
public void localeUpdated()
```
    ロケール対応。
    
    定義:
    
    localeUpdated インタフェース内 PFComponent
  - getDefaultCursor
```
public java.awt.Cursor getDefaultCursor()
```
    標準カーソルを取得する。
    
    戻り値:
    
    標準カーソル
  - getCrosshairCursor
```
public java.awt.Cursor getCrosshairCursor()
```
    十字のカーソルを取得する。
    
    戻り値:
    
    十字カーソル
  - getEastResizeCursor
```
public java.awt.Cursor getEastResizeCursor()
```
    東方向サイズ変更のカーソルを取得する。
    
    戻り値:
    
    東方向サイズ変更カーソル
  - getHandCursor
```
public java.awt.Cursor getHandCursor()
```
    手の形状のカーソルを取得する。
    
    戻り値:
    
    手形状カーソル
  - getMoveCursor
```
public java.awt.Cursor getMoveCursor()
```
    移動カーソルを取得する。
    
    戻り値:
    
    移動カーソル
  - getNorthResizeCursor
```
public java.awt.Cursor getNorthResizeCursor()
```
    北方向サイズ変更のカーソルを取得する。
    
    戻り値:
    
    北方向サイズ変更カーソル
  - getNorthEastResizeCursor
```
public java.awt.Cursor getNorthEastResizeCursor()
```
    北東方向サイズ変更のカーソルを取得する。
    
    戻り値:
    
    北東方向サイズ変更カーソル
  - getNorthWestResizeCursor
```
public java.awt.Cursor getNorthWestResizeCursor()
```
    北西方向サイズ変更のカーソルを取得する。
    
    戻り値:
    
    北西方向サイズ変更カーソル
  - getSouthResizeCursor
```
public java.awt.Cursor getSouthResizeCursor()
```
    南方向サイズ変更のカーソルを取得する。
    
    戻り値:
    
    南方向サイズ変更カーソル
  - getSouthEastResizeCursor
```
public java.awt.Cursor getSouthEastResizeCursor()
```
    南東方向サイズ変更のカーソルを取得する。
    
    戻り値:
    
    南東方向サイズ変更カーソル
  - getSouthWestResizeCursor
```
public java.awt.Cursor getSouthWestResizeCursor()
```
    南西方向サイズ変更のカーソルを取得する。
    
    戻り値:
    
    南西方向サイズ変更カーソル
  - getTextCursor
```
public java.awt.Cursor getTextCursor()
```
    テキストのカーソルを取得する。
    
    戻り値:
    
    テキストカーソル
  - getWestCursor
```
public java.awt.Cursor getWestCursor()
```
    西方向サイズ変更のカーソルを取得する。
    
    戻り値:
    
    西方向サイズ変更カーソル
  - getWaitCursor
```
public java.awt.Cursor getWaitCursor()
```
    待ち状態のカーソルを取得する。
    
    戻り値:
    
    待ち状態カーソル
  - getSystemCustomCursor
```
public java.awt.Cursor getSystemCustomCursor(java.lang.String cursorName)
```
    システム独自のカーソルを返す。
    指定されたカーソルが存在しない場合は、デフォルトのカーソルを返す。
    
    パラメータ:
    
    cursorName - カーソル名
    
    戻り値:
    
    カーソル
  - getLocation
```
public java.awt.Point getLocation()
                           throws PFComponentException
```
    マウスカーソルの位置を取得する。
    
    戻り値:
    
    位置(Point)
    
    例外:
    
    PFComponentException - 取得失敗
  - getLocationX
```
public int getLocationX()
                 throws PFComponentException
```
    マウスカーソルのX座標を取得する。
    
    戻り値:
    
    X座標
    
    例外:
    
    PFComponentException - 取得失敗
  - getLocationY
```
public int getLocationY()
                 throws PFComponentException
```
    マウスカーソルのY座標を取得する。
    
    戻り値:
    
    Y座標
    
    例外:
    
    PFComponentException - 取得失敗
  - mouseInit
```
public void mouseInit()
               throws PFComponentException
```
    操作用にマウスを初期化する。
    
    例外:
    
    PFComponentException - 初期化失敗
  - mouseMove
```
public void mouseMove(int x,
                      int y)
               throws PFComponentException
```
    マウスを移動する。
    
    パラメータ:
    
    x - X座標
    
    y - Y座標
    
    例外:
    
    PFComponentException - 初期化失敗
  - mouseMove
```
public void mouseMove(java.awt.Point point)
               throws PFComponentException
```
    マウスを移動する。
    
    パラメータ:
    
    point - 位置(Point)
    
    例外:
    
    PFComponentException - 初期化失敗
  - mouseMoveAnimated
```
public void mouseMoveAnimated(int x,
                              int y,
                              int step)
                       throws PFComponentException
```
    アニメーション付きでマウスを移動する。移動時間は実行環境に依存する。
    
    パラメータ:
    
    x - X座標
    
    y - Y座標
    
    step - 移動ステップ数
    
    例外:
    
    PFComponentException - 初期化失敗
  - mouseMoveAnimated
```
public void mouseMoveAnimated(java.awt.Point point,
                              int step)
                       throws PFComponentException
```
    アニメーション付きでマウスを移動する。移動時間は実行環境に依存する。
    
    パラメータ:
    
    point - 位置(Point)
    
    step - 移動ステップ数
    
    例外:
    
    PFComponentException - 初期化失敗
  - mouseMoveAnimated
```
public void mouseMoveAnimated(int x,
                              int y,
                              long msec)
                       throws PFComponentException
```
    アニメーション付きでマウスを移動する。実際の移動時間は実行環境に依存して前後する。
    
    パラメータ:
    
    x - X座標
    
    y - Y座標
    
    msec - 移動時間(msec)
    
    例外:
    
    PFComponentException - 初期化失敗
  - mouseMoveAnimated
```
public void mouseMoveAnimated(java.awt.Point point,
                              long msec)
                       throws PFComponentException
```
    アニメーション付きでマウスを移動する。実際の移動時間は実行環境に依存して前後する。
    
    パラメータ:
    
    point - 位置(Point)
    
    msec - 移動時間(msec)
    
    例外:
    
    PFComponentException - 初期化失敗
  - mouseWheel
```
public void mouseWheel(int wheel)
                throws PFComponentException
```
    マウスホイールを動かす。回転量は負が上方向で正が下方向
    
    パラメータ:
    
    wheel - ホイール回転量
    
    例外:
    
    PFComponentException - 初期化失敗
  - mousePress1
```
public void mousePress1()
                 throws PFComponentException
```
    マウスボタン１を押す。
    
    例外:
    
    PFComponentException - 初期化失敗
  - mouseRelease1
```
public void mouseRelease1()
                   throws PFComponentException
```
    マウスボタン１を離す。
    
    例外:
    
    PFComponentException - 初期化失敗
  - mouseClick1
```
public void mouseClick1()
                 throws PFComponentException
```
    マウスボタン１をクリックする。
    
    例外:
    
    PFComponentException - 初期化失敗
  - mousePress2
```
public void mousePress2()
                 throws PFComponentException
```
    マウスボタン２を押す。
    
    例外:
    
    PFComponentException - 初期化失敗
  - mouseRelease2
```
public void mouseRelease2()
                   throws PFComponentException
```
    マウスボタン２を離す。
    
    例外:
    
    PFComponentException - 初期化失敗
  - mouseClick2
```
public void mouseClick2()
                 throws PFComponentException
```
    マウスボタン２をクリックする。
    
    例外:
    
    PFComponentException - 初期化失敗
  - mousePress3
```
public void mousePress3()
                 throws PFComponentException
```
    マウスボタン３を押す。
    
    例外:
    
    PFComponentException - 初期化失敗
  - mouseRelease3
```
public void mouseRelease3()
                   throws PFComponentException
```
    マウスボタン３を離す。
    
    例外:
    
    PFComponentException - 初期化失敗
  - mouseClick3
```
public void mouseClick3()
                 throws PFComponentException
```
    マウスボタン３をクリックする。
    
    例外:
    
    PFComponentException - 初期化失敗
  - 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

クラス PFCursor

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

メソッドのサマリー

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

コンストラクタの詳細

PFCursor

メソッドの詳細

getComponentName

getComponentKey

setComponentKey

getComponentKeys

setComponentKeys

getComponentID

setComponentID

getComponentString

getComponentPublicName

setComponentPublicName

isAllowRemoteInvocation

setAllowRemoteInvocation

isAllowPullTransfer

setAllowPullTransfer

isAllowPushTransfer

setAllowPushTransfer

localeUpdated

getDefaultCursor

getCrosshairCursor

getEastResizeCursor

getHandCursor

getMoveCursor

getNorthResizeCursor

getNorthEastResizeCursor

getNorthWestResizeCursor

getSouthResizeCursor

getSouthEastResizeCursor

getSouthWestResizeCursor

getTextCursor

getWestCursor

getWaitCursor

getSystemCustomCursor

getLocation

getLocationX

getLocationY

mouseInit

mouseMove

mouseMove

mouseMoveAnimated

mouseMoveAnimated

mouseMoveAnimated

mouseMoveAnimated

mouseWheel

mousePress1

mouseRelease1

mouseClick1

mousePress2

mouseRelease2

mouseClick2

mousePress3

mouseRelease3

mouseClick3

readXML

writeXML