APIdia Launch Partner
Top Description Fields Constructors Methods
javafx.scene.effect

public Class ImageInput

extends Effect
Class Inheritance
Imports
javafx.beans.Observable, javafx.beans.property.DoubleProperty, .DoublePropertyBase, .ObjectProperty, .ObjectPropertyBase, javafx.scene.Node, javafx.scene.image.Image, com.sun.javafx.beans.event.AbstractNotifyListener, com.sun.javafx.effect.EffectDirtyBits, com.sun.javafx.geom.BaseBounds, .RectBounds, com.sun.javafx.geom.transform.BaseTransform, com.sun.javafx.scene.BoundsAccessor, com.sun.javafx.tk.Toolkit
A type of source effect that simply passes the given Image through, unmodified, as an input to another Effect.
Since
JavaFX 2.0

Field Summary

Modifier and TypeField and Description
private Image
oldImage

private final AbstractNotifyListener
platformImageChangeListener

private ObjectProperty<Image>
source

The source Image.

private DoubleProperty
x

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

private DoubleProperty
y

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

Constructor Summary

AccessConstructor and Description
public
ImageInput()

Creates a new instance of ImageInput with default parameters.

public
ImageInput(Image
the source Image.
source)

Creates a new instance of ImageInput with the specified source.

public
ImageInput(Image
the source Image.
source, double
the x location of the source image
x, double
the y location of the source image
y)

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

Method Summary

Modifier and TypeMethod and Description
pack-priv boolean
checkChainContains(Effect e)

Implements abstract javafx.scene.effect.Effect.checkChainContains.

pack-priv Effect
copy()

Implements abstract javafx.scene.effect.Effect.copy.

pack-priv Identity
createPeer()

Implements abstract javafx.scene.effect.Effect.createPeer.

pack-priv BaseBounds
getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor)

Implements abstract javafx.scene.effect.Effect.getBounds.

Returns bounds of given node with applied effect.

public final Image
getSource()

public final double
getX()

public final double
getY()

public final void
setSource(Image value)

public final void
setX(double value)

public final void
setY(double value)

public final ObjectProperty<Image>
sourceProperty()

pack-priv void
update()

Implements abstract javafx.scene.effect.Effect.update.

public final DoubleProperty
xProperty()

public final DoubleProperty
yProperty()

Inherited from javafx.scene.effect.Effect:
containsCycleseffectBoundsChangedgetInputBoundsgetKernelSizegetPeergetShadowBoundsmarkDirtysynctransformBounds

Field Detail

oldImageback to summary
private Image oldImage
platformImageChangeListenerback to summary
private final AbstractNotifyListener platformImageChangeListener
sourceback to summary
private ObjectProperty<Image> source

The source Image.

xback to summary
private DoubleProperty x

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
yback to summary
private DoubleProperty y

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

Constructor Detail

ImageInputback to summary
public ImageInput()

Creates a new instance of ImageInput with default parameters.

ImageInputback to summary
public ImageInput(Image source)

Creates a new instance of ImageInput with the specified source.

Parameters
source:Image

the source Image.

Since
JavaFX 2.1
ImageInputback to summary
public ImageInput(Image source, double x, double y)

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

Parameters
source:Image

the source Image.

x:double

the x location of the source image

y:double

the y location of the source image

Since
JavaFX 2.1

Method Detail

checkChainContainsback to summary
pack-priv boolean checkChainContains(Effect e)

Implements abstract javafx.scene.effect.Effect.checkChainContains.

Annotations
@Override
copyback to summary
pack-priv Effect copy()

Implements abstract javafx.scene.effect.Effect.copy.

Annotations
@Override
createPeerback to summary
pack-priv Identity createPeer()

Implements abstract javafx.scene.effect.Effect.createPeer.

Annotations
@Override
getBoundsback to summary
pack-priv BaseBounds getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor)

Implements abstract javafx.scene.effect.Effect.getBounds.

Doc from javafx.scene.effect.Effect.getBounds.

Returns bounds of given node with applied effect. We *never* pass null in as a bounds. This method will NOT take a null bounds object. The returned value may be the same bounds object passed in, or it may be a new object.

Annotations
@Override
getSourceback to summary
public final Image getSource()
getXback to summary
public final double getX()
getYback to summary
public final double getY()
setSourceback to summary
public final void setSource(Image value)
setXback to summary
public final void setX(double value)
setYback to summary
public final void setY(double value)
sourcePropertyback to summary
public final ObjectProperty<Image> sourceProperty()
updateback to summary
pack-priv void update()

Implements abstract javafx.scene.effect.Effect.update.

Annotations
@Override
xPropertyback to summary
public final DoubleProperty xProperty()
yPropertyback to summary
public final DoubleProperty yProperty()