Reflection

java.lang.Object
- javafx.scene.effect.Effect
- - javafx.scene.effect.Reflection

public class Reflection
extends Effect

An effect that renders a reflected version of the input below the actual input content.

Note that the reflection of a Node with a Reflection effect installed will not respond to mouse events or the containment methods on the Node.

Example:


 Reflection reflection = new Reflection();
 reflection.setFraction(0.7);

 Text text = new Text();
 text.setX(10.0);
 text.setY(50.0);
 text.setCache(true);
 text.setText("Reflections on JavaFX...");
 text.setFill(Color.web("0x3b596d"));
 text.setFont(Font.font(null, FontWeight.BOLD, 40));
 text.setEffect(reflection);

The code above produces the following:

The visual effect of Reflection on text

Since:: JavaFX 2.0

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`DoubleProperty`	`bottomOpacity` The bottom opacity value, which is the opacity of the reflection at its bottom extreme.
`DoubleProperty`	`fraction` The fraction of the input that is visible in the reflection.
`<any>`	`input` The input for this `Effect`.
`DoubleProperty`	`topOffset` The top offset adjustment, which is the distance between the bottom of the input and the top of the reflection.
`DoubleProperty`	`topOpacity` The top opacity value, which is the opacity of the reflection at its top extreme.

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 DoubleProperty`	`bottomOpacity` The bottom opacity value, which is the opacity of the reflection at its bottom extreme.
`private DoubleProperty`	`fraction` The fraction of the input that is visible in the reflection.
`private <any>`	`input` The input for this `Effect`.
`private DoubleProperty`	`topOffset` The top offset adjustment, which is the distance between the bottom of the input and the top of the reflection.
`private DoubleProperty`	`topOpacity` The top opacity value, which is the opacity of the reflection at its top extreme.

Constructor Summary

Constructors
Constructor and Description
`Reflection()` Creates a new instance of Reflection with default parameters.
`Reflection(double topOffset, double fraction, double topOpacity, double bottomOpacity)` Creates a new instance of Reflection with the specified topOffset, fraction, topOpacity and bottomOpacity.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DoubleProperty`	`bottomOpacityProperty()` The bottom opacity value, which is the opacity of the reflection at its bottom extreme.
`(package private) boolean`	`checkChainContains(Effect e)`
`(package private) Effect`	`copy()`
`(package private) com.sun.scenario.effect.Reflection`	`createPeer()`
`DoubleProperty`	`fractionProperty()` The fraction of the input that is visible in the reflection.
`double`	`getBottomOpacity()` Gets the value of the property bottomOpacity.
`(package private) BaseBounds`	`getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor)` Returns bounds of given node with applied effect.
`private float`	`getClampedBottomOpacity()`
`private float`	`getClampedFraction()`
`private float`	`getClampedTopOpacity()`
`double`	`getFraction()` Gets the value of the property fraction.
`Effect`	`getInput()` Gets the value of the property input.
`double`	`getTopOffset()` Gets the value of the property topOffset.
`double`	`getTopOpacity()` Gets the value of the property topOpacity.
`<any>`	`inputProperty()` The input for this `Effect`.
`void`	`setBottomOpacity(double value)` Sets the value of the property bottomOpacity.
`void`	`setFraction(double value)` Sets the value of the property fraction.
`void`	`setInput(Effect value)` Sets the value of the property input.
`void`	`setTopOffset(double value)` Sets the value of the property topOffset.
`void`	`setTopOpacity(double value)` Sets the value of the property topOpacity.
`DoubleProperty`	`topOffsetProperty()` The top offset adjustment, which is the distance between the bottom of the input and the top of the reflection.
`DoubleProperty`	`topOpacityProperty()` The top opacity value, which is the opacity of the reflection at its top extreme.
`(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
  - input
```
public final <any> inputProperty
```
    The input for this Effect. 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:
    
    getInput(), setInput(Effect)
  - topOffset
```
public final DoubleProperty topOffsetProperty
```
    The top offset adjustment, which is the distance between the bottom of the input and the top of the reflection.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
    See Also:
    
    getTopOffset(), setTopOffset(double)
  - topOpacity
```
public final DoubleProperty topOpacityProperty
```
    The top opacity value, which is the opacity of the reflection at its top extreme.
```
       Min: 0.0
       Max: 1.0
   Default: 0.5
  Identity: 1.0
 
```
    See Also:
    
    getTopOpacity(), setTopOpacity(double)
  - bottomOpacity
```
public final DoubleProperty bottomOpacityProperty
```
    The bottom opacity value, which is the opacity of the reflection at its bottom extreme.
```
       Min: 0.0
       Max: 1.0
   Default: 0.0
  Identity: 1.0
 
```
    See Also:
    
    getBottomOpacity(), setBottomOpacity(double)
  - fraction
```
public final DoubleProperty fractionProperty
```
    The fraction of the input that is visible in the reflection. For example, a value of 0.5 means that only the bottom half of the input will be visible in the reflection.
```
       Min: 0.0
       Max: 1.0
   Default: 0.75
  Identity: 1.0
 
