javafx.scene.effect

Class Blend

java.lang.Object

javafx.scene.effect.Effect

javafx.scene.effect.Blend

public class Blend
extends Effect

An effect that blends the two inputs together using one of the pre-defined BlendModes.

Example:

 Blend blend = new Blend();
 blend.setMode(BlendMode.COLOR_BURN);

 ColorInput colorInput = new ColorInput();
 colorInput.setPaint(Color.STEELBLUE);
 colorInput.setX(10);
 colorInput.setY(10);
 colorInput.setWidth(100);
 colorInput.setHeight(180);

 blend.setTopInput(colorInput);

 Rectangle rect = new Rectangle();
 rect.setWidth(220);
 rect.setHeight(100);
 Stop[] stops = new Stop[]{new Stop(0, Color.LIGHTSTEELBLUE), new Stop(1, Color.PALEGREEN)};
 LinearGradient lg = new LinearGradient(0, 0, 0.25, 0.25, true, CycleMethod.REFLECT, stops);
 rect.setFill(lg);

 Text text = new Text();
 text.setX(15);
 text.setY(65);
 text.setFill(Color.PALEVIOLETRED);
 text.setText("COLOR_BURN");
 text.setFont(Font.font(null, FontWeight.BOLD, 30));

 Group g = new Group();
 g.setEffect(blend);
 g.getChildren().addAll(rect, text);
 

The code above produces the following:

Since:

JavaFX 2.0

Constructor Summary

Constructors

Constructor and Description
Blend() Creates a new instance of Blend with default parameters.
Blend(BlendMode mode) Creates a new instance of Blend with the specified mode.
Blend(BlendMode mode, Effect bottomInput, Effect topInput) Creates a new instance of Blend with the specified mode and bottom and top inputs.

Method Summary

Modifier and Type	Method and Description
ObjectProperty<Effect>	bottomInputProperty()
Effect	getBottomInput()
BlendMode	getMode()
double	getOpacity()
Effect	getTopInput()
Effect	impl_copy() Deprecated. This is an internal API that is not intended for use and will be removed in the next version
BaseBounds	impl_getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor) Deprecated. This is an internal API that is not intended for use and will be removed in the next version
static Blend.Mode	impl_getToolkitMode(BlendMode mode) Deprecated. This is an internal API that is not intended for use and will be removed in the next version
ObjectProperty<BlendMode>	modeProperty()
DoubleProperty	opacityProperty()
void	setBottomInput(Effect value)
void	setMode(BlendMode value)
void	setOpacity(double value)
void	setTopInput(Effect value)
ObjectProperty<Effect>	topInputProperty()

Methods inherited from class javafx.scene.effect.Effect

impl_effectDirtyProperty, impl_getImpl, impl_isEffectDirty, impl_sync

Methods inherited from class java.lang.Object

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

Constructor Detail

Blend

public Blend()

Creates a new instance of Blend with default parameters.

Blend

public Blend(BlendMode mode)

Creates a new instance of Blend with the specified mode.

Parameters:

mode - the BlendMode used to blend the two inputs together

Since:

JavaFX 2.1

Blend

public Blend(BlendMode mode,
             Effect bottomInput,
             Effect topInput)

Creates a new instance of Blend with the specified mode and bottom and top inputs.

Parameters:

mode - the BlendMode used to blend the two inputs together

bottomInput - the bottom input for this Blend operation

topInput - the top input for this Blend operation

Since:

JavaFX 2.1

Method Detail

impl_getToolkitMode

@Deprecated
public static Blend.Mode impl_getToolkitMode(BlendMode mode)

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Used by Group to convert the FX BlendMode enum value into a Decora value.

setMode

public final void setMode(BlendMode value)

getMode

public final BlendMode getMode()

modeProperty

public final ObjectProperty<BlendMode> modeProperty()

setOpacity

public final void setOpacity(double value)

getOpacity

public final double getOpacity()

opacityProperty

public final DoubleProperty opacityProperty()

setBottomInput

public final void setBottomInput(Effect value)

getBottomInput

public final Effect getBottomInput()

bottomInputProperty

public final ObjectProperty<Effect> bottomInputProperty()

setTopInput

public final void setTopInput(Effect value)

getTopInput

public final Effect getTopInput()

topInputProperty

public final ObjectProperty<Effect> topInputProperty()

impl_getBounds

@Deprecated
public BaseBounds impl_getBounds(BaseBounds bounds,
                                             BaseTransform tx,
                                             Node node,
                                             BoundsAccessor boundsAccessor)

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Description copied from class: Effect

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.

Specified by:

impl_getBounds in class Effect

impl_copy

@Deprecated
public Effect impl_copy()

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Specified by:

impl_copy in class Effect