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

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	ImageView.StyleableProperties

Field Summary

Modifier and Type	Field and Description
private static final String	DEFAULT_STYLE_CLASS
private double	destHeight
private double	destWidth
private StyleableDoubleProperty	fitHeight The height of the bounding box within which the source image is resized as necessary to fit.
private StyleableDoubleProperty	fitWidth The width of the bounding box within which the source image is resized as necessary to fit.
private ObjectProperty<Image>	image The `Image` to be painted by this `ImageView`.
private StringProperty	imageUrl
private Image	oldImage
private final AbstractNotifyListener	platformImageChangeListener
private StyleableBooleanProperty	preserveRatio Indicates whether to preserve the aspect ratio of the source image when scaling to fit the image within the fitting bounding box.
private StyleableBooleanProperty	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`.
public static final boolean	SMOOTH_DEFAULT Platform-dependent default value of the `smooth` property.
private boolean	validWH
private ObjectProperty<Rectangle2D>	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.

Inherited from javafx.scene.Node:: BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Access	Constructor and Description
public	ImageView() Allocates a new ImageView object.
public	ImageView(String the string representing the URL from which to load the image url) Allocates a new ImageView object with image loaded from the specified URL.
public	ImageView(Image Image that this ImageView uses image) Allocates a new ImageView object using the given image.

Method Summary

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() Hides javafx.scene.Node.doUpdatePeer.
public final DoubleProperty	fitHeightProperty()
public final DoubleProperty	fitWidthProperty()
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the `CssMetaData` getClassCssMetaData() Hides javafx.scene.Node.getClassCssMetaData. Gets the `CssMetaData` associated with this class, which may include the `CssMetaData` of its superclasses.
public List<CssMetaData<? extends Styleable, ?>>	Returns: the CssMetaData associated with this class, which may include the CssMetaData of its super classes. getCssMetaData() Overrides javafx.scene.Node.getCssMetaData. Implements javafx.css.Styleable.getCssMetaData. This method should delegate to `Node#getClassCssMetaData()` so that a Node's CssMetaData can be accessed without the need for reflection.
public final double	getFitHeight()
public final double	getFitWidth()
public final Image	getImage()
public final Rectangle2D	getViewport()
public final double	getX()
public final double	getY()
public final ObjectProperty<Image>	imageProperty()
private StringProperty	imageUrlProperty() The imageUrl property is set from CSS and then the image property is set from the invalidated method.
private void	invalidateWidthHeight()
public final boolean	isPreserveRatio()
public final boolean	isSmooth()
public final BooleanProperty	preserveRatioProperty()
private void	recomputeWidthHeight()
public final void	setFitHeight(double value)
public final void	setFitWidth(double value)
public final void	setImage(Image value)
public final void	setPreserveRatio(boolean value)
public final void	setSmooth(boolean value)
public final void	setViewport(Rectangle2D value)
public final void	setX(double value)
public final void	setY(double value)
public final BooleanProperty	smoothProperty()
pack-priv void	updateViewport()
public final ObjectProperty<Rectangle2D>	viewportProperty()
public final DoubleProperty	xProperty()
public final DoubleProperty	yProperty()

