Class Reflection
java.lang.Object
javafx.scene.effect.Effect
javafx.scene.effect.Reflection
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:
- Since:
- JavaFX 2.0
-
Property Summary
TypePropertyDescriptionfinal DoubleProperty
The bottom opacity value, which is the opacity of the reflection at its bottom extreme.final DoubleProperty
The fraction of the input that is visible in the reflection.final ObjectProperty
<Effect> The input for thisEffect
.final DoubleProperty
The top offset adjustment, which is the distance between the bottom of the input and the top of the reflection.final DoubleProperty
The top opacity value, which is the opacity of the reflection at its top extreme. -
Constructor Summary
ConstructorDescriptionCreates 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
Modifier and TypeMethodDescriptionfinal DoubleProperty
The bottom opacity value, which is the opacity of the reflection at its bottom extreme.final DoubleProperty
The fraction of the input that is visible in the reflection.final double
Gets the value of thebottomOpacity
property.final double
Gets the value of thefraction
property.final Effect
getInput()
Gets the value of theinput
property.final double
Gets the value of thetopOffset
property.final double
Gets the value of thetopOpacity
property.final ObjectProperty
<Effect> The input for thisEffect
.final void
setBottomOpacity
(double value) Sets the value of thebottomOpacity
property.final void
setFraction
(double value) Sets the value of thefraction
property.final void
Sets the value of theinput
property.final void
setTopOffset
(double value) Sets the value of thetopOffset
property.final void
setTopOpacity
(double value) Sets the value of thetopOpacity
property.final DoubleProperty
The top offset adjustment, which is the distance between the bottom of the input and the top of the reflection.final DoubleProperty
The top opacity value, which is the opacity of the reflection at its top extreme.
-
Property Details
-
input
The input for thisEffect
. If set tonull
, or left unspecified, a graphical image of theNode
to which theEffect
is attached will be used as the input.- Default value:
- null
- See Also:
-
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
- Default value:
- 0.0
- See Also:
-
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
- Default value:
- 0.5
- See Also:
-
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
- Default value:
- 0.0
- See Also:
-
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
- Default value:
- 0.75
- See Also:
-
-
Constructor Details
-
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 reflectionfraction
- the fraction of the input that is visible in the reflectiontopOpacity
- the opacity of the reflection at its top extremebottomOpacity
- the opacity of the reflection at its bottom extreme- Since:
- JavaFX 2.1
-
-
Method Details
-
setInput
Sets the value of theinput
property.- Property description:
- The input for this
Effect
. If set tonull
, or left unspecified, a graphical image of theNode
to which theEffect
is attached will be used as the input. - Default value:
- null
- Parameters:
value
- the value for theinput
property- See Also:
-
getInput
Gets the value of theinput
property.- Property description:
- The input for this
Effect
. If set tonull
, or left unspecified, a graphical image of theNode
to which theEffect
is attached will be used as the input. - Default value:
- null
- Returns:
- the value of the
input
property - See Also:
-
inputProperty
The input for thisEffect
. If set tonull
, or left unspecified, a graphical image of theNode
to which theEffect
is attached will be used as the input.- Default value:
- null
- Returns:
- the
input
property - See Also:
-
setTopOffset
public final void setTopOffset(double value) Sets the value of thetopOffset
property.- Property description:
- 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
- Default value:
- 0.0
- Parameters:
value
- the value for thetopOffset
property- See Also:
-
getTopOffset
public final double getTopOffset()Gets the value of thetopOffset
property.- Property description:
- 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
- Default value:
- 0.0
- Returns:
- the value of the
topOffset
property - See Also:
-
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
- Default value:
- 0.0
- Returns:
- the
topOffset
property - See Also:
-
setTopOpacity
public final void setTopOpacity(double value) Sets the value of thetopOpacity
property.- Property description:
- 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
- Default value:
- 0.5
- Parameters:
value
- the value for thetopOpacity
property- See Also:
-
getTopOpacity
public final double getTopOpacity()Gets the value of thetopOpacity
property.- Property description:
- 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
- Default value:
- 0.5
- Returns:
- the value of the
topOpacity
property - See Also:
-
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
- Default value:
- 0.5
- Returns:
- the
topOpacity
property - See Also:
-
setBottomOpacity
public final void setBottomOpacity(double value) Sets the value of thebottomOpacity
property.- Property description:
- 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
- Default value:
- 0.0
- Parameters:
value
- the value for thebottomOpacity
property- See Also:
-
getBottomOpacity
public final double getBottomOpacity()Gets the value of thebottomOpacity
property.- Property description:
- 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
- Default value:
- 0.0
- Returns:
- the value of the
bottomOpacity
property - See Also:
-
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
- Default value:
- 0.0
- Returns:
- the
bottomOpacity
property - See Also:
-
setFraction
public final void setFraction(double value) Sets the value of thefraction
property.- Property description:
- 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
- Default value:
- 0.75
- Parameters:
value
- the value for thefraction
property- See Also:
-
getFraction
public final double getFraction()Gets the value of thefraction
property.- Property description:
- 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
- Default value:
- 0.75
- Returns:
- the value of the
fraction
property - See Also:
-
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
- Default value:
- 0.75
- Returns:
- the
fraction
property - See Also:
-