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:

The visual effect of blending color,
gradient and text

Since:: JavaFX 2.0

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`<any>`	`bottomInput` The bottom input for this `Blend` operation.
`<any>`	`mode` The `BlendMode` used to blend the two inputs together.
`DoubleProperty`	`opacity` The opacity value, which is modulated with the top input prior to blending.
`<any>`	`topInput` The top input for this `Blend` operation.

Nested Class Summary
- Nested classes/interfaces inherited from class javafx.scene.effect.Effect
  Effect.EffectInputChangeListener, Effect.EffectInputProperty

Field Summary

Fields
Modifier and Type	Field and Description
`private <any>`	`bottomInput` The bottom input for this `Blend` operation.
`private <any>`	`mode` The `BlendMode` used to blend the two inputs together.
`private DoubleProperty`	`opacity` The opacity value, which is modulated with the top input prior to blending.
`private <any>`	`topInput` The top input for this `Blend` operation.

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<any>`	`bottomInputProperty()` The bottom input for this `Blend` operation.
`(package private) boolean`	`checkChainContains(Effect e)`
`(package private) Effect`	`copy()`
`(package private) com.sun.scenario.effect.Blend`	`createPeer()`
`Effect`	`getBottomInput()` Gets the value of the property bottomInput.
`(package private) BaseBounds`	`getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor)` Returns bounds of given node with applied effect.
`BlendMode`	`getMode()` Gets the value of the property mode.
`double`	`getOpacity()` Gets the value of the property opacity.
`(package private) static Mode`	`getToolkitMode(BlendMode mode)` Used by Group to convert the FX BlendMode enum value into a Decora value.
`Effect`	`getTopInput()` Gets the value of the property topInput.
`<any>`	`modeProperty()` The `BlendMode` used to blend the two inputs together.
`DoubleProperty`	`opacityProperty()` The opacity value, which is modulated with the top input prior to blending.
`void`	`setBottomInput(Effect value)` Sets the value of the property bottomInput.
`void`	`setMode(BlendMode value)` Sets the value of the property mode.
`void`	`setOpacity(double value)` Sets the value of the property opacity.
`void`	`setTopInput(Effect value)` Sets the value of the property topInput.
`private static Mode`	`toPGMode(BlendMode mode)`
`<any>`	`topInputProperty()` The top input for this `Blend` operation.
`(package private) void`	`update()`

Methods inherited from class javafx.scene.effect.Effect
containsCycles, effectBoundsChanged, getInputBounds, getKernelSize, getPeer, getShadowBounds, markDirty, sync, transformBounds

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - mode
```
public final <any> modeProperty
```
    The BlendMode used to blend the two inputs together.
```
       Min: n/a
       Max: n/a
   Default: BlendMode.SRC_OVER
  Identity: n/a
 
```
    See Also:
    
    getMode(), setMode(BlendMode)
  - opacity
```
public final DoubleProperty opacityProperty
```
    The opacity value, which is modulated with the top input prior to blending.
```
       Min: 0.0
       Max: 1.0
   Default: 1.0
  Identity: 1.0
 
```
    See Also:
    
    getOpacity(), setOpacity(double)
  - bottomInput
```
public final <any> bottomInputProperty
```
    The bottom input for this Blend operation. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.
    
    See Also:
    
    getBottomInput(), setBottomInput(Effect)
  - topInput
```
public final <any> topInputProperty
```
    The top input for this Blend operation. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.
    
    See Also:
    
    getTopInput(), setTopInput(Effect)
- Field Detail
  - mode
```
private <any> mode
```
    The BlendMode used to blend the two inputs together.
```
       Min: n/a
       Max: n/a
   Default: BlendMode.SRC_OVER
  Identity: n/a
 
```
  - opacity
```
private DoubleProperty opacity
```
    The opacity value, which is modulated with the top input prior to blending.
```
       Min: 0.0
       Max: 1.0
   Default: 1.0
  Identity: 1.0
 
```
  - bottomInput
```
private <any> bottomInput
```
    The bottom input for this Blend operation. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.
  - topInput
```
private <any> topInput
```
    The top input for this Blend operation. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.
- 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
  - toPGMode
```
private static Mode toPGMode(BlendMode mode)
```
  - getToolkitMode
```
static Mode getToolkitMode(BlendMode mode)
```
    Used by Group to convert the FX BlendMode enum value into a Decora value.
  - createPeer
```
com.sun.scenario.effect.Blend createPeer()
```
    Specified by:
    
    createPeer in class Effect
  - setMode
```
public final void setMode(BlendMode value)
```
    Sets the value of the property mode.
  - getMode
```
public final BlendMode getMode()
```
    Gets the value of the property mode.
  - modeProperty
```
public final <any> modeProperty()
```
    The BlendMode used to blend the two inputs together.
```
       Min: n/a
       Max: n/a
   Default: BlendMode.SRC_OVER
  Identity: n/a
 
```
    See Also:
    
    getMode(), setMode(BlendMode)
  - setOpacity
```
public final void setOpacity(double value)
```
    Sets the value of the property opacity.
  - getOpacity
```
public final double getOpacity()
```
    Gets the value of the property opacity.
  - opacityProperty
```
public final DoubleProperty opacityProperty()
```
    The opacity value, which is modulated with the top input prior to blending.
```
       Min: 0.0
       Max: 1.0
   Default: 1.0
  Identity: 1.0
 
```
    See Also:
    
    getOpacity(), setOpacity(double)
  - setBottomInput
```
public final void setBottomInput(Effect value)
```
    Sets the value of the property bottomInput.
  - getBottomInput
```
public final Effect getBottomInput()
```
    Gets the value of the property bottomInput.
  - bottomInputProperty
```
public final <any> bottomInputProperty()
```
    The bottom input for this Blend operation. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.
    
    See Also:
    
    getBottomInput(), setBottomInput(Effect)
  - setTopInput
```
public final void setTopInput(Effect value)
```
    Sets the value of the property topInput.
  - getTopInput
```
public final Effect getTopInput()
```
    Gets the value of the property topInput.
  - topInputProperty
```
public final <any> topInputProperty()
```
    The top input for this Blend operation. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.
    
    See Also:
    
    getTopInput(), setTopInput(Effect)
  - checkChainContains
```
boolean checkChainContains(Effect e)
```
    Specified by:
    
    checkChainContains in class Effect
  - update
```
void update()
```
    Specified by:
    
    update in class Effect
  - getBounds
```
BaseBounds getBounds(BaseBounds bounds,
                     BaseTransform tx,
                     Node node,
                     BoundsAccessor boundsAccessor)
```
    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:
    
    getBounds in class Effect
  - copy
```
Effect copy()
```
    Specified by:
    
    copy in class Effect

Class Blend

Property Summary

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.effect.Effect

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.effect.Effect

Methods inherited from class java.lang.Object

Property Detail

mode

opacity

bottomInput

topInput

Field Detail

mode

opacity

bottomInput

topInput

Constructor Detail

Blend

Blend

Blend

Method Detail

toPGMode

getToolkitMode

createPeer

setMode

getMode

modeProperty

setOpacity

getOpacity

opacityProperty

setBottomInput

getBottomInput

bottomInputProperty

setTopInput

getTopInput

topInputProperty

checkChainContains

update

getBounds

copy