Class ImageInput

java.lang.Object

javafx.scene.effect.Effect

javafx.scene.effect.ImageInput

public class ImageInput extends Effect

A type of source effect that simply passes the given Image through, unmodified, as an input to another Effect.

Since:: JavaFX 2.0

Property Summary

Type	Property	Description
`final ObjectProperty<Image>`	`source`	The source `Image`.
`final DoubleProperty`	`x`	Sets the x location of the source image, relative to the local coordinate space of the content `Node`.
`final DoubleProperty`	`y`	Sets the y location of the source image, relative to the local coordinate space of the content `Node`.

Constructor Summary

Constructor	Description
`ImageInput()`	Creates a new instance of ImageInput with default parameters.
`ImageInput(Image source)`	Creates a new instance of ImageInput with the specified source.
`ImageInput(Image source, double x, double y)`	Creates a new instance of ImageInput with the specified source, x and y.

Method Summary

Modifier and Type	Method	Description
`final Image`	`getSource()`	Gets the value of the `source` property.
`final double`	`getX()`	Gets the value of the `x` property.
`final double`	`getY()`	Gets the value of the `y` property.
`final void`	`setSource(Image value)`	Sets the value of the `source` 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 ObjectProperty<Image>`	`sourceProperty()`	The source `Image`.
`final DoubleProperty`	`xProperty()`	Sets the x location of the source image, relative to the local coordinate space of the content `Node`.
`final DoubleProperty`	`yProperty()`	Sets the y location of the source image, relative to the local coordinate space of the content `Node`.

Methods declared in class java.lang.Object

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

Property Details

source

public final ObjectProperty<Image> sourceProperty

The source Image.

See Also:

getSource()
setSource(Image)
sourceProperty()

x

public final DoubleProperty xProperty

Sets the x location of the source image, relative to the local coordinate space of the content Node.

       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0

Default value:

0.0

See Also:

getX()
setX(double)
xProperty()

y

public final DoubleProperty yProperty

Sets the y location of the source image, relative to the local coordinate space of the content Node.

       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0

Default value:

0.0

See Also:

getY()
setY(double)
yProperty()

Constructor Details

ImageInput

public ImageInput()

Creates a new instance of ImageInput with default parameters.

ImageInput

public ImageInput(Image source)

Creates a new instance of ImageInput with the specified source.

Parameters:: source - the source Image.
Since:: JavaFX 2.1

ImageInput

public ImageInput(Image source, double x, double y)

Creates a new instance of ImageInput with the specified source, x and y.

Parameters:: source - the source Image.; x - the x location of the source image; y - the y location of the source image
Since:: JavaFX 2.1

Method Details

setSource

public final void setSource(Image value)

Sets the value of the source property.

Property description:

The source Image.

Parameters:

value - the value for the source property

See Also:

getSource()
sourceProperty()

getSource

public final Image getSource()

Gets the value of the source property.

Property description:

The source Image.

Returns:

the value of the source property

See Also:

setSource(Image)
sourceProperty()

sourceProperty

public final ObjectProperty<Image> sourceProperty()

The source Image.

Returns:

the source property

See Also:

getSource()
setSource(Image)

setX

public final void setX(double value)

Sets the value of the x property.

Property description:

Sets the x location of the source image, relative to the local coordinate space of the content Node.

       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0

Default value:

0.0

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:

Sets the x location of the source image, relative to the local coordinate space of the content Node.

       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0

Default value:

0.0

Returns:

the value of the x property

See Also:

setX(double)
xProperty()

xProperty

public final DoubleProperty xProperty()

Sets the x location of the source image, relative to the local coordinate space of the content Node.

       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0

Default value:

0.0

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:

Sets the y location of the source image, relative to the local coordinate space of the content Node.

       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0

Default value:

0.0

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:

Sets the y location of the source image, relative to the local coordinate space of the content Node.

       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0

Default value:

0.0

Returns:

the value of the y property

See Also:

setY(double)
yProperty()

yProperty

public final DoubleProperty yProperty()

Sets the y location of the source image, relative to the local coordinate space of the content Node.

       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0

Default value:

0.0

Returns:

the y property

See Also:

getY()
setY(double)

© 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.