scalafx
API
Generated with
scalafx/scalafx/scalafx.scene/scalafx.scene.image/Image

Image

scalafx.scene.image.Image
See theImage companion object
class Image(val delegate: Image) extends SFXDelegate[Image]

Attributes

Companion
object
Graph
Supertypes
trait SFXDelegate[Image]
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Constructors

def this(inputStream: InputStream)

Construct an Image which pixels are loaded from the specified input stream.

Construct an Image which pixels are loaded from the specified input stream.

Attributes

def this(inputStream: InputStream, requestedWidth: Double, requestedHeight: Double, preserveRatio: Boolean, smooth: Boolean)

Construct a new Image with the specified parameters.

Construct a new Image with the specified parameters.

Attributes

def this(url: String)

Construct an Image which pixels are loaded from the specified url.

Construct an Image which pixels are loaded from the specified url.

Attributes

def this(url: String, backgroundLoading: Boolean)

Construct a new Image with the specified parameters.

Construct a new Image with the specified parameters.

Attributes

def this(url: String, requestedWidth: Double, requestedHeight: Double, preserveRatio: Boolean, smooth: Boolean)

Construct a new Image with the specified parameters.

Construct a new Image with the specified parameters.

Attributes

def this(url: String, requestedWidth: Double, requestedHeight: Double, preserveRatio: Boolean, smooth: Boolean, backgroundLoading: Boolean)

Construct a new Image with the specified parameters.

Construct a new Image with the specified parameters.

Attributes

def this(that: AnyRef, imagePath: String)

Attributes

Concrete methods

def backgroundLoading: Boolean

Indicates whether the image is being loaded in the background.

Indicates whether the image is being loaded in the background.

Attributes

def cancel(): Unit

Cancels the background loading of this image.

Cancels the background loading of this image.

Attributes

def error: ReadOnlyBooleanProperty

Indicates whether an error was detected while loading an image.

Indicates whether an error was detected while loading an image.

Attributes

def exception: ReadOnlyObjectProperty[Exception]

The exception which caused image loading to fail.

The exception which caused image loading to fail.

Attributes

def height: ReadOnlyDoubleProperty

The image height or 0 if the image loading fails.

The image height or 0 if the image loading fails.

Attributes

def pixelReader: Option[PixelReader]

This method returns a Option of scalafx.scene.image.PixelReader that provides access to read the pixels of the image, if the image is readable.

This method returns a Option of scalafx.scene.image.PixelReader that provides access to read the pixels of the image, if the image is readable.

Attributes

def preserveRatio: Boolean

Indicates whether to preserve the aspect ratio of the original image when scaling to fit the image within the bounding box provided by width and height.

Indicates whether to preserve the aspect ratio of the original image when scaling to fit the image within the bounding box provided by width and height.

Attributes

def progress: ReadOnlyDoubleProperty

The approximate percentage of image's loading that has been completed.

The approximate percentage of image's loading that has been completed.

Attributes

def smooth: Boolean

Indicates whether to use a better quality filtering algorithm or a faster one when scaling this image to fit within the bounding box provided by width and height.

Indicates whether to use a better quality filtering algorithm or a faster one when scaling this image to fit within the bounding box provided by width and height.

Attributes

def width: ReadOnlyDoubleProperty

The image width or 0 if the image loading fails.

The image width or 0 if the image loading fails.

Attributes

Inherited methods

override def equals(ref: Any): Boolean

Verifies if a object is equals to this delegate.

Verifies if a object is equals to this delegate.

Value parameters

ref

Object to be compared.

Attributes

Returns

if the other object is equals to this delegate or not.

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate
override def hashCode: Int

Attributes

Returns

The delegate hashcode

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate
override def toString: String

Attributes

Returns

Returns the original delegate's toString() adding a [SFX] prefix.

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate

Concrete fields

override val delegate: Image

JavaFX object to be wrapped.

JavaFX object to be wrapped.

Attributes

Generated with