Class ImageView

java.lang.Object

javafx.scene.Node

javafx.scene.image.ImageView

All Implemented Interfaces:: Styleable, EventTarget

@DefaultProperty("image") 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

Type	Property	Description
`final DoubleProperty`	`fitHeight`	The height of the bounding box within which the source image is resized as necessary to fit.
`final DoubleProperty`	`fitWidth`	The width of the bounding box within which the source image is resized as necessary to fit.
`final ObjectProperty<Image>`	`image`	The `Image` to be painted by this `ImageView`.
`final BooleanProperty`	`preserveRatio`	Indicates whether to preserve the aspect ratio of the source image when scaling to fit the image within the fitting bounding box.
`final 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`.
`final ObjectProperty<Rectangle2D>`	`viewport`	The rectangular viewport into the image.
`final DoubleProperty`	`x`	The current x coordinate of the `ImageView` origin.
`final DoubleProperty`	`y`	The current y coordinate of the `ImageView` origin.

Properties declared in class javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

Field Summary

Modifier and Type	Field	Description
`static final boolean`	`SMOOTH_DEFAULT`	Platform-dependent default value of the `smooth` property.

Fields declared in class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

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

Method Summary

Modifier and Type	Method	Description
`final DoubleProperty`	`fitHeightProperty()`	The height of the bounding box within which the source image is resized as necessary to fit.
`final DoubleProperty`	`fitWidthProperty()`	The width of the bounding box within which the source image is resized as necessary to fit.
`static List<CssMetaData<? extends Styleable,?>>`	`getClassCssMetaData()`	Gets the `CssMetaData` associated with this class, which may include the `CssMetaData` of its superclasses.
`List<CssMetaData<? extends Styleable,?>>`	`getCssMetaData()`	This method should delegate to `Node.getClassCssMetaData()` so that a Node's CssMetaData can be accessed without the need for reflection.
`final double`	`getFitHeight()`	Gets the value of the `fitHeight` property.
`final double`	`getFitWidth()`	Gets the value of the `fitWidth` property.
`final Image`	`getImage()`	Gets the value of the `image` property.
`final Rectangle2D`	`getViewport()`	Gets the value of the `viewport` property.
`final double`	`getX()`	Gets the value of the `x` property.
`final double`	`getY()`	Gets the value of the `y` property.
`final ObjectProperty<Image>`	`imageProperty()`	The `Image` to be painted by this `ImageView`.
`final boolean`	`isPreserveRatio()`	Gets the value of the `preserveRatio` property.
`final boolean`	`isSmooth()`	Gets the value of the `smooth` property.
`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.
`final void`	`setFitHeight(double value)`	Sets the value of the `fitHeight` property.
`final void`	`setFitWidth(double value)`	Sets the value of the `fitWidth` property.
`final void`	`setImage(Image value)`	Sets the value of the `image` property.
`final void`	`setPreserveRatio(boolean value)`	Sets the value of the `preserveRatio` property.
`final void`	`setSmooth(boolean value)`	Sets the value of the `smooth` property.
`final void`	`setViewport(Rectangle2D value)`	Sets the value of the `viewport` property.
`final void`	`setX(double value)`	Sets the value of the `x` property.
`final void`	`setY(double value)`	Sets the value of the `y` property.
`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`.
`final ObjectProperty<Rectangle2D>`	`viewportProperty()`	The rectangular viewport into the image.
`final DoubleProperty`	`xProperty()`	The current x coordinate of the `ImageView` origin.
`final DoubleProperty`	`yProperty()`	The current y coordinate of the `ImageView` origin.

Methods declared in class 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, 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, 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, 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, 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

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods declared in interface javafx.css.Styleable

getStyleableNode

Property Details

image

public final ObjectProperty<Image> imageProperty

The Image to be painted by this ImageView.

Default value:

null

See Also:

getImage()
setImage(Image)
imageProperty()

x

public final DoubleProperty xProperty

The current x coordinate of the ImageView origin.

Default value:

See Also:

getX()
setX(double)
xProperty()

y

public final DoubleProperty yProperty

The current y coordinate of the ImageView origin.

Default value:

See Also:

getY()
setY(double)
yProperty()

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.

Default value:

See Also:

getFitWidth()
setFitWidth(double)
fitWidthProperty()

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.

Default value:

See Also:

getFitHeight()
setFitHeight(double)
fitHeightProperty()

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.

Default value:

false

See Also:

isPreserveRatio()
setPreserveRatio(boolean)
preserveRatioProperty()

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.

Default value:

platform-dependent

See Also:

isSmooth()
setSmooth(boolean)
smoothProperty()

viewport

public final ObjectProperty<Rectangle2D> 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.

Default value:

null

See Also:

getViewport()
setViewport(Rectangle2D)
viewportProperty()

Field Details

SMOOTH_DEFAULT

public static final boolean SMOOTH_DEFAULT

Platform-dependent default value of the smooth property.

Constructor Details

ImageView

public ImageView()

Allocates a new ImageView object.

ImageView

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 - the string representing the URL from which to load the image
Throws:: NullPointerException - if URL is null; 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 Details

setImage

public final void setImage(Image value)

Sets the value of the image property.

Property description:

The Image to be painted by this ImageView.

Default value:

null

Parameters:

value - the value for the image property

See Also:

getImage()
imageProperty()

getImage

public final Image getImage()

Gets the value of the image property.

Property description:

The Image to be painted by this ImageView.

Default value:

null

Returns:

the value of the image property

See Also:

setImage(Image)
imageProperty()

imageProperty

public final ObjectProperty<Image> imageProperty()

The Image to be painted by this ImageView.

Default value:

null

Returns:

the image property

See Also:

getImage()
setImage(Image)

setX

public final void setX(double value)

Sets the value of the x property.

Property description:

The current x coordinate of the ImageView origin.

Default value:

Parameters:

value - the value for the x property

See Also:

getX()
xProperty()

getX

public final double getX()

Gets the value of the x property.

Property description:

The current x coordinate of the ImageView origin.

Default value:

Returns:

the value of the x property

See Also:

setX(double)
xProperty()

xProperty

public final DoubleProperty xProperty()

The current x coordinate of the ImageView origin.

Default value:

Returns:

the x property

See Also:

getX()
setX(double)

setY

public final void setY(double value)

Sets the value of the y property.

Property description:

The current y coordinate of the ImageView origin.

Default value:

Parameters:

value - the value for the y property

See Also:

getY()
yProperty()

getY

public final double getY()

Gets the value of the y property.

Property description:

The current y coordinate of the ImageView origin.

Default value:

Returns:

the value of the y property

See Also:

setY(double)
yProperty()

yProperty

public final DoubleProperty yProperty()

The current y coordinate of the ImageView origin.

Default value:

Returns:

the y property

See Also:

getY()
setY(double)

setFitWidth

public final void setFitWidth(double value)

Sets the value of the fitWidth property.

Property description:

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:

Parameters:

value - the value for the fitWidth property

See Also:

getFitWidth()
fitWidthProperty()

getFitWidth

public final double getFitWidth()

Gets the value of the fitWidth property.

Property description:

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:

Returns:

the value of the fitWidth property

See Also:

setFitWidth(double)
fitWidthProperty()

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.

Default value:

Returns:

the fitWidth property

See Also:

getFitWidth()
setFitWidth(double)

setFitHeight

public final void setFitHeight(double value)

Sets the value of the fitHeight property.

Property description:

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:

Parameters:

value - the value for the fitHeight property

See Also:

getFitHeight()
fitHeightProperty()

getFitHeight

public final double getFitHeight()

Gets the value of the fitHeight property.

Property description:

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:

Returns:

the value of the fitHeight property

See Also:

setFitHeight(double)
fitHeightProperty()

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.

Default value:

Returns:

the fitHeight property

See Also:

getFitHeight()
setFitHeight(double)

setPreserveRatio

public final void setPreserveRatio(boolean value)

Sets the value of the preserveRatio property.

Property description:

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

Parameters:

value - the value for the preserveRatio property

See Also:

isPreserveRatio()
preserveRatioProperty()

isPreserveRatio

public final boolean isPreserveRatio()

Gets the value of the preserveRatio property.

Property description:

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

Returns:

the value of the preserveRatio property

See Also:

setPreserveRatio(boolean)
preserveRatioProperty()

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.

Default value:

false

Returns:

the preserveRatio property

See Also:

isPreserveRatio()
setPreserveRatio(boolean)

setSmooth

public final void setSmooth(boolean value)

Sets the value of the smooth property.

Property description:

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

Parameters:

value - the value for the smooth property

See Also:

isSmooth()
smoothProperty()

isSmooth

public final boolean isSmooth()

Gets the value of the smooth property.

Property description:

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

Returns:

the value of the smooth property

See Also:

setSmooth(boolean)
smoothProperty()

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.

Default value:

platform-dependent

Returns:

the smooth property

See Also:

isSmooth()
setSmooth(boolean)

setViewport

public final void setViewport(Rectangle2D value)

Sets the value of the viewport property.

Property description:

The rectangular viewport into the image. The viewport is specified in the coordinates of the image, prior to scaling or any other transformations.

Default value:

null

Parameters:

value - the value for the viewport property

See Also:

getViewport()
viewportProperty()

getViewport

public final Rectangle2D getViewport()

Gets the value of the viewport property.

Property description:

The rectangular viewport into the image. The viewport is specified in the coordinates of the image, prior to scaling or any other transformations.

Default value:

null

Returns:

the value of the viewport property

See Also:

setViewport(Rectangle2D)
viewportProperty()

viewportProperty

public final ObjectProperty<Rectangle2D> viewportProperty()

The rectangular viewport into the image. The viewport is specified in the coordinates of the image, prior to scaling or any other transformations.

Default value:

null

Returns:

the viewport property

See Also:

getViewport()
setViewport(Rectangle2D)

getClassCssMetaData

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

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

Returns:: the CssMetaData
Since:: JavaFX 8.0

getCssMetaData

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

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

Specified by:: getCssMetaData in interface Styleable
Overrides:: getCssMetaData in class Node
Returns:: the CssMetaData associated with this class, which may include the CssMetaData of its super classes.
Since:: JavaFX 8.0

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.