class: Image

[13:7] extends: FxObj

Wraps JavaFX Image, a container that loads and decodes a raster image from a URL or a local file path for use in ImageView and other visual nodes. When the provided path starts with http:// or https://, the image is fetched directly from the network. Otherwise the file is read from the local file system and streamed into the JavaFX image loader. The resulting object can be assigned to any JavaFX node that accepts an Image.

Methods

Image (string FileName)

Initializes a new Image instance with the specified file path or URL. If a URL is provided, the image is loaded directly from the web; otherwise, a local file is loaded.
- @p FileName The path or URL of the image to be loaded.
- @r this object
getUrl ()

Returns the URL string the image was loaded from, or null when the image was loaded directly from an input stream.
- @r A string with the source URL, or null.
getProgress ()

Returns the current loading progress as a value between 0.0 and 1.0. For background-loaded images this advances while loading; for synchronously loaded images it is always 1.0 after construction.
- @r A double between 0.0 and 1.0.
progressProperty ()

Returns the read-only progress property for binding or change listeners while a background-loaded image is decoding.
- @r An AussomJavaObject wrapping a ReadOnlyDoubleProperty.
getRequestedWidth ()

Returns the width that was requested when the image was created. A value of 0 means the image was loaded at its native width.
- @r A double with the requested width in pixels.
getRequestedHeight ()

Returns the height that was requested when the image was created. A value of 0 means the image was loaded at its native height.
- @r A double with the requested height in pixels.
getWidth ()

Returns the actual decoded image width in pixels. Will be 0 while a background-loaded image is still loading.
- @r A double with the image width in pixels.
widthProperty ()

Returns the read-only width property for binding or change listeners.
- @r An AussomJavaObject wrapping a ReadOnlyDoubleProperty.
getHeight ()

Returns the actual decoded image height in pixels. Will be 0 while a background-loaded image is still loading.
- @r A double with the image height in pixels.
heightProperty ()

Returns the read-only height property for binding or change listeners.
- @r An AussomJavaObject wrapping a ReadOnlyDoubleProperty.
isPreserveRatio ()

Returns whether the image preserves its aspect ratio when it is scaled to a different requested width or height.
- @r A bool that is true when aspect ratio is preserved.
isSmooth ()

Returns whether the image is loaded with smooth filtering enabled, trading load time for better resampling quality.
- @r A bool that is true when smooth filtering is enabled.
isBackgroundLoading ()

Returns whether the image was created with background loading enabled, meaning decoding happens on a background thread.
- @r A bool that is true when background loading is enabled.
isError ()

Returns whether an error occurred while loading or decoding the image. Pair with getException() to read the underlying failure.
- @r A bool that is true when the image failed to load.
errorProperty ()

Returns the read-only error property used to observe load failures.
- @r An AussomJavaObject wrapping a ReadOnlyBooleanProperty.
getException ()

Returns the Exception captured when the image failed to load, or null when no error has occurred.
- @r An AussomJavaObject wrapping the Exception, or null.
exceptionProperty ()

Returns the read-only exception property used to observe load failures.
- @r An AussomJavaObject wrapping a ReadOnlyObjectProperty of Exception.
cancel ()

Cancels background loading of the image when it is still in progress. Has no effect if loading has already completed.
- @r this object for chaining
getPixelReader ()

Returns a PixelReader for reading individual pixel data from the image. Returns null when the image is not yet fully loaded.
- @r An AussomJavaObject wrapping a javafx.scene.image.PixelReader, or null.