ImageView

java.lang.Object
- Node
- - javafx.scene.image.ImageView

public class ImageView
extends Node

The ImageView is a Node used for painting images loaded with Image class.

This class allows resizing the displayed image (with or without preserving the original aspect ratio) and specifying a viewport into the source image for restricting the pixels displayed by this ImageView.

Example code for displaying images


 import javafx.application.Application;
 import javafx.geometry.Rectangle2D;
 import javafx.scene.Group;
 import javafx.scene.Scene;
 import javafx.scene.image.Image;
 import javafx.scene.image.ImageView;
 import javafx.scene.layout.HBox;
 import javafx.scene.paint.Color;
 import javafx.stage.Stage;

 public class HelloImageView extends Application {

      @Override public void start(Stage stage) {
         // load the image
         Image image = new Image("flower.png");

         // simple displays ImageView the image as is
         ImageView iv1 = new ImageView();
         iv1.setImage(image);

         // resizes the image to have width of 100 while preserving the ratio and using
         // higher quality filtering method; this ImageView is also cached to
         // improve performance
         ImageView iv2 = new ImageView();
         iv2.setImage(image);
         iv2.setFitWidth(100);
         iv2.setPreserveRatio(true);
         iv2.setSmooth(true);
         iv2.setCache(true);

         // defines a viewport into the source image (achieving a "zoom" effect) and
         // displays it rotated
         ImageView iv3 = new ImageView();
         iv3.setImage(image);
         Rectangle2D viewportRect = new Rectangle2D(40, 35, 110, 110);
         iv3.setViewport(viewportRect);
         iv3.setRotate(90);

         Group root = new Group();
         Scene scene = new Scene(root);
         scene.setFill(Color.BLACK);
         HBox box = new HBox();
         box.getChildren().add(iv1);
         box.getChildren().add(iv2);
         box.getChildren().add(iv3);
         root.getChildren().add(box);

         stage.setTitle("ImageView");
         stage.setWidth(415);
         stage.setHeight(200);
         stage.setScene(scene);
         stage.sizeToScene();
         stage.show();
     }

     public static void main(String[] args) {
         Application.launch(args);
     }
 }

The code above produces the following:

A visual rendering of the ImageView example

Since:: JavaFX 2.0

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`DoubleProperty`	`fitHeight` The height of the bounding box within which the source image is resized as necessary to fit.
`DoubleProperty`	`fitWidth` The width of the bounding box within which the source image is resized as necessary to fit.
`<any>`	`image` The `Image` to be painted by this `ImageView`.
`private StringProperty`	`imageUrl` The imageUrl property is set from CSS and then the image property is set from the invalidated method.
`BooleanProperty`	`preserveRatio` Indicates whether to preserve the aspect ratio of the source image when scaling to fit the image within the fitting bounding box.
`BooleanProperty`	`smooth` Indicates whether to use a better quality filtering algorithm or a faster one when transforming or scaling the source image to fit within the bounding box provided by `fitWidth` and `fitHeight`.
`<any>`	`viewport` The rectangular viewport into the image.
`DoubleProperty`	`x` The current x coordinate of the `ImageView` origin.
`DoubleProperty`	`y` The current y coordinate of the `ImageView` origin.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class ImageView.StyleableProperties

Nested Classes
Modifier and Type	Class and Description
`private static class`	`ImageView.StyleableProperties`

Field Summary

Fields
Modifier and Type	Field and Description
`private static java.lang.String`	`DEFAULT_STYLE_CLASS` * Stylesheet Handling * *
`private double`	`destHeight`
`private double`	`destWidth`
`private DoubleProperty`	`fitHeight` The height of the bounding box within which the source image is resized as necessary to fit.
`private DoubleProperty`	`fitWidth` The width of the bounding box within which the source image is resized as necessary to fit.
`private <any>`	`image` The `Image` to be painted by this `ImageView`.
`private StringProperty`	`imageUrl`
`private Image`	`oldImage`
`private AbstractNotifyListener`	`platformImageChangeListener`
`private BooleanProperty`	`preserveRatio` Indicates whether to preserve the aspect ratio of the source image when scaling to fit the image within the fitting bounding box.
`private BooleanProperty`	`smooth` Indicates whether to use a better quality filtering algorithm or a faster one when transforming or scaling the source image to fit within the bounding box provided by `fitWidth` and `fitHeight`.
`static boolean`	`SMOOTH_DEFAULT` Platform-dependent default value of the `smooth` property.
`private boolean`	`validWH`
`private <any>`	`viewport` The rectangular viewport into the image.
`private DoubleProperty`	`x` The current x coordinate of the `ImageView` origin.
`private DoubleProperty`	`y` The current y coordinate of the `ImageView` origin.

Constructor Summary

Constructors
Constructor and Description
`ImageView()` Allocates a new ImageView object.
`ImageView(Image image)` Allocates a new ImageView object using the given image.
`ImageView(java.lang.String url)` Allocates a new ImageView object with image loaded from the specified URL.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private boolean`	`doComputeContains(double localX, double localY)`
`private BaseBounds`	`doComputeGeomBounds(BaseBounds bounds, BaseTransform tx)`
`private NGNode`	`doCreatePeer()`
`private void`	`doUpdatePeer()`
`DoubleProperty`	`fitHeightProperty()` The height of the bounding box within which the source image is resized as necessary to fit.
`DoubleProperty`	`fitWidthProperty()` The width of the bounding box within which the source image is resized as necessary to fit.
`static java.util.List<<any>>`	`getClassCssMetaData()`
`java.util.List<<any>>`	`getCssMetaData()`
`double`	`getFitHeight()` Gets the value of the property fitHeight.
`double`	`getFitWidth()` Gets the value of the property fitWidth.
`Image`	`getImage()` Gets the value of the property image.
`Rectangle2D`	`getViewport()` Gets the value of the property viewport.
`double`	`getX()` Gets the value of the property x.
`double`	`getY()` Gets the value of the property y.
`<any>`	`imageProperty()` The `Image` to be painted by this `ImageView`.
`private StringProperty`	`imageUrlProperty()` The imageUrl property is set from CSS and then the image property is set from the invalidated method.
`private void`	`invalidateWidthHeight()`
`boolean`	`isPreserveRatio()` Gets the value of the property preserveRatio.
`boolean`	`isSmooth()` Gets the value of the property smooth.
`BooleanProperty`	`preserveRatioProperty()` Indicates whether to preserve the aspect ratio of the source image when scaling to fit the image within the fitting bounding box.
`private void`	`recomputeWidthHeight()`
`void`	`setFitHeight(double value)` Sets the value of the property fitHeight.
`void`	`setFitWidth(double value)` Sets the value of the property fitWidth.
`void`	`setImage(Image value)` Sets the value of the property image.
`void`	`setPreserveRatio(boolean value)` Sets the value of the property preserveRatio.
`void`	`setSmooth(boolean value)` Sets the value of the property smooth.
`void`	`setViewport(Rectangle2D value)` Sets the value of the property viewport.
`void`	`setX(double value)` Sets the value of the property x.
`void`	`setY(double value)` Sets the value of the property y.
`BooleanProperty`	`smoothProperty()` Indicates whether to use a better quality filtering algorithm or a faster one when transforming or scaling the source image to fit within the bounding box provided by `fitWidth` and `fitHeight`.
`(package private) void`	`updateViewport()`
`<any>`	`viewportProperty()` The rectangular viewport into the image.
`DoubleProperty`	`xProperty()` The current x coordinate of the `ImageView` origin.
`DoubleProperty`	`yProperty()` The current y coordinate of the `ImageView` origin.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - image
```
public final <any> imageProperty
```
    The Image to be painted by this ImageView.
    
    See Also:
    
    getImage(), setImage(Image)
  - imageUrl
```
private StringProperty imageUrlProperty
```
    The imageUrl property is set from CSS and then the image property is set from the invalidated method. This ensures that the same image isn't reloaded.
  - x
```
public final DoubleProperty xProperty
```
    The current x coordinate of the ImageView origin.
    
    See Also:
    
    getX(), setX(double)
  - y
```
public final DoubleProperty yProperty
```
    The current y coordinate of the ImageView origin.
    
    See Also:
    
    getY(), setY(double)
  - fitWidth
```
public final DoubleProperty fitWidthProperty
```
    The width of the bounding box within which the source image is resized as necessary to fit. If set to a value <= 0, then the intrinsic width of the image will be used as the fitWidth.
    See preserveRatio for information on interaction between image view's fitWidth, fitHeight and preserveRatio attributes.
    
    See Also:
    
    getFitWidth(), setFitWidth(double)
  - fitHeight
```
public final DoubleProperty fitHeightProperty
```
    The height of the bounding box within which the source image is resized as necessary to fit. If set to a value <= 0, then the intrinsic height of the image will be used as the fitHeight.
    See preserveRatio for information on interaction between image view's fitWidth, fitHeight and preserveRatio attributes.
    
    See Also:
    
    getFitHeight(), setFitHeight(double)
  - preserveRatio
```
public final BooleanProperty preserveRatioProperty
```
    Indicates whether to preserve the aspect ratio of the source image when scaling to fit the image within the fitting bounding box.
    If set to true, it affects the dimensions of this ImageView in the following way
    - If only fitWidth is set, height is scaled to preserve ratio
    - If only fitHeight is set, width is scaled to preserve ratio
    - If both are set, they both may be scaled to get the best fit in a width by height rectangle while preserving the original aspect ratio
    If unset or set to false, it affects the dimensions of this ImageView in the following way
    - If only fitWidth is set, image's view width is scaled to match and height is unchanged;
    - If only fitHeight is set, image's view height is scaled to match and height is unchanged;
    - If both are set, the image view is scaled to match both.
    Note that the dimensions of this node as reported by the node's bounds will be equal to the size of the scaled image and is guaranteed to be contained within fitWidth x fitHeight bonding box.
    See Also:
    
    isPreserveRatio(), setPreserveRatio(boolean)
  - smooth
```
public final BooleanProperty smoothProperty
```
    Indicates whether to use a better quality filtering algorithm or a faster one when transforming or scaling the source image to fit within the bounding box provided by fitWidth and fitHeight.
    If set to true a better quality filtering will be used, if set to false a faster but lesser quality filtering will be used.
    
    The default value depends on platform configuration.
    
    See Also:
    
    isSmooth(), setSmooth(boolean)
  - viewport
```
public final <any> viewportProperty
```
    The rectangular viewport into the image. The viewport is specified in the coordinates of the image, prior to scaling or any other transformations.
    If viewport is null, the entire image is displayed. If viewport is non-null, only the portion of the image which falls within the viewport will be displayed. If the image does not fully cover the viewport then any remaining area of the viewport will be empty.
    
    See Also:
    
    getViewport(), setViewport(Rectangle2D)
- Field Detail
  - image
```
private <any> image
```
    The Image to be painted by this ImageView.
  - oldImage
```
private Image oldImage
```
  - imageUrl
```
private StringProperty imageUrl
```
  - platformImageChangeListener
```
private final AbstractNotifyListener platformImageChangeListener
```
  - x
```
private DoubleProperty x
```
    The current x coordinate of the ImageView origin.
  - y
```
private DoubleProperty y
```
    The current y coordinate of the ImageView origin.
  - fitWidth
```
private DoubleProperty fitWidth
```
    The width of the bounding box within which the source image is resized as necessary to fit. If set to a value <= 0, then the intrinsic width of the image will be used as the fitWidth.
    See preserveRatio for information on interaction between image view's fitWidth, fitHeight and preserveRatio attributes.
  - fitHeight
```
private DoubleProperty fitHeight
```
    The height of the bounding box within which the source image is resized as necessary to fit. If set to a value <= 0, then the intrinsic height of the image will be used as the fitHeight.
    See preserveRatio for information on interaction between image view's fitWidth, fitHeight and preserveRatio attributes.
  - preserveRatio
```
private BooleanProperty preserveRatio
```
    Indicates whether to preserve the aspect ratio of the source image when scaling to fit the image within the fitting bounding box.
    If set to true, it affects the dimensions of this ImageView in the following way
    - If only fitWidth is set, height is scaled to preserve ratio
    - If only fitHeight is set, width is scaled to preserve ratio
    - If both are set, they both may be scaled to get the best fit in a width by height rectangle while preserving the original aspect ratio
    If unset or set to false, it affects the dimensions of this ImageView in the following way
    - If only fitWidth is set, image's view width is scaled to match and height is unchanged;
    - If only fitHeight is set, image's view height is scaled to match and height is unchanged;
    - If both are set, the image view is scaled to match both.
    Note that the dimensions of this node as reported by the node's bounds will be equal to the size of the scaled image and is guaranteed to be contained within fitWidth x fitHeight bonding box.
  - smooth
```
private BooleanProperty smooth
```
    Indicates whether to use a better quality filtering algorithm or a faster one when transforming or scaling the source image to fit within the bounding box provided by fitWidth and fitHeight.
    If set to true a better quality filtering will be used, if set to false a faster but lesser quality filtering will be used.
    
    The default value depends on platform configuration.
  - SMOOTH_DEFAULT
```
public static final boolean SMOOTH_DEFAULT
```
    Platform-dependent default value of the smooth property.
  - viewport
```
private <any> viewport
```
    The rectangular viewport into the image. The viewport is specified in the coordinates of the image, prior to scaling or any other transformations.
    If viewport is null, the entire image is displayed. If viewport is non-null, only the portion of the image which falls within the viewport will be displayed. If the image does not fully cover the viewport then any remaining area of the viewport will be empty.
  - destWidth
```
private double destWidth
```
  - destHeight
```
private double destHeight
```
  - validWH
```
private boolean validWH
```
  - DEFAULT_STYLE_CLASS
```
private static final java.lang.String DEFAULT_STYLE_CLASS
```
    * Stylesheet Handling * *
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ImageView
```
public ImageView()
```
    Allocates a new ImageView object.
  - ImageView
```
public ImageView(java.lang.String url)
```
    Allocates a new ImageView object with image loaded from the specified URL.
    The new ImageView(url) has the same effect as new ImageView(new Image(url)).
    
    Parameters:
    
    url - the string representing the URL from which to load the image
    
    Throws:
    
    java.lang.NullPointerException - if URL is null
    
    java.lang.IllegalArgumentException - if URL is invalid or unsupported
    
    Since:
    
    JavaFX 2.1
  - ImageView
```
public ImageView(Image image)
```
    Allocates a new ImageView object using the given image.
    
    Parameters:
    
    image - Image that this ImageView uses
- Method Detail
  - setImage
```
public final void setImage(Image value)
```
    Sets the value of the property image.
  - getImage
```
public final Image getImage()
```
    Gets the value of the property image.
  - imageProperty
```
public final <any> imageProperty()
```
    The Image to be painted by this ImageView.
    
    See Also:
    
    getImage(), setImage(Image)
  - imageUrlProperty
```
private StringProperty imageUrlProperty()
```
    The imageUrl property is set from CSS and then the image property is set from the invalidated method. This ensures that the same image isn't reloaded.
  - setX
```
public final void setX(double value)
```
    Sets the value of the property x.
  - getX
```
public final double getX()
```
    Gets the value of the property x.
  - xProperty
```
public final DoubleProperty xProperty()
```
    The current x coordinate of the ImageView origin.
    
    See Also:
    
    getX(), setX(double)
  - setY
```
public final void setY(double value)
```
    Sets the value of the property y.
  - getY
```
public final double getY()
```
    Gets the value of the property y.
  - yProperty
```
public final DoubleProperty yProperty()
```
    The current y coordinate of the ImageView origin.
    
    See Also:
    
    getY(), setY(double)
  - setFitWidth
```
public final void setFitWidth(double value)
```
    Sets the value of the property fitWidth.
  - getFitWidth
```
public final double getFitWidth()
```
    Gets the value of the property fitWidth.
  - fitWidthProperty
```
public final DoubleProperty fitWidthProperty()
```
    The width of the bounding box within which the source image is resized as necessary to fit. If set to a value <= 0, then the intrinsic width of the image will be used as the fitWidth.
    See preserveRatio for information on interaction between image view's fitWidth, fitHeight and preserveRatio attributes.
    
    See Also:
    
    getFitWidth(), setFitWidth(double)
  - setFitHeight
```
public final void setFitHeight(double value)
```
    Sets the value of the property fitHeight.
  - getFitHeight
```
public final double getFitHeight()
```
    Gets the value of the property fitHeight.
  - fitHeightProperty
```
public final DoubleProperty fitHeightProperty()
```
    The height of the bounding box within which the source image is resized as necessary to fit. If set to a value <= 0, then the intrinsic height of the image will be used as the fitHeight.
    See preserveRatio for information on interaction between image view's fitWidth, fitHeight and preserveRatio attributes.
    
    See Also:
    
    getFitHeight(), setFitHeight(double)
  - setPreserveRatio
```
public final void setPreserveRatio(boolean value)
```
    Sets the value of the property preserveRatio.
  - isPreserveRatio
```
public final boolean isPreserveRatio()
```
    Gets the value of the property preserveRatio.
  - preserveRatioProperty
```
public final BooleanProperty preserveRatioProperty()
```
    Indicates whether to preserve the aspect ratio of the source image when scaling to fit the image within the fitting bounding box.
    If set to true, it affects the dimensions of this ImageView in the following way
    - If only fitWidth is set, height is scaled to preserve ratio
    - If only fitHeight is set, width is scaled to preserve ratio
    - If both are set, they both may be scaled to get the best fit in a width by height rectangle while preserving the original aspect ratio
    If unset or set to false, it affects the dimensions of this ImageView in the following way
    - If only fitWidth is set, image's view width is scaled to match and height is unchanged;
    - If only fitHeight is set, image's view height is scaled to match and height is unchanged;
    - If both are set, the image view is scaled to match both.
    Note that the dimensions of this node as reported by the node's bounds will be equal to the size of the scaled image and is guaranteed to be contained within fitWidth x fitHeight bonding box.
    See Also:
    
    isPreserveRatio(), setPreserveRatio(boolean)
  - setSmooth
```
public final void setSmooth(boolean value)
```
    Sets the value of the property smooth.
  - isSmooth
```
public final boolean isSmooth()
```
    Gets the value of the property smooth.
  - smoothProperty
```
public final BooleanProperty smoothProperty()
```
    Indicates whether to use a better quality filtering algorithm or a faster one when transforming or scaling the source image to fit within the bounding box provided by fitWidth and fitHeight.
    If set to true a better quality filtering will be used, if set to false a faster but lesser quality filtering will be used.
    
    The default value depends on platform configuration.
    
    See Also:
    
    isSmooth(), setSmooth(boolean)
  - setViewport
```
public final void setViewport(Rectangle2D value)
```
    Sets the value of the property viewport.
  - getViewport
```
public final Rectangle2D getViewport()
```
    Gets the value of the property viewport.
  - viewportProperty
```
public final <any> viewportProperty()
```
    The rectangular viewport into the image. The viewport is specified in the coordinates of the image, prior to scaling or any other transformations.
    If viewport is null, the entire image is displayed. If viewport is non-null, only the portion of the image which falls within the viewport will be displayed. If the image does not fully cover the viewport then any remaining area of the viewport will be empty.
    
    See Also:
    
    getViewport(), setViewport(Rectangle2D)
  - doCreatePeer
```
private NGNode doCreatePeer()
```
  - doComputeGeomBounds
```
private BaseBounds doComputeGeomBounds(BaseBounds bounds,
                                       BaseTransform tx)
```
  - invalidateWidthHeight
```
private void invalidateWidthHeight()
```
  - recomputeWidthHeight
```
private void recomputeWidthHeight()
```
  - doComputeContains
```
private boolean doComputeContains(double localX,
                                  double localY)
```
  - getClassCssMetaData
```
public static java.util.List<<any>> getClassCssMetaData()
```
    Returns:
    
    The CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
    
    Since:
    
    JavaFX 8.0
  - getCssMetaData
```
public java.util.List<<any>> getCssMetaData()
```
    Returns:
    
    the CssMetaData associated with this class, which may include the CssMetaData of its super classes.
    
    Since:
    
    JavaFX 8.0
  - updateViewport
```
void updateViewport()
```
  - doUpdatePeer
```
private void doUpdatePeer()
```

Class ImageView

Property Summary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

image

imageUrl

x

y

fitWidth

fitHeight

preserveRatio

smooth

viewport

Field Detail

image

oldImage

imageUrl

platformImageChangeListener

x

y

fitWidth

fitHeight

preserveRatio

smooth

SMOOTH_DEFAULT

viewport

destWidth

destHeight

validWH

DEFAULT_STYLE_CLASS

Constructor Detail

ImageView

ImageView

ImageView

Method Detail

setImage

getImage

imageProperty

imageUrlProperty

setX

getX

xProperty

setY

getY

yProperty

setFitWidth

getFitWidth

fitWidthProperty

setFitHeight

getFitHeight

fitHeightProperty

setPreserveRatio

isPreserveRatio

preserveRatioProperty

setSmooth

isSmooth

smoothProperty

setViewport

getViewport

viewportProperty

doCreatePeer

doComputeGeomBounds

invalidateWidthHeight

recomputeWidthHeight

doComputeContains

getClassCssMetaData

getCssMetaData

updateViewport

doUpdatePeer