モジュール javafx.graphics
パッケージ javafx.scene

クラスImageCursor

  • public class ImageCursor
extends Cursor
    マウス・カーソルのカスタム・イメージ表現。 カスタム・カーソルをサポートしないプラットフォームでは、指定されたImageCursorのかわりにCursor.DEFAULTが使用されます。

    例: 

    import javafx.scene.*;
import javafx.scene.image.*;

Image image = new Image("mycursor.png");

Scene scene = new Scene(400, 300);
scene.setCursor(new ImageCursor(image,
                                image.getWidth() / 2,
                                image.getHeight() /2));
    導入されたバージョン:
    JavaFX 2.0

    • プロパティの詳細

      • image

        public final ReadOnlyObjectProperty<Image> imageProperty
        カーソルがアクティブなときに表示されるイメージ。 イメージがnullの場合は、Cursor.DEFAULTが使用されます。
        デフォルト値:
        null
        関連項目:
        getImage()

      • hotspotX

        public final ReadOnlyDoubleProperty hotspotXProperty
        カーソルのホット・スポットのX座標。 このホットスポットは、マウスの位置に表示されるカーソル・イメージ内の位置を表します。 これは[0,image.width-1]の範囲内にする必要があります。 0より小さい値は0に設定されます。 image.width-1より大きい値はimage.width-1に設定されます。
        デフォルト値:
        0
        関連項目:
        getHotspotX()

      • hotspotY

        public final ReadOnlyDoubleProperty hotspotYProperty
        カーソルのホット・スポットのY座標。 このホットスポットは、マウスの位置に表示されるカーソル・イメージ内の位置を表します。 これは[0,image.height-1]の範囲内にする必要があります。 0より小さい値は0に設定されます。 image.height-1より大きい値はimage.height-1に設定されます。
        デフォルト値:
        0
        関連項目:
        getHotspotY()

    • コンストラクタの詳細

      • ImageCursor

        public ImageCursor()
        Cursor.DEFAULTとして表示される新しい空のImageCursorを構築します。

      • ImageCursor

        public ImageCursor​(Image image)
        指定されたイメージからImageCursorを構築します。 カーソルのホット・スポットは、デフォルトで左上隅に設定されます。
        パラメータ:
        image - イメージ

      • ImageCursor

        public ImageCursor​(Image image,
                   double hotspotX,
                   double hotspotY)
        指定されたイメージおよびホットスポット座標からImageCursorを構築します。
        パラメータ:
        image - イメージ
        hotspotX - カーソルのホット・スポットのX座標
        hotspotY - カーソルのホット・スポットのY座標

    • メソッドの詳細

      • getImage

        public final Image getImage()
        プロパティimageの値を取得します。
        プロパティの説明:
        カーソルがアクティブなときに表示されるイメージ。 イメージがnullの場合は、Cursor.DEFAULTが使用されます。
        デフォルト値:
        null

      • imageProperty

        public final ReadOnlyObjectProperty<Image> imageProperty()
        カーソルがアクティブなときに表示されるイメージ。 イメージがnullの場合は、Cursor.DEFAULTが使用されます。
        デフォルト値:
        null
        関連項目:
        getImage()

      • getHotspotX

        public final double getHotspotX()
        プロパティhotspotXの値を取得します。
        プロパティの説明:
        カーソルのホット・スポットのX座標。 このホットスポットは、マウスの位置に表示されるカーソル・イメージ内の位置を表します。 これは[0,image.width-1]の範囲内にする必要があります。 0より小さい値は0に設定されます。 image.width-1より大きい値はimage.width-1に設定されます。
        デフォルト値:
        0

      • hotspotXProperty

        public final ReadOnlyDoubleProperty hotspotXProperty()
        カーソルのホット・スポットのX座標。 このホットスポットは、マウスの位置に表示されるカーソル・イメージ内の位置を表します。 これは[0,image.width-1]の範囲内にする必要があります。 0より小さい値は0に設定されます。 image.width-1より大きい値はimage.width-1に設定されます。
        デフォルト値:
        0
        関連項目:
        getHotspotX()

      • getHotspotY

        public final double getHotspotY()
        プロパティhotspotYの値を取得します。
        プロパティの説明:
        カーソルのホット・スポットのY座標。 このホットスポットは、マウスの位置に表示されるカーソル・イメージ内の位置を表します。 これは[0,image.height-1]の範囲内にする必要があります。 0より小さい値は0に設定されます。 image.height-1より大きい値はimage.height-1に設定されます。
        デフォルト値:
        0

      • hotspotYProperty

        public final ReadOnlyDoubleProperty hotspotYProperty()
        カーソルのホット・スポットのY座標。 このホットスポットは、マウスの位置に表示されるカーソル・イメージ内の位置を表します。 これは[0,image.height-1]の範囲内にする必要があります。 0より小さい値は0に設定されます。 image.height-1より大きい値はimage.height-1に設定されます。
        デフォルト値:
        0
        関連項目:
        getHotspotY()

      • getBestSize

        public static Dimension2D getBestSize​(double preferredWidth,
                                      double preferredHeight)
        指定された優先サイズに最も近い、サポートされるカーソル・サイズを取得します。 プラットフォームがカスタム・カーソルをサポートしていない場合は、(0,0)の値が返されます。

        注意: 寸法が、サポートされているサイズ(このメソッドによって返されるサイズ)に一致しないイメージの場合、実装は、イメージのサイズをサポートされているサイズに変更します。 これにより、品質が低下する可能性があります。

        注意: これらの値はオペレーティング・システム、グラフィック・カードおよび画面解像度によって異なる可能性があり、執筆時点では、サンプルのWindows Vistaマシンでは、すべてのリクエストされたサイズに対して32x32が返され、サンプルのMacマシンおよびLinuxマシンでは、最大の64x64までのリクエストされたサイズが返されました。 アプリケーションでは、すべてのプラットフォームで正常に機能する32x32のカーソルを提供する必要があり、オプションで、64x64のカーソルを、サポートされているプラットフォームのために提供します。

        パラメータ:
        preferredWidth - カーソルの優先幅
        preferredHeight - カーソルの優先高
        戻り値:
        サポートされているカーソルのサイズ

      • getMaximumColors

        public static int getMaximumColors()
        カスタム・イメージ・カーソル・パレットでサポートされる最大の色数を返します。

        注意: サポートされている最大値を超える数の色をパレットに持つイメージが使用される場合、実装は、パレットの色数をサポートされている最大値まで減らすことを試みます。 これにより、品質が低下する可能性があります。

        注意: これらの値はオペレーティング・システム、グラフィック・カードおよび画面解像度によって異なる可能性があり、執筆時点では、サンプルのWindows Vistaマシンでは256が返され、サンプルのMacマシンではフル・カラー・カーソルのサポートを示すInteger.MAX_VALUEが返され、サンプルのLinuxマシンでは2が返されました。 アプリケーションでは、各プラットフォームでカーソルを最適化するために、これらの3つの色深度のターゲットを設定することが必要となる場合があります。

        戻り値:
        カスタム・イメージ・カーソル・パレットでサポートされる最大の色数

      • chooseBestCursor

        public static ImageCursor chooseBestCursor​(Image[] images,
                                           double hotspotX,
                                           double hotspotY)
        指定されたイメージのいずれかからカスタム・イメージ・カーソルを作成します。 この関数により、最適なカーソルのサイズに最も近いサイズのイメージが選択されます。 返されたImageCursorのhotpotXはchosenImage.width/images[0].widthによってスケーリングされ、hotspotYはchosenImage.height/images[0].heightによってスケール変更されます。

        カスタム・カーソルをサポートしないプラットフォームでは、返されたImageCursorのかわりにCursor.DEFAULTが使用されます。

        パラメータ:
        images - 選択可能なイメージのシーケンス(プリファレンスの順序)
        hotspotX - イメージのシーケンスの最初のイメージ内のホットスポットのX座標
        hotspotY - イメージのシーケンスの最初のイメージ内のホットスポットのY座標
        戻り値:
        最適なイメージから作成されたカーソル