```
    See Also:
    
    getFraction(), setFraction(double)
- Field Detail
  - input
```
private <any> input
```
    The input for this Effect. 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.
  - topOffset
```
private DoubleProperty topOffset
```
    The top offset adjustment, which is the distance between the bottom of the input and the top of the reflection.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
  - topOpacity
```
private DoubleProperty topOpacity
```
    The top opacity value, which is the opacity of the reflection at its top extreme.
```
       Min: 0.0
       Max: 1.0
   Default: 0.5
  Identity: 1.0
 
```
  - bottomOpacity
```
private DoubleProperty bottomOpacity
```
    The bottom opacity value, which is the opacity of the reflection at its bottom extreme.
```
       Min: 0.0
       Max: 1.0
   Default: 0.0
  Identity: 1.0
 
```
  - fraction
```
private DoubleProperty fraction
```
    The fraction of the input that is visible in the reflection. For example, a value of 0.5 means that only the bottom half of the input will be visible in the reflection.
```
       Min: 0.0
       Max: 1.0
   Default: 0.75
  Identity: 1.0
 
```
- Constructor Detail
  - Reflection
```
public Reflection()
```
    Creates a new instance of Reflection with default parameters.
  - Reflection
```
public Reflection(double topOffset,
                  double fraction,
                  double topOpacity,
                  double bottomOpacity)
```
    Creates a new instance of Reflection with the specified topOffset, fraction, topOpacity and bottomOpacity.
    
    Parameters:
    
    topOffset - the distance between the bottom of the input and the top of the reflection
    
    fraction - the fraction of the input that is visible in the reflection
    
    topOpacity - the opacity of the reflection at its top extreme
    
    bottomOpacity - the opacity of the reflection at its bottom extreme
    
    Since:
    
    JavaFX 2.1
- Method Detail
  - createPeer
```
com.sun.scenario.effect.Reflection createPeer()
```
    Specified by:
    
    createPeer in class Effect
  - setInput
```
public final void setInput(Effect value)
```
    Sets the value of the property input.
  - getInput
```
public final Effect getInput()
```
    Gets the value of the property input.
  - inputProperty
```
public final <any> inputProperty()
```
    The input for this Effect. 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:
    
    getInput(), setInput(Effect)
  - checkChainContains
```
boolean checkChainContains(Effect e)
```
    Specified by:
    
    checkChainContains in class Effect
  - setTopOffset
```
public final void setTopOffset(double value)
```
    Sets the value of the property topOffset.
  - getTopOffset
```
public final double getTopOffset()
```
    Gets the value of the property topOffset.
  - topOffsetProperty
```
public final DoubleProperty topOffsetProperty()
```
    The top offset adjustment, which is the distance between the bottom of the input and the top of the reflection.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
    See Also:
    
    getTopOffset(), setTopOffset(double)
  - setTopOpacity
```
public final void setTopOpacity(double value)
```
    Sets the value of the property topOpacity.
  - getTopOpacity
```
public final double getTopOpacity()
```
    Gets the value of the property topOpacity.
  - topOpacityProperty
```
public final DoubleProperty topOpacityProperty()
```
    The top opacity value, which is the opacity of the reflection at its top extreme.
```
       Min: 0.0
       Max: 1.0
   Default: 0.5
  Identity: 1.0
 
```
    See Also:
    
    getTopOpacity(), setTopOpacity(double)
  - setBottomOpacity
```
public final void setBottomOpacity(double value)
```
    Sets the value of the property bottomOpacity.
  - getBottomOpacity
```
public final double getBottomOpacity()
```
    Gets the value of the property bottomOpacity.
  - bottomOpacityProperty
```
public final DoubleProperty bottomOpacityProperty()
```
    The bottom opacity value, which is the opacity of the reflection at its bottom extreme.
```
       Min: 0.0
       Max: 1.0
   Default: 0.0
  Identity: 1.0
 
```
    See Also:
    
    getBottomOpacity(), setBottomOpacity(double)
  - setFraction
```
public final void setFraction(double value)
```
    Sets the value of the property fraction.
  - getFraction
```
public final double getFraction()
```
    Gets the value of the property fraction.
  - fractionProperty
```
public final DoubleProperty fractionProperty()
```
    The fraction of the input that is visible in the reflection. For example, a value of 0.5 means that only the bottom half of the input will be visible in the reflection.
```
       Min: 0.0
       Max: 1.0
   Default: 0.75
  Identity: 1.0
 
```
    See Also:
    
    getFraction(), setFraction(double)
  - getClampedFraction
```
private float getClampedFraction()
```
  - getClampedBottomOpacity
```
private float getClampedBottomOpacity()
```
  - getClampedTopOpacity
```
private float getClampedTopOpacity()
```
  - 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 Reflection

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

input

topOffset

topOpacity

bottomOpacity

fraction

Field Detail

input

topOffset

topOpacity

bottomOpacity

fraction

Constructor Detail

Reflection

Reflection

Method Detail

createPeer

setInput

getInput

inputProperty

checkChainContains

setTopOffset

getTopOffset

topOffsetProperty

setTopOpacity

getTopOpacity

topOpacityProperty

setBottomOpacity

getBottomOpacity

bottomOpacityProperty

setFraction

getFraction

fractionProperty

getClampedFraction

getClampedBottomOpacity

getClampedTopOpacity

update

getBounds

copy