Inherited from javafx.scene.Node:: accessibleHelpProperty accessibleRoleDescriptionProperty accessibleRoleProperty accessibleTextProperty addEventFilter addEventHandler applyCss autosize blendModeProperty boundsInLocalProperty boundsInParentProperty buildEventDispatchChain cacheHintProperty cacheProperty clipProperty computeAreaInScreen contains contains cursorProperty depthTestProperty disabledProperty disableProperty effectiveNodeOrientationProperty effectProperty eventDispatcherProperty executeAccessibleAction fireEvent focusedProperty focusTraversableProperty focusVisibleProperty focusWithinProperty getAccessibleHelp getAccessibleRole getAccessibleRoleDescription getAccessibleText getBaselineOffset getBlendMode getBoundsInLocal getBoundsInParent getCacheHint getClip getContentBias getCursor getDepthTest getEffect getEffectiveNodeOrientation getEventDispatcher getId getInitialCursor getInitialFocusTraversable getInputMethodRequests getLayoutBounds getLayoutX getLayoutY getLocalToParentTransform getLocalToSceneTransform getNodeOrientation getOnContextMenuRequested getOnDragDetected getOnDragDone getOnDragDropped getOnDragEntered getOnDragExited getOnDragOver getOnInputMethodTextChanged getOnKeyPressed getOnKeyReleased getOnKeyTyped getOnMouseClicked getOnMouseDragDone getOnMouseDragEntered getOnMouseDragExited getOnMouseDragged getOnMouseDragOver getOnMouseDragReleased getOnMouseEntered getOnMouseExited getOnMouseMoved getOnMousePressed getOnMouseReleased getOnRotate getOnRotationFinished getOnRotationStarted getOnScroll getOnScrollFinished getOnScrollStarted getOnSwipeDown getOnSwipeLeft getOnSwipeRight getOnSwipeUp getOnTouchMoved getOnTouchPressed getOnTouchReleased getOnTouchStationary getOnZoom getOnZoomFinished getOnZoomStarted getOpacity getParent getProperties getPseudoClassStates getRotate getRotationAxis getScaleX getScaleY getScaleZ getScene getStyle getStyleableParent getStyleClass getTransforms getTranslateX getTranslateY getTranslateZ getTypeSelector getUserData getViewOrder hasProperties hoverProperty idProperty inputMethodRequestsProperty intersects intersects isCache isDisable isDisabled isFocused isFocusTraversable isFocusVisible isFocusWithin isHover isManaged isMouseTransparent isPickOnBounds isPressed isResizable isVisible layoutBoundsProperty layoutXProperty layoutYProperty localToParent localToParent localToParent localToParent localToParent localToParentTransformProperty localToScene localToScene localToScene localToScene localToScene localToScene localToScene localToScene localToScene localToScene localToSceneTransformProperty localToScreen localToScreen localToScreen localToScreen localToScreen lookup lookupAll managedProperty maxHeight maxWidth minHeight minWidth mouseTransparentProperty nodeOrientationProperty notifyAccessibleAttributeChanged onContextMenuRequestedProperty onDragDetectedProperty onDragDoneProperty onDragDroppedProperty onDragEnteredProperty onDragExitedProperty onDragOverProperty onInputMethodTextChangedProperty onKeyPressedProperty onKeyReleasedProperty onKeyTypedProperty onMouseClickedProperty onMouseDragDoneProperty onMouseDragEnteredProperty onMouseDragExitedProperty onMouseDraggedProperty onMouseDragOverProperty onMouseDragReleasedProperty onMouseEnteredProperty onMouseExitedProperty onMouseMovedProperty onMousePressedProperty onMouseReleasedProperty onRotateProperty onRotationFinishedProperty onRotationStartedProperty onScrollFinishedProperty onScrollProperty onScrollStartedProperty onSwipeDownProperty onSwipeLeftProperty onSwipeRightProperty onSwipeUpProperty onTouchMovedProperty onTouchPressedProperty onTouchReleasedProperty onTouchStationaryProperty onZoomFinishedProperty onZoomProperty onZoomStartedProperty opacityProperty parentProperty parentToLocal parentToLocal parentToLocal parentToLocal parentToLocal pickOnBoundsProperty prefHeight prefWidth pressedProperty pseudoClassStateChanged queryAccessibleAttribute relocate removeEventFilter removeEventHandler requestFocus requestFocusTraversal resize resizeRelocate rotateProperty rotationAxisProperty scaleXProperty scaleYProperty scaleZProperty sceneProperty sceneToLocal sceneToLocal sceneToLocal sceneToLocal sceneToLocal sceneToLocal sceneToLocal sceneToLocal screenToLocal screenToLocal screenToLocal setAccessibleHelp setAccessibleRole setAccessibleRoleDescription setAccessibleText setBlendMode setCache setCacheHint setClip setCursor setDepthTest setDisable setDisabled setEffect setEventDispatcher setEventHandler setFocused setFocusTraversable setHover setId setInputMethodRequests setLayoutX setLayoutY setManaged setMouseTransparent setNodeOrientation setOnContextMenuRequested setOnDragDetected setOnDragDone setOnDragDropped setOnDragEntered setOnDragExited setOnDragOver setOnInputMethodTextChanged setOnKeyPressed setOnKeyReleased setOnKeyTyped setOnMouseClicked setOnMouseDragDone setOnMouseDragEntered setOnMouseDragExited setOnMouseDragged setOnMouseDragOver setOnMouseDragReleased setOnMouseEntered setOnMouseExited setOnMouseMoved setOnMousePressed setOnMouseReleased setOnRotate setOnRotationFinished setOnRotationStarted setOnScroll setOnScrollFinished setOnScrollStarted setOnSwipeDown setOnSwipeLeft setOnSwipeRight setOnSwipeUp setOnTouchMoved setOnTouchPressed setOnTouchReleased setOnTouchStationary setOnZoom setOnZoomFinished setOnZoomStarted setOpacity setPickOnBounds setPressed setRotate setRotationAxis setScaleX setScaleY setScaleZ setStyle setTranslateX setTranslateY setTranslateZ setUserData setViewOrder setVisible snapshot snapshot startDragAndDrop startFullDrag styleProperty toBack toFront toString translateXProperty translateYProperty translateZProperty usesMirroring viewOrderProperty visibleProperty

Field Detail

DEFAULT_STYLE_CLASS	back to summary
private static final String DEFAULT_STYLE_CLASS

destHeight	back to summary
private double destHeight

destWidth	back to summary
private double destWidth

fitHeight back to summary

fitHeight	back to summary
private StyleableDoubleProperty 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. Default Value 0

private StyleableDoubleProperty 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.

Default Value: 0

fitWidth back to summary

fitWidth	back to summary
private StyleableDoubleProperty 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. Default Value 0

private StyleableDoubleProperty 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.

Default Value: 0

image back to summary

image	back to summary
private ObjectProperty<Image> image The `Image` to be painted by this `ImageView`. Default Value null

private ObjectProperty<Image> image

The Image to be painted by this ImageView.

Default Value: null

imageUrl	back to summary
private StringProperty imageUrl

oldImage	back to summary
private Image oldImage

platformImageChangeListener	back to summary
private final AbstractNotifyListener platformImageChangeListener

preserveRatio back to summary

preserveRatio	back to summary
private StyleableBooleanProperty 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. Default Value false

private StyleableBooleanProperty 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.

Default Value: false

smooth back to summary

smooth	back to summary
private StyleableBooleanProperty 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. Default Value platform-dependent

private StyleableBooleanProperty 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.

Default Value: platform-dependent

SMOOTH_DEFAULT	back to summary
public static final boolean SMOOTH_DEFAULT Platform-dependent default value of the `smooth` property.

validWH	back to summary
private boolean validWH

viewport back to summary

viewport	back to summary
private ObjectProperty<Rectangle2D> 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. Default Value null

private ObjectProperty<Rectangle2D> 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.

Default Value: null

x back to summary

x	back to summary
private DoubleProperty x The current x coordinate of the `ImageView` origin. Default Value 0

private DoubleProperty x

The current x coordinate of the ImageView origin.

Default Value: 0

y back to summary

y	back to summary
private DoubleProperty y The current y coordinate of the `ImageView` origin. Default Value 0

private DoubleProperty y

The current y coordinate of the ImageView origin.

Default Value: 0

Constructor Detail

ImageView	back to summary
public ImageView() Allocates a new ImageView object.

ImageView back to summary

ImageView	back to summary
public ImageView(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:String the string representing the URL from which to load the image Exceptions NullPointerException: if URL is null IllegalArgumentException: if URL is invalid or unsupported Since JavaFX 2.1

public ImageView(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:String: the string representing the URL from which to load the image

Exceptions

NullPointerException:: if URL is null
IllegalArgumentException:: if URL is invalid or unsupported

Since

JavaFX 2.1

ImageView	back to summary
public ImageView(Image image) Allocates a new ImageView object using the given image. Parameters image:Image Image that this ImageView uses

ImageView

back to summary

public ImageView(Image image)

Allocates a new ImageView object using the given image.

Parameters

image:Image: Image that this ImageView uses

Method Detail

doComputeContains	back to summary
private boolean doComputeContains(double localX, double localY)

doComputeGeomBounds	back to summary
private BaseBounds doComputeGeomBounds(BaseBounds bounds, BaseTransform tx)

doCreatePeer	back to summary
private NGNode doCreatePeer()

doUpdatePeer	back to summary
private void doUpdatePeer() Hides javafx.scene.Node.doUpdatePeer.

fitHeightProperty	back to summary
public final DoubleProperty fitHeightProperty()

fitWidthProperty	back to summary
public final DoubleProperty fitWidthProperty()

getClassCssMetaData back to summary

public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

Hides javafx.scene.Node.getClassCssMetaData.

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Returns:List<CssMetaData<? extends Styleable, ?>>: the CssMetaData
Since: JavaFX 8.0

getCssMetaData back to summary

public List<CssMetaData<? extends Styleable, ?>> getCssMetaData()

Overrides javafx.scene.Node.getCssMetaData.

Implements javafx.css.Styleable.getCssMetaData.

Doc from javafx.scene.Node.getCssMetaData.

This method should delegate to Node#getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

Returns:List<CssMetaData<? extends Styleable, ?>>

the CssMetaData associated with this class, which may include the CssMetaData of its super classes.

Annotations

@Override

Since

JavaFX 8.0

getFitHeight	back to summary
public final double getFitHeight()

getFitWidth	back to summary
public final double getFitWidth()

getImage	back to summary
public final Image getImage()

getViewport	back to summary
public final Rectangle2D getViewport()

getX	back to summary
public final double getX()

getY	back to summary
public final double getY()

imageProperty	back to summary
public final ObjectProperty<Image> imageProperty()

imageUrlProperty	back to summary
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.

invalidateWidthHeight	back to summary
private void invalidateWidthHeight()

isPreserveRatio	back to summary
public final boolean isPreserveRatio()

isSmooth	back to summary
public final boolean isSmooth()

preserveRatioProperty	back to summary
public final BooleanProperty preserveRatioProperty()

recomputeWidthHeight	back to summary
private void recomputeWidthHeight()

setFitHeight	back to summary
public final void setFitHeight(double value)

setFitWidth	back to summary
public final void setFitWidth(double value)

setImage	back to summary
public final void setImage(Image value)

setPreserveRatio	back to summary
public final void setPreserveRatio(boolean value)

setSmooth	back to summary
public final void setSmooth(boolean value)

setViewport	back to summary
public final void setViewport(Rectangle2D value)

setX	back to summary
public final void setX(double value)

setY	back to summary
public final void setY(double value)

smoothProperty	back to summary
public final BooleanProperty smoothProperty()

updateViewport	back to summary
pack-priv void updateViewport()

viewportProperty	back to summary
public final ObjectProperty<Rectangle2D> viewportProperty()

xProperty	back to summary
public final DoubleProperty xProperty()

yProperty	back to summary
public final DoubleProperty yProperty()

javafx.scene.image back to summary

private Class ImageView.StyleableProperties

Class Inheritance

extends Object

java.lang.Object
javafx.scene.image.ImageView.StyleableProperties

Field Summary

Modifier and Type	Field and Description
private static final CssMetaData<ImageView, Number>	FIT_HEIGHT
private static final CssMetaData<ImageView, Number>	FIT_WIDTH
private static final CssMetaData<ImageView, String>	IMAGE
private static final CssMetaData<ImageView, Boolean>	PRESERVE_RATIO
private static final CssMetaData<ImageView, Boolean>	SMOOTH
private static final List<CssMetaData<? extends Styleable, ?>>	STYLEABLES

Constructor Summary

Access	Constructor and Description
private	StyleableProperties()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

FIT_HEIGHT	back to summary
private static final CssMetaData<ImageView, Number> FIT_HEIGHT

FIT_WIDTH	back to summary
private static final CssMetaData<ImageView, Number> FIT_WIDTH

IMAGE	back to summary
private static final CssMetaData<ImageView, String> IMAGE

PRESERVE_RATIO	back to summary
private static final CssMetaData<ImageView, Boolean> PRESERVE_RATIO

SMOOTH	back to summary
private static final CssMetaData<ImageView, Boolean> SMOOTH

STYLEABLES	back to summary
private static final List<CssMetaData<? extends Styleable, ?>> STYLEABLES

Constructor Detail

StyleableProperties	back to summary
private StyleableProperties()

public non-sealed Class ImageView

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ImageView.StyleableProperties

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail