- java.lang.Object
-
- javafx.scene.image.Image
-
- 直系の既知のサブクラス:
WritableImage
public class Image extends Object
Image
クラスはグラフィカル・イメージを表し、指定されたURLからのイメージのロードに使用されます。サポートされているイメージ形式は次のとおりです。
イメージは、ロードするときにサイズ変更できます(たとえば、イメージによって消費されるメモリーの量を削減するために)。 スケーリングするときに使用されるフィルタリングの品質、および元のイメージの縦横比を保持するかどうかをアプリケーションで指定できます。
URL
でサポートされるすべてのURLは、コンストラクタに渡すことができます。 渡された文字列が有効なURLではなく、パスである場合は、クラスパスでイメージが検索されます。このクラスでロードされたイメージを表示するには、
ImageView
を使用します。 複数のImageView
で同じImage
インスタンスを表示できます。イメージをロードするためのコードの例。
import javafx.scene.image.Image; // load an image in background, displaying a placeholder while it's loading // (assuming there's an ImageView node somewhere displaying this image) // The image is located in default package of the classpath Image image1 = new Image("/flower.png", true); // load an image and resize it to 100x150 without preserving its original // aspect ratio // The image is located in my.res package of the classpath Image image2 = new Image("my/res/flower.png", 100, 150, false, false); // load an image and resize it to width of 100 while preserving its // original aspect ratio, using faster filtering method // The image is downloaded from the supplied URL through http protocol Image image3 = new Image("http://sample.com/res/flower.png", 100, 0, false, false); // load an image and resize it only in one dimension, to the height of 100 and // the original width, without preserving original aspect ratio // The image is located in the current working directory Image image4 = new Image("file:flower.png", 0, 100, false, false);
- 導入されたバージョン:
- JavaFX 2.0
-
-
プロパティのサマリー
プロパティ Type プロパティ 説明 ReadOnlyBooleanProperty
error
イメージのロード中にエラーが検出されたかどうかを示します。ReadOnlyObjectProperty<Exception>
exception
イメージのロードが失敗する原因となる例外。ReadOnlyDoubleProperty
height
イメージのロードに失敗した場合のイメージの高さまたは0
。ReadOnlyDoubleProperty
progress
完了したイメージのロードのおおよそのパーセント値。ReadOnlyDoubleProperty
width
イメージのロードに失敗した場合のイメージの幅または0
。
-
コンストラクタのサマリー
コンストラクタ コンストラクタ 説明 Image(InputStream is)
指定された入力ストリームからロードされたコンテンツを使用したImage
を構築します。Image(InputStream is, double requestedWidth, double requestedHeight, boolean preserveRatio, boolean smooth)
指定されたパラメータを使用した新しいImage
を構築します。Image(String url)
指定されたURLからロードされたコンテンツを使用したImage
を構築します。Image(String url, boolean backgroundLoading)
指定されたパラメータを使用した新しいImage
を構築します。Image(String url, double requestedWidth, double requestedHeight, boolean preserveRatio, boolean smooth)
指定されたパラメータを使用した新しいImage
を構築します。Image(String url, double requestedWidth, double requestedHeight, boolean preserveRatio, boolean smooth, boolean backgroundLoading)
指定されたパラメータを使用した新しいImage
を構築します。
-
メソッドのサマリー
すべてのメソッド インスタンス・メソッド 具象メソッド 修飾子と型 メソッド 説明 void
cancel()
このイメージのバックグラウンド・ロードを取り消します。ReadOnlyBooleanProperty
errorProperty()
イメージのロード中にエラーが検出されたかどうかを示します。ReadOnlyObjectProperty<Exception>
exceptionProperty()
イメージのロードが失敗する原因となる例外。Exception
getException()
プロパティexceptionの値を取得します。double
getHeight()
プロパティheightの値を取得します。PixelReader
getPixelReader()
このメソッドは、イメージが読取り可能な場合に、イメージのピクセルを読み取るアクセスを提供するPixelReader
を返します。double
getProgress()
プロパティprogressの値を取得します。double
getRequestedHeight()
境界ボックスの高さを取得します。これに合うように、必要に応じてソース・イメージのサイズが変更されます。double
getRequestedWidth()
境界ボックスの幅を取得します。これに合うように、必要に応じてソース・イメージのサイズが変更されます。String
getUrl()
コンストラクタで指定されている場合、Imageインスタンスに含まれるピクセル・データを取得するために使用されるURLを返します。double
getWidth()
プロパティwidthの値を取得します。ReadOnlyDoubleProperty
heightProperty()
イメージのロードに失敗した場合のイメージの高さまたは0
。boolean
isBackgroundLoading()
イメージがバックグラウンドでロードされているかどうかを示します。boolean
isError()
プロパティerrorの値を取得します。boolean
isPreserveRatio()
width
およびheight
で指定した境界ボックス内でイメージが適合するようにスケーリングするときに、元のイメージの縦横比を維持するかどうかを示します。boolean
isSmooth()
width
とheight
で指定した境界ボックス内に収まるようにこのイメージをスケーリングするときに、より高品質なフィルタリング・アルゴリズムとより高速なフィルタリング・アルゴリズムのどちらを使用するかを示します。ReadOnlyDoubleProperty
progressProperty()
完了したイメージのロードのおおよそのパーセント値。ReadOnlyDoubleProperty
widthProperty()
イメージのロードに失敗した場合のイメージの幅または0
。
-
-
-
プロパティの詳細
-
progress
public final ReadOnlyDoubleProperty progressProperty
完了したイメージのロードのおおよそのパーセント値。 0から1までの正の値(0は0%で、1は100%)。- デフォルト値:
- 0
- 関連項目:
getProgress()
-
width
public final ReadOnlyDoubleProperty widthProperty
イメージのロードに失敗した場合のイメージの幅または0
。 イメージがロード中の場合、それは0
に設定されます。- 関連項目:
getWidth()
-
height
public final ReadOnlyDoubleProperty heightProperty
イメージのロードに失敗した場合のイメージの高さまたは0
。 イメージがロード中の場合、それは0
に設定されます。- 関連項目:
getHeight()
-
error
public final ReadOnlyBooleanProperty errorProperty
イメージのロード中にエラーが検出されたかどうかを示します。- デフォルト値:
- false
- 関連項目:
isError()
-
exception
public final ReadOnlyObjectProperty<Exception> exceptionProperty
イメージのロードが失敗する原因となる例外。error
プロパティがtrue
に設定されている場合は、null以外の値のみを含みます。- 導入されたバージョン:
- JavaFX 8.0
- 関連項目:
getException()
-
-
コンストラクタの詳細
-
Image
public Image(String url)
指定されたURLからロードされたコンテンツを使用したImage
を構築します。- パラメータ:
url
- ピクセル・データのフェッチ中に使用するURLを表す文字列- 例外:
NullPointerException
- URLがnullの場合IllegalArgumentException
- URLが無効かサポートされていない場合
-
Image
public Image(String url, boolean backgroundLoading)
指定されたパラメータを使用した新しいImage
を構築します。- パラメータ:
url
- ピクセル・データのフェッチ中に使用するURLを表す文字列backgroundLoading
- イメージがバックグラウンドでロードされるかどうかを示します。- 例外:
NullPointerException
- URLがnullの場合IllegalArgumentException
- URLが無効かサポートされていない場合
-
Image
public Image(String url, double requestedWidth, double requestedHeight, boolean preserveRatio, boolean smooth)
指定されたパラメータを使用した新しいImage
を構築します。- パラメータ:
url
- ピクセル・データのフェッチ中に使用するURLを表す文字列requestedWidth
- イメージの境界ボックスの幅requestedHeight
- イメージの境界ボックスの高さpreserveRatio
- 指定された境界ボックス内でイメージが適合するようにスケーリングするときに、元のイメージの縦横比を維持するかどうかを示します。smooth
- 指定した境界ボックス内に収まるようにこのイメージをスケーリングするときに、より高品質なフィルタリング・アルゴリズムとより高速なフィルタリング・アルゴリズムのどちらを使用するかを示します。- 例外:
NullPointerException
- URLがnullの場合IllegalArgumentException
- URLが無効かサポートされていない場合
-
Image
public Image(String url, double requestedWidth, double requestedHeight, boolean preserveRatio, boolean smooth, boolean backgroundLoading)
指定されたパラメータを使用した新しいImage
を構築します。 スキームのないurlはクラスパスに対して相対的なものとして処理され、スキームのあるurlはスキームに従ってURL.openStream()
を使用して処理されます。- パラメータ:
url
- ピクセル・データのフェッチ中に使用するURLを表す文字列requestedWidth
- イメージの境界ボックスの幅requestedHeight
- イメージの境界ボックスの高さpreserveRatio
- 指定された境界ボックス内でイメージが適合するようにスケーリングするときに、元のイメージの縦横比を維持するかどうかを示します。smooth
- 指定した境界ボックス内に収まるようにこのイメージをスケーリングするときに、より高品質なフィルタリング・アルゴリズムとより高速なフィルタリング・アルゴリズムのどちらを使用するかを示します。backgroundLoading
- イメージがバックグラウンドでロードされるかどうかを示します。- 例外:
NullPointerException
- URLがnullの場合IllegalArgumentException
- URLが無効かサポートされていない場合
-
Image
public Image(InputStream is)
指定された入力ストリームからロードされたコンテンツを使用したImage
を構築します。- パラメータ:
is
- イメージのロード元のストリーム- 例外:
NullPointerException
- 入力ストリームがnullの場合
-
Image
public Image(InputStream is, double requestedWidth, double requestedHeight, boolean preserveRatio, boolean smooth)
指定されたパラメータを使用した新しいImage
を構築します。- パラメータ:
is
- イメージのロード元のストリームrequestedWidth
- イメージの境界ボックスの幅requestedHeight
- イメージの境界ボックスの高さpreserveRatio
- 指定された境界ボックス内でイメージが適合するようにスケーリングするときに、元のイメージの縦横比を維持するかどうかを示します。smooth
- 指定した境界ボックス内に収まるようにこのイメージをスケーリングするときに、より高品質なフィルタリング・アルゴリズムとより高速なフィルタリング・アルゴリズムのどちらを使用するかを示します。- 例外:
NullPointerException
- 入力ストリームがnullの場合
-
-
メソッドの詳細
-
getUrl
public final String getUrl()
コンストラクタで指定されている場合、Imageインスタンスに含まれるピクセル・データを取得するために使用されるURLを返します。 コンストラクタ(たとえば、イメージがInputStream
から構築されている場合)にurlが指定されていない場合、このメソッドはnullを返します。- 戻り値:
- このImageインスタンスのピクセル・データを取得するために使用されるURLを含むString。
- 導入されたバージョン:
- 9
-
getProgress
public final double getProgress()
プロパティprogressの値を取得します。- プロパティの説明:
- 完了したイメージのロードのおおよそのパーセント値。 0から1までの正の値(0は0%で、1は100%)。
- デフォルト値:
- 0
-
progressProperty
public final ReadOnlyDoubleProperty progressProperty()
完了したイメージのロードのおおよそのパーセント値。 0から1までの正の値(0は0%で、1は100%)。- デフォルト値:
- 0
- 関連項目:
getProgress()
-
getRequestedWidth
public final double getRequestedWidth()
境界ボックスの幅を取得します。これに合うように、必要に応じてソース・イメージのサイズが変更されます。 値が<= 0
に設定されている場合は、イメージの固有の幅が使用されます。イメージの
requestedWidth
、requestedHeight
およびpreserveRatio
属性の間の通信の詳細は、preserveRatio
を参照してください。- 戻り値:
- リクエストされた幅
-
getRequestedHeight
public final double getRequestedHeight()
境界ボックスの高さを取得します。これに合うように、必要に応じてソース・イメージのサイズが変更されます。 値が<= 0
に設定されている場合は、イメージの固有の高さが使用されます。イメージの
requestedWidth
、requestedHeight
およびpreserveRatio
属性の間の通信の詳細は、preserveRatio
を参照してください。- 戻り値:
- リクエストされた高さ
-
getWidth
public final double getWidth()
プロパティwidthの値を取得します。- プロパティの説明:
- イメージのロードに失敗した場合のイメージの幅または
0
。 イメージがロード中の場合、それは0
に設定されます。
-
widthProperty
public final ReadOnlyDoubleProperty widthProperty()
イメージのロードに失敗した場合のイメージの幅または0
。 イメージがロード中の場合、それは0
に設定されます。- 関連項目:
getWidth()
-
getHeight
public final double getHeight()
プロパティheightの値を取得します。- プロパティの説明:
- イメージのロードに失敗した場合のイメージの高さまたは
0
。 イメージがロード中の場合、それは0
に設定されます。
-
heightProperty
public final ReadOnlyDoubleProperty heightProperty()
イメージのロードに失敗した場合のイメージの高さまたは0
。 イメージがロード中の場合、それは0
に設定されます。- 関連項目:
getHeight()
-
isPreserveRatio
public final boolean isPreserveRatio()
width
およびheight
で指定した境界ボックス内でイメージが適合するようにスケーリングするときに、元のイメージの縦横比を維持するかどうかを示します。true
に設定されている場合は、このImage
のディメンションに、次のように影響します。-
width
のみが設定されている場合、比率を維持するように高さがスケーリングされます。 -
height
のみが設定されている場合、比率を維持するように幅がスケーリングされます。 - 両方が設定されている場合、元の縦横比を維持しながら、width x heightの矩形に対して最適になるように、それらの両方がスケーリングされることがあります。
width
とheight
を調整する必要があった場合、それらは最初に設定された値とは異なる場合があります。 設定されていないか、false
に設定されている場合は、このImageView
のディメンションに、次のように影響します。-
width
のみが設定されている場合、イメージの幅が一致するようにスケーリングされ、高さは変更されません。 -
height
のみが設定されている場合、イメージの高さが一致するようにスケーリングされ、高さは変更されません。 - 両方が設定されている場合、両方が一致するようにイメージがスケーリングされます。
- 戻り値:
width
とheight
によって指定された境界ボックス内に収まるようにイメージをスケーリングするときに、元のイメージの縦横比を維持する場合はtrue。
-
-
isSmooth
public final boolean isSmooth()
width
とheight
で指定した境界ボックス内に収まるようにこのイメージをスケーリングするときに、より高品質なフィルタリング・アルゴリズムとより高速なフィルタリング・アルゴリズムのどちらを使用するかを示します。初期化されていないか、
true
に設定されている場合は、より高品質なフィルタリングが使用され、それ以外の場合は、より高速ですが比較的低品質なフィルタリングが使用されます。- 戻り値:
width
とheight
で指定された境界ボックス内に収まるようにスケーリングするために、より高品質な(ただし速度の遅い)フィルタリング・アルゴリズムを使用する場合はtrue。
-
isBackgroundLoading
public final boolean isBackgroundLoading()
イメージがバックグラウンドでロードされているかどうかを示します。- 戻り値:
- イメージをバックグラウンドでロードする場合はtrue
-
isError
public final boolean isError()
プロパティerrorの値を取得します。- プロパティの説明:
- イメージのロード中にエラーが検出されたかどうかを示します。
- デフォルト値:
- false
-
errorProperty
public final ReadOnlyBooleanProperty errorProperty()
イメージのロード中にエラーが検出されたかどうかを示します。- デフォルト値:
- false
- 関連項目:
isError()
-
getException
public final Exception getException()
プロパティexceptionの値を取得します。- プロパティの説明:
- イメージのロードが失敗する原因となる例外。
error
プロパティがtrue
に設定されている場合は、null以外の値のみを含みます。 - 導入されたバージョン:
- JavaFX 8.0
-
exceptionProperty
public final ReadOnlyObjectProperty<Exception> exceptionProperty()
イメージのロードが失敗する原因となる例外。error
プロパティがtrue
に設定されている場合は、null以外の値のみを含みます。- 導入されたバージョン:
- JavaFX 8.0
- 関連項目:
getException()
-
cancel
public void cancel()
このイメージのバックグラウンド・ロードを取り消します。このイメージがバックグラウンドでロードされない場合、またはロードがすでに完了している場合は効果がありません。
-
getPixelReader
public final PixelReader getPixelReader()
このメソッドは、イメージが読取り可能な場合に、イメージのピクセルを読み取るアクセスを提供するPixelReader
を返します。 このメソッドでnullが返される場合は、この時点でこのイメージが読取りをサポートしていません。 このメソッドは、イメージがソースからロードされていて、まだ完了していない場合(進行状況がまだ<1.0の場合)、またはエラーがあった場合はnullを返します。 一部のイメージでピクセルの読取りと書込みがサポートされないフォーマットが使用されている場合も、このメソッドでnullが返されます。- 戻り値:
- イメージのピクセル・データを読み取るための
PixelReader
- 導入されたバージョン:
- JavaFX 2.2
-